2 * QEMU System Emulator block driver
4 * Copyright (c) 2003 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 #include "config-host.h"
25 #include "qemu-common.h"
28 #include "block_int.h"
31 #include "qemu-coroutine.h"
32 #include "qmp-commands.h"
33 #include "qemu-timer.h"
36 #include <sys/types.h>
38 #include <sys/ioctl.h>
39 #include <sys/queue.h>
49 #define NOT_DONE 0x7fffffff /* used while emulated sync operation in progress */
52 BDRV_REQ_COPY_ON_READ
= 0x1,
53 BDRV_REQ_ZERO_WRITE
= 0x2,
56 static void bdrv_dev_change_media_cb(BlockDriverState
*bs
, bool load
);
57 static BlockDriverAIOCB
*bdrv_aio_readv_em(BlockDriverState
*bs
,
58 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
59 BlockDriverCompletionFunc
*cb
, void *opaque
);
60 static BlockDriverAIOCB
*bdrv_aio_writev_em(BlockDriverState
*bs
,
61 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
62 BlockDriverCompletionFunc
*cb
, void *opaque
);
63 static int coroutine_fn
bdrv_co_readv_em(BlockDriverState
*bs
,
64 int64_t sector_num
, int nb_sectors
,
66 static int coroutine_fn
bdrv_co_writev_em(BlockDriverState
*bs
,
67 int64_t sector_num
, int nb_sectors
,
69 static int coroutine_fn
bdrv_co_do_readv(BlockDriverState
*bs
,
70 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
,
71 BdrvRequestFlags flags
);
72 static int coroutine_fn
bdrv_co_do_writev(BlockDriverState
*bs
,
73 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
,
74 BdrvRequestFlags flags
);
75 static BlockDriverAIOCB
*bdrv_co_aio_rw_vector(BlockDriverState
*bs
,
79 BlockDriverCompletionFunc
*cb
,
82 static void coroutine_fn
bdrv_co_do_rw(void *opaque
);
84 static bool bdrv_exceed_bps_limits(BlockDriverState
*bs
, int nb_sectors
,
85 bool is_write
, double elapsed_time
, uint64_t *wait
);
86 static bool bdrv_exceed_iops_limits(BlockDriverState
*bs
, bool is_write
,
87 double elapsed_time
, uint64_t *wait
);
88 static bool bdrv_exceed_io_limits(BlockDriverState
*bs
, int nb_sectors
,
89 bool is_write
, int64_t *wait
);
91 static QTAILQ_HEAD(, BlockDriverState
) bdrv_states
=
92 QTAILQ_HEAD_INITIALIZER(bdrv_states
);
94 static QLIST_HEAD(, BlockDriver
) bdrv_drivers
=
95 QLIST_HEAD_INITIALIZER(bdrv_drivers
);
97 /* The device to use for VM snapshots */
98 static BlockDriverState
*bs_snapshots
;
100 /* If non-zero, use only whitelisted block drivers */
101 static int use_bdrv_whitelist
;
104 static int is_windows_drive_prefix(const char *filename
)
106 return (((filename
[0] >= 'a' && filename
[0] <= 'z') ||
107 (filename
[0] >= 'A' && filename
[0] <= 'Z')) &&
111 int is_windows_drive(const char *filename
)
113 if (is_windows_drive_prefix(filename
) &&
116 if (strstart(filename
, "\\\\.\\", NULL
) ||
117 strstart(filename
, "//./", NULL
))
123 /* throttling disk I/O limits */
124 void bdrv_io_limits_disable(BlockDriverState
*bs
)
126 bs
->io_limits_enabled
= false;
128 while (qemu_co_queue_next(&bs
->throttled_reqs
));
130 if (bs
->block_timer
) {
131 qemu_del_timer(bs
->block_timer
);
132 qemu_free_timer(bs
->block_timer
);
133 bs
->block_timer
= NULL
;
139 memset(&bs
->io_base
, 0, sizeof(bs
->io_base
));
142 static void bdrv_block_timer(void *opaque
)
144 BlockDriverState
*bs
= opaque
;
146 qemu_co_queue_next(&bs
->throttled_reqs
);
149 void bdrv_io_limits_enable(BlockDriverState
*bs
)
151 qemu_co_queue_init(&bs
->throttled_reqs
);
152 bs
->block_timer
= qemu_new_timer_ns(vm_clock
, bdrv_block_timer
, bs
);
153 bs
->slice_time
= 5 * BLOCK_IO_SLICE_TIME
;
154 bs
->slice_start
= qemu_get_clock_ns(vm_clock
);
155 bs
->slice_end
= bs
->slice_start
+ bs
->slice_time
;
156 memset(&bs
->io_base
, 0, sizeof(bs
->io_base
));
157 bs
->io_limits_enabled
= true;
160 bool bdrv_io_limits_enabled(BlockDriverState
*bs
)
162 BlockIOLimit
*io_limits
= &bs
->io_limits
;
163 return io_limits
->bps
[BLOCK_IO_LIMIT_READ
]
164 || io_limits
->bps
[BLOCK_IO_LIMIT_WRITE
]
165 || io_limits
->bps
[BLOCK_IO_LIMIT_TOTAL
]
166 || io_limits
->iops
[BLOCK_IO_LIMIT_READ
]
167 || io_limits
->iops
[BLOCK_IO_LIMIT_WRITE
]
168 || io_limits
->iops
[BLOCK_IO_LIMIT_TOTAL
];
171 static void bdrv_io_limits_intercept(BlockDriverState
*bs
,
172 bool is_write
, int nb_sectors
)
174 int64_t wait_time
= -1;
176 if (!qemu_co_queue_empty(&bs
->throttled_reqs
)) {
177 qemu_co_queue_wait(&bs
->throttled_reqs
);
180 /* In fact, we hope to keep each request's timing, in FIFO mode. The next
181 * throttled requests will not be dequeued until the current request is
182 * allowed to be serviced. So if the current request still exceeds the
183 * limits, it will be inserted to the head. All requests followed it will
184 * be still in throttled_reqs queue.
187 while (bdrv_exceed_io_limits(bs
, nb_sectors
, is_write
, &wait_time
)) {
188 qemu_mod_timer(bs
->block_timer
,
189 wait_time
+ qemu_get_clock_ns(vm_clock
));
190 qemu_co_queue_wait_insert_head(&bs
->throttled_reqs
);
193 qemu_co_queue_next(&bs
->throttled_reqs
);
196 /* check if the path starts with "<protocol>:" */
197 static int path_has_protocol(const char *path
)
200 if (is_windows_drive(path
) ||
201 is_windows_drive_prefix(path
)) {
206 return strchr(path
, ':') != NULL
;
209 int path_is_absolute(const char *path
)
213 /* specific case for names like: "\\.\d:" */
214 if (*path
== '/' || *path
== '\\')
217 p
= strchr(path
, ':');
223 return (*p
== '/' || *p
== '\\');
229 /* if filename is absolute, just copy it to dest. Otherwise, build a
230 path to it by considering it is relative to base_path. URL are
232 void path_combine(char *dest
, int dest_size
,
233 const char *base_path
,
234 const char *filename
)
241 if (path_is_absolute(filename
)) {
242 pstrcpy(dest
, dest_size
, filename
);
244 p
= strchr(base_path
, ':');
249 p1
= strrchr(base_path
, '/');
253 p2
= strrchr(base_path
, '\\');
265 if (len
> dest_size
- 1)
267 memcpy(dest
, base_path
, len
);
269 pstrcat(dest
, dest_size
, filename
);
273 void bdrv_register(BlockDriver
*bdrv
)
275 /* Block drivers without coroutine functions need emulation */
276 if (!bdrv
->bdrv_co_readv
) {
277 bdrv
->bdrv_co_readv
= bdrv_co_readv_em
;
278 bdrv
->bdrv_co_writev
= bdrv_co_writev_em
;
280 /* bdrv_co_readv_em()/brdv_co_writev_em() work in terms of aio, so if
281 * the block driver lacks aio we need to emulate that too.
283 if (!bdrv
->bdrv_aio_readv
) {
284 /* add AIO emulation layer */
285 bdrv
->bdrv_aio_readv
= bdrv_aio_readv_em
;
286 bdrv
->bdrv_aio_writev
= bdrv_aio_writev_em
;
290 QLIST_INSERT_HEAD(&bdrv_drivers
, bdrv
, list
);
293 /* create a new block device (by default it is empty) */
294 BlockDriverState
*bdrv_new(const char *device_name
)
296 BlockDriverState
*bs
;
298 bs
= g_malloc0(sizeof(BlockDriverState
));
299 pstrcpy(bs
->device_name
, sizeof(bs
->device_name
), device_name
);
300 if (device_name
[0] != '\0') {
301 QTAILQ_INSERT_TAIL(&bdrv_states
, bs
, list
);
303 bdrv_iostatus_disable(bs
);
307 BlockDriver
*bdrv_find_format(const char *format_name
)
310 QLIST_FOREACH(drv1
, &bdrv_drivers
, list
) {
311 if (!strcmp(drv1
->format_name
, format_name
)) {
318 static int bdrv_is_whitelisted(BlockDriver
*drv
)
320 static const char *whitelist
[] = {
321 CONFIG_BDRV_WHITELIST
326 return 1; /* no whitelist, anything goes */
328 for (p
= whitelist
; *p
; p
++) {
329 if (!strcmp(drv
->format_name
, *p
)) {
336 BlockDriver
*bdrv_find_whitelisted_format(const char *format_name
)
338 BlockDriver
*drv
= bdrv_find_format(format_name
);
339 return drv
&& bdrv_is_whitelisted(drv
) ? drv
: NULL
;
342 int bdrv_create(BlockDriver
*drv
, const char* filename
,
343 QEMUOptionParameter
*options
)
345 if (!drv
->bdrv_create
)
348 return drv
->bdrv_create(filename
, options
);
351 int bdrv_create_file(const char* filename
, QEMUOptionParameter
*options
)
355 drv
= bdrv_find_protocol(filename
);
360 return bdrv_create(drv
, filename
, options
);
364 void get_tmp_filename(char *filename
, int size
)
366 char temp_dir
[MAX_PATH
];
368 GetTempPath(MAX_PATH
, temp_dir
);
369 GetTempFileName(temp_dir
, "qem", 0, filename
);
372 void get_tmp_filename(char *filename
, int size
)
376 /* XXX: race condition possible */
377 tmpdir
= getenv("TMPDIR");
380 snprintf(filename
, size
, "%s/vl.XXXXXX", tmpdir
);
381 fd
= mkstemp(filename
);
387 * Detect host devices. By convention, /dev/cdrom[N] is always
388 * recognized as a host CDROM.
390 static BlockDriver
*find_hdev_driver(const char *filename
)
392 int score_max
= 0, score
;
393 BlockDriver
*drv
= NULL
, *d
;
395 QLIST_FOREACH(d
, &bdrv_drivers
, list
) {
396 if (d
->bdrv_probe_device
) {
397 score
= d
->bdrv_probe_device(filename
);
398 if (score
> score_max
) {
408 BlockDriver
*bdrv_find_protocol(const char *filename
)
415 /* TODO Drivers without bdrv_file_open must be specified explicitly */
418 * XXX(hch): we really should not let host device detection
419 * override an explicit protocol specification, but moving this
420 * later breaks access to device names with colons in them.
421 * Thanks to the brain-dead persistent naming schemes on udev-
422 * based Linux systems those actually are quite common.
424 drv1
= find_hdev_driver(filename
);
429 if (!path_has_protocol(filename
)) {
430 return bdrv_find_format("file");
432 p
= strchr(filename
, ':');
435 if (len
> sizeof(protocol
) - 1)
436 len
= sizeof(protocol
) - 1;
437 memcpy(protocol
, filename
, len
);
438 protocol
[len
] = '\0';
439 QLIST_FOREACH(drv1
, &bdrv_drivers
, list
) {
440 if (drv1
->protocol_name
&&
441 !strcmp(drv1
->protocol_name
, protocol
)) {
448 static int find_image_format(const char *filename
, BlockDriver
**pdrv
)
450 int ret
, score
, score_max
;
451 BlockDriver
*drv1
, *drv
;
453 BlockDriverState
*bs
;
455 ret
= bdrv_file_open(&bs
, filename
, 0);
461 /* Return the raw BlockDriver * to scsi-generic devices or empty drives */
462 if (bs
->sg
|| !bdrv_is_inserted(bs
)) {
464 drv
= bdrv_find_format("raw");
472 ret
= bdrv_pread(bs
, 0, buf
, sizeof(buf
));
481 QLIST_FOREACH(drv1
, &bdrv_drivers
, list
) {
482 if (drv1
->bdrv_probe
) {
483 score
= drv1
->bdrv_probe(buf
, ret
, filename
);
484 if (score
> score_max
) {
498 * Set the current 'total_sectors' value
500 static int refresh_total_sectors(BlockDriverState
*bs
, int64_t hint
)
502 BlockDriver
*drv
= bs
->drv
;
504 /* Do not attempt drv->bdrv_getlength() on scsi-generic devices */
508 /* query actual device if possible, otherwise just trust the hint */
509 if (drv
->bdrv_getlength
) {
510 int64_t length
= drv
->bdrv_getlength(bs
);
514 hint
= length
>> BDRV_SECTOR_BITS
;
517 bs
->total_sectors
= hint
;
522 * Set open flags for a given cache mode
524 * Return 0 on success, -1 if the cache mode was invalid.
526 int bdrv_parse_cache_flags(const char *mode
, int *flags
)
528 *flags
&= ~BDRV_O_CACHE_MASK
;
530 if (!strcmp(mode
, "off") || !strcmp(mode
, "none")) {
531 *flags
|= BDRV_O_NOCACHE
| BDRV_O_CACHE_WB
;
532 } else if (!strcmp(mode
, "directsync")) {
533 *flags
|= BDRV_O_NOCACHE
;
534 } else if (!strcmp(mode
, "writeback")) {
535 *flags
|= BDRV_O_CACHE_WB
;
536 } else if (!strcmp(mode
, "unsafe")) {
537 *flags
|= BDRV_O_CACHE_WB
;
538 *flags
|= BDRV_O_NO_FLUSH
;
539 } else if (!strcmp(mode
, "writethrough")) {
540 /* this is the default */
549 * The copy-on-read flag is actually a reference count so multiple users may
550 * use the feature without worrying about clobbering its previous state.
551 * Copy-on-read stays enabled until all users have called to disable it.
553 void bdrv_enable_copy_on_read(BlockDriverState
*bs
)
558 void bdrv_disable_copy_on_read(BlockDriverState
*bs
)
560 assert(bs
->copy_on_read
> 0);
565 * Common part for opening disk images and files
567 static int bdrv_open_common(BlockDriverState
*bs
, const char *filename
,
568 int flags
, BlockDriver
*drv
)
574 trace_bdrv_open_common(bs
, filename
, flags
, drv
->format_name
);
577 bs
->total_sectors
= 0;
581 bs
->open_flags
= flags
;
583 bs
->buffer_alignment
= 512;
585 assert(bs
->copy_on_read
== 0); /* bdrv_new() and bdrv_close() make it so */
586 if ((flags
& BDRV_O_RDWR
) && (flags
& BDRV_O_COPY_ON_READ
)) {
587 bdrv_enable_copy_on_read(bs
);
590 pstrcpy(bs
->filename
, sizeof(bs
->filename
), filename
);
591 bs
->backing_file
[0] = '\0';
593 if (use_bdrv_whitelist
&& !bdrv_is_whitelisted(drv
)) {
598 bs
->opaque
= g_malloc0(drv
->instance_size
);
600 bs
->enable_write_cache
= !!(flags
& BDRV_O_CACHE_WB
);
603 * Clear flags that are internal to the block layer before opening the
606 open_flags
= flags
& ~(BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
);
609 * Snapshots should be writable.
611 if (bs
->is_temporary
) {
612 open_flags
|= BDRV_O_RDWR
;
615 bs
->keep_read_only
= bs
->read_only
= !(open_flags
& BDRV_O_RDWR
);
617 /* Open the image, either directly or using a protocol */
618 if (drv
->bdrv_file_open
) {
619 ret
= drv
->bdrv_file_open(bs
, filename
, open_flags
);
621 ret
= bdrv_file_open(&bs
->file
, filename
, open_flags
);
623 ret
= drv
->bdrv_open(bs
, open_flags
);
631 ret
= refresh_total_sectors(bs
, bs
->total_sectors
);
637 if (bs
->is_temporary
) {
645 bdrv_delete(bs
->file
);
655 * Opens a file using a protocol (file, host_device, nbd, ...)
657 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
, int flags
)
659 BlockDriverState
*bs
;
663 drv
= bdrv_find_protocol(filename
);
669 ret
= bdrv_open_common(bs
, filename
, flags
, drv
);
680 * Opens a disk image (raw, qcow2, vmdk, ...)
682 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
,
686 char tmp_filename
[PATH_MAX
];
688 if (flags
& BDRV_O_SNAPSHOT
) {
689 BlockDriverState
*bs1
;
692 BlockDriver
*bdrv_qcow2
;
693 QEMUOptionParameter
*options
;
694 char backing_filename
[PATH_MAX
];
696 /* if snapshot, we create a temporary backing file and open it
697 instead of opening 'filename' directly */
699 /* if there is a backing file, use it */
701 ret
= bdrv_open(bs1
, filename
, 0, drv
);
706 total_size
= bdrv_getlength(bs1
) & BDRV_SECTOR_MASK
;
708 if (bs1
->drv
&& bs1
->drv
->protocol_name
)
713 get_tmp_filename(tmp_filename
, sizeof(tmp_filename
));
715 /* Real path is meaningless for protocols */
717 snprintf(backing_filename
, sizeof(backing_filename
),
719 else if (!realpath(filename
, backing_filename
))
722 bdrv_qcow2
= bdrv_find_format("qcow2");
723 options
= parse_option_parameters("", bdrv_qcow2
->create_options
, NULL
);
725 set_option_parameter_int(options
, BLOCK_OPT_SIZE
, total_size
);
726 set_option_parameter(options
, BLOCK_OPT_BACKING_FILE
, backing_filename
);
728 set_option_parameter(options
, BLOCK_OPT_BACKING_FMT
,
732 ret
= bdrv_create(bdrv_qcow2
, tmp_filename
, options
);
733 free_option_parameters(options
);
738 filename
= tmp_filename
;
740 bs
->is_temporary
= 1;
743 /* Find the right image format driver */
745 ret
= find_image_format(filename
, &drv
);
749 goto unlink_and_fail
;
753 ret
= bdrv_open_common(bs
, filename
, flags
, drv
);
755 goto unlink_and_fail
;
758 /* If there is a backing file, use it */
759 if ((flags
& BDRV_O_NO_BACKING
) == 0 && bs
->backing_file
[0] != '\0') {
760 char backing_filename
[PATH_MAX
];
762 BlockDriver
*back_drv
= NULL
;
764 bs
->backing_hd
= bdrv_new("");
766 if (path_has_protocol(bs
->backing_file
)) {
767 pstrcpy(backing_filename
, sizeof(backing_filename
),
770 path_combine(backing_filename
, sizeof(backing_filename
),
771 filename
, bs
->backing_file
);
774 if (bs
->backing_format
[0] != '\0') {
775 back_drv
= bdrv_find_format(bs
->backing_format
);
778 /* backing files always opened read-only */
780 flags
& ~(BDRV_O_RDWR
| BDRV_O_SNAPSHOT
| BDRV_O_NO_BACKING
);
782 ret
= bdrv_open(bs
->backing_hd
, backing_filename
, back_flags
, back_drv
);
787 if (bs
->is_temporary
) {
788 bs
->backing_hd
->keep_read_only
= !(flags
& BDRV_O_RDWR
);
790 /* base image inherits from "parent" */
791 bs
->backing_hd
->keep_read_only
= bs
->keep_read_only
;
795 if (!bdrv_key_required(bs
)) {
796 bdrv_dev_change_media_cb(bs
, true);
799 /* throttling disk I/O limits */
800 if (bs
->io_limits_enabled
) {
801 bdrv_io_limits_enable(bs
);
807 if (bs
->is_temporary
) {
813 void bdrv_close(BlockDriverState
*bs
)
816 if (bs
== bs_snapshots
) {
819 if (bs
->backing_hd
) {
820 bdrv_delete(bs
->backing_hd
);
821 bs
->backing_hd
= NULL
;
823 bs
->drv
->bdrv_close(bs
);
826 if (bs
->is_temporary
) {
827 unlink(bs
->filename
);
832 bs
->copy_on_read
= 0;
834 if (bs
->file
!= NULL
) {
835 bdrv_close(bs
->file
);
838 bdrv_dev_change_media_cb(bs
, false);
841 /*throttling disk I/O limits*/
842 if (bs
->io_limits_enabled
) {
843 bdrv_io_limits_disable(bs
);
847 void bdrv_close_all(void)
849 BlockDriverState
*bs
;
851 QTAILQ_FOREACH(bs
, &bdrv_states
, list
) {
857 * Wait for pending requests to complete across all BlockDriverStates
859 * This function does not flush data to disk, use bdrv_flush_all() for that
860 * after calling this function.
862 void bdrv_drain_all(void)
864 BlockDriverState
*bs
;
868 /* If requests are still pending there is a bug somewhere */
869 QTAILQ_FOREACH(bs
, &bdrv_states
, list
) {
870 assert(QLIST_EMPTY(&bs
->tracked_requests
));
871 assert(qemu_co_queue_empty(&bs
->throttled_reqs
));
875 /* make a BlockDriverState anonymous by removing from bdrv_state list.
876 Also, NULL terminate the device_name to prevent double remove */
877 void bdrv_make_anon(BlockDriverState
*bs
)
879 if (bs
->device_name
[0] != '\0') {
880 QTAILQ_REMOVE(&bdrv_states
, bs
, list
);
882 bs
->device_name
[0] = '\0';
885 void bdrv_delete(BlockDriverState
*bs
)
889 /* remove from list, if necessary */
893 if (bs
->file
!= NULL
) {
894 bdrv_delete(bs
->file
);
897 assert(bs
!= bs_snapshots
);
901 int bdrv_attach_dev(BlockDriverState
*bs
, void *dev
)
902 /* TODO change to DeviceState *dev when all users are qdevified */
908 bdrv_iostatus_reset(bs
);
912 /* TODO qdevified devices don't use this, remove when devices are qdevified */
913 void bdrv_attach_dev_nofail(BlockDriverState
*bs
, void *dev
)
915 if (bdrv_attach_dev(bs
, dev
) < 0) {
920 void bdrv_detach_dev(BlockDriverState
*bs
, void *dev
)
921 /* TODO change to DeviceState *dev when all users are qdevified */
923 assert(bs
->dev
== dev
);
926 bs
->dev_opaque
= NULL
;
927 bs
->buffer_alignment
= 512;
930 /* TODO change to return DeviceState * when all users are qdevified */
931 void *bdrv_get_attached_dev(BlockDriverState
*bs
)
936 void bdrv_set_dev_ops(BlockDriverState
*bs
, const BlockDevOps
*ops
,
940 bs
->dev_opaque
= opaque
;
941 if (bdrv_dev_has_removable_media(bs
) && bs
== bs_snapshots
) {
946 void bdrv_emit_qmp_error_event(const BlockDriverState
*bdrv
,
947 BlockQMPEventAction action
, int is_read
)
950 const char *action_str
;
953 case BDRV_ACTION_REPORT
:
954 action_str
= "report";
956 case BDRV_ACTION_IGNORE
:
957 action_str
= "ignore";
959 case BDRV_ACTION_STOP
:
966 data
= qobject_from_jsonf("{ 'device': %s, 'action': %s, 'operation': %s }",
969 is_read
? "read" : "write");
970 monitor_protocol_event(QEVENT_BLOCK_IO_ERROR
, data
);
972 qobject_decref(data
);
975 static void bdrv_emit_qmp_eject_event(BlockDriverState
*bs
, bool ejected
)
979 data
= qobject_from_jsonf("{ 'device': %s, 'tray-open': %i }",
980 bdrv_get_device_name(bs
), ejected
);
981 monitor_protocol_event(QEVENT_DEVICE_TRAY_MOVED
, data
);
983 qobject_decref(data
);
986 static void bdrv_dev_change_media_cb(BlockDriverState
*bs
, bool load
)
988 if (bs
->dev_ops
&& bs
->dev_ops
->change_media_cb
) {
989 bool tray_was_closed
= !bdrv_dev_is_tray_open(bs
);
990 bs
->dev_ops
->change_media_cb(bs
->dev_opaque
, load
);
991 if (tray_was_closed
) {
993 bdrv_emit_qmp_eject_event(bs
, true);
997 bdrv_emit_qmp_eject_event(bs
, false);
1002 bool bdrv_dev_has_removable_media(BlockDriverState
*bs
)
1004 return !bs
->dev
|| (bs
->dev_ops
&& bs
->dev_ops
->change_media_cb
);
1007 void bdrv_dev_eject_request(BlockDriverState
*bs
, bool force
)
1009 if (bs
->dev_ops
&& bs
->dev_ops
->eject_request_cb
) {
1010 bs
->dev_ops
->eject_request_cb(bs
->dev_opaque
, force
);
1014 bool bdrv_dev_is_tray_open(BlockDriverState
*bs
)
1016 if (bs
->dev_ops
&& bs
->dev_ops
->is_tray_open
) {
1017 return bs
->dev_ops
->is_tray_open(bs
->dev_opaque
);
1022 static void bdrv_dev_resize_cb(BlockDriverState
*bs
)
1024 if (bs
->dev_ops
&& bs
->dev_ops
->resize_cb
) {
1025 bs
->dev_ops
->resize_cb(bs
->dev_opaque
);
1029 bool bdrv_dev_is_medium_locked(BlockDriverState
*bs
)
1031 if (bs
->dev_ops
&& bs
->dev_ops
->is_medium_locked
) {
1032 return bs
->dev_ops
->is_medium_locked(bs
->dev_opaque
);
1038 * Run consistency checks on an image
1040 * Returns 0 if the check could be completed (it doesn't mean that the image is
1041 * free of errors) or -errno when an internal error occurred. The results of the
1042 * check are stored in res.
1044 int bdrv_check(BlockDriverState
*bs
, BdrvCheckResult
*res
)
1046 if (bs
->drv
->bdrv_check
== NULL
) {
1050 memset(res
, 0, sizeof(*res
));
1051 return bs
->drv
->bdrv_check(bs
, res
);
1054 #define COMMIT_BUF_SECTORS 2048
1056 /* commit COW file into the raw image */
1057 int bdrv_commit(BlockDriverState
*bs
)
1059 BlockDriver
*drv
= bs
->drv
;
1060 BlockDriver
*backing_drv
;
1061 int64_t sector
, total_sectors
;
1062 int n
, ro
, open_flags
;
1063 int ret
= 0, rw_ret
= 0;
1065 char filename
[1024];
1066 BlockDriverState
*bs_rw
, *bs_ro
;
1071 if (!bs
->backing_hd
) {
1075 if (bs
->backing_hd
->keep_read_only
) {
1079 if (bdrv_in_use(bs
) || bdrv_in_use(bs
->backing_hd
)) {
1083 backing_drv
= bs
->backing_hd
->drv
;
1084 ro
= bs
->backing_hd
->read_only
;
1085 strncpy(filename
, bs
->backing_hd
->filename
, sizeof(filename
));
1086 open_flags
= bs
->backing_hd
->open_flags
;
1090 bdrv_delete(bs
->backing_hd
);
1091 bs
->backing_hd
= NULL
;
1092 bs_rw
= bdrv_new("");
1093 rw_ret
= bdrv_open(bs_rw
, filename
, open_flags
| BDRV_O_RDWR
,
1097 /* try to re-open read-only */
1098 bs_ro
= bdrv_new("");
1099 ret
= bdrv_open(bs_ro
, filename
, open_flags
& ~BDRV_O_RDWR
,
1103 /* drive not functional anymore */
1107 bs
->backing_hd
= bs_ro
;
1110 bs
->backing_hd
= bs_rw
;
1113 total_sectors
= bdrv_getlength(bs
) >> BDRV_SECTOR_BITS
;
1114 buf
= g_malloc(COMMIT_BUF_SECTORS
* BDRV_SECTOR_SIZE
);
1116 for (sector
= 0; sector
< total_sectors
; sector
+= n
) {
1117 if (bdrv_is_allocated(bs
, sector
, COMMIT_BUF_SECTORS
, &n
)) {
1119 if (bdrv_read(bs
, sector
, buf
, n
) != 0) {
1124 if (bdrv_write(bs
->backing_hd
, sector
, buf
, n
) != 0) {
1131 if (drv
->bdrv_make_empty
) {
1132 ret
= drv
->bdrv_make_empty(bs
);
1137 * Make sure all data we wrote to the backing device is actually
1141 bdrv_flush(bs
->backing_hd
);
1148 bdrv_delete(bs
->backing_hd
);
1149 bs
->backing_hd
= NULL
;
1150 bs_ro
= bdrv_new("");
1151 ret
= bdrv_open(bs_ro
, filename
, open_flags
& ~BDRV_O_RDWR
,
1155 /* drive not functional anymore */
1159 bs
->backing_hd
= bs_ro
;
1160 bs
->backing_hd
->keep_read_only
= 0;
1166 void bdrv_commit_all(void)
1168 BlockDriverState
*bs
;
1170 QTAILQ_FOREACH(bs
, &bdrv_states
, list
) {
1175 struct BdrvTrackedRequest
{
1176 BlockDriverState
*bs
;
1180 QLIST_ENTRY(BdrvTrackedRequest
) list
;
1181 Coroutine
*co
; /* owner, used for deadlock detection */
1182 CoQueue wait_queue
; /* coroutines blocked on this request */
1186 * Remove an active request from the tracked requests list
1188 * This function should be called when a tracked request is completing.
1190 static void tracked_request_end(BdrvTrackedRequest
*req
)
1192 QLIST_REMOVE(req
, list
);
1193 qemu_co_queue_restart_all(&req
->wait_queue
);
1197 * Add an active request to the tracked requests list
1199 static void tracked_request_begin(BdrvTrackedRequest
*req
,
1200 BlockDriverState
*bs
,
1202 int nb_sectors
, bool is_write
)
1204 *req
= (BdrvTrackedRequest
){
1206 .sector_num
= sector_num
,
1207 .nb_sectors
= nb_sectors
,
1208 .is_write
= is_write
,
1209 .co
= qemu_coroutine_self(),
1212 qemu_co_queue_init(&req
->wait_queue
);
1214 QLIST_INSERT_HEAD(&bs
->tracked_requests
, req
, list
);
1218 * Round a region to cluster boundaries
1220 static void round_to_clusters(BlockDriverState
*bs
,
1221 int64_t sector_num
, int nb_sectors
,
1222 int64_t *cluster_sector_num
,
1223 int *cluster_nb_sectors
)
1225 BlockDriverInfo bdi
;
1227 if (bdrv_get_info(bs
, &bdi
) < 0 || bdi
.cluster_size
== 0) {
1228 *cluster_sector_num
= sector_num
;
1229 *cluster_nb_sectors
= nb_sectors
;
1231 int64_t c
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
1232 *cluster_sector_num
= QEMU_ALIGN_DOWN(sector_num
, c
);
1233 *cluster_nb_sectors
= QEMU_ALIGN_UP(sector_num
- *cluster_sector_num
+
1238 static bool tracked_request_overlaps(BdrvTrackedRequest
*req
,
1239 int64_t sector_num
, int nb_sectors
) {
1241 if (sector_num
>= req
->sector_num
+ req
->nb_sectors
) {
1245 if (req
->sector_num
>= sector_num
+ nb_sectors
) {
1251 static void coroutine_fn
wait_for_overlapping_requests(BlockDriverState
*bs
,
1252 int64_t sector_num
, int nb_sectors
)
1254 BdrvTrackedRequest
*req
;
1255 int64_t cluster_sector_num
;
1256 int cluster_nb_sectors
;
1259 /* If we touch the same cluster it counts as an overlap. This guarantees
1260 * that allocating writes will be serialized and not race with each other
1261 * for the same cluster. For example, in copy-on-read it ensures that the
1262 * CoR read and write operations are atomic and guest writes cannot
1263 * interleave between them.
1265 round_to_clusters(bs
, sector_num
, nb_sectors
,
1266 &cluster_sector_num
, &cluster_nb_sectors
);
1270 QLIST_FOREACH(req
, &bs
->tracked_requests
, list
) {
1271 if (tracked_request_overlaps(req
, cluster_sector_num
,
1272 cluster_nb_sectors
)) {
1273 /* Hitting this means there was a reentrant request, for
1274 * example, a block driver issuing nested requests. This must
1275 * never happen since it means deadlock.
1277 assert(qemu_coroutine_self() != req
->co
);
1279 qemu_co_queue_wait(&req
->wait_queue
);
1290 * -EINVAL - backing format specified, but no file
1291 * -ENOSPC - can't update the backing file because no space is left in the
1293 * -ENOTSUP - format driver doesn't support changing the backing file
1295 int bdrv_change_backing_file(BlockDriverState
*bs
,
1296 const char *backing_file
, const char *backing_fmt
)
1298 BlockDriver
*drv
= bs
->drv
;
1300 if (drv
->bdrv_change_backing_file
!= NULL
) {
1301 return drv
->bdrv_change_backing_file(bs
, backing_file
, backing_fmt
);
1307 static int bdrv_check_byte_request(BlockDriverState
*bs
, int64_t offset
,
1312 if (!bdrv_is_inserted(bs
))
1318 len
= bdrv_getlength(bs
);
1323 if ((offset
> len
) || (len
- offset
< size
))
1329 static int bdrv_check_request(BlockDriverState
*bs
, int64_t sector_num
,
1332 return bdrv_check_byte_request(bs
, sector_num
* BDRV_SECTOR_SIZE
,
1333 nb_sectors
* BDRV_SECTOR_SIZE
);
1336 typedef struct RwCo
{
1337 BlockDriverState
*bs
;
1345 static void coroutine_fn
bdrv_rw_co_entry(void *opaque
)
1347 RwCo
*rwco
= opaque
;
1349 if (!rwco
->is_write
) {
1350 rwco
->ret
= bdrv_co_do_readv(rwco
->bs
, rwco
->sector_num
,
1351 rwco
->nb_sectors
, rwco
->qiov
, 0);
1353 rwco
->ret
= bdrv_co_do_writev(rwco
->bs
, rwco
->sector_num
,
1354 rwco
->nb_sectors
, rwco
->qiov
, 0);
1359 * Process a synchronous request using coroutines
1361 static int bdrv_rw_co(BlockDriverState
*bs
, int64_t sector_num
, uint8_t *buf
,
1362 int nb_sectors
, bool is_write
)
1365 struct iovec iov
= {
1366 .iov_base
= (void *)buf
,
1367 .iov_len
= nb_sectors
* BDRV_SECTOR_SIZE
,
1372 .sector_num
= sector_num
,
1373 .nb_sectors
= nb_sectors
,
1375 .is_write
= is_write
,
1379 qemu_iovec_init_external(&qiov
, &iov
, 1);
1381 if (qemu_in_coroutine()) {
1382 /* Fast-path if already in coroutine context */
1383 bdrv_rw_co_entry(&rwco
);
1385 co
= qemu_coroutine_create(bdrv_rw_co_entry
);
1386 qemu_coroutine_enter(co
, &rwco
);
1387 while (rwco
.ret
== NOT_DONE
) {
1394 /* return < 0 if error. See bdrv_write() for the return codes */
1395 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
1396 uint8_t *buf
, int nb_sectors
)
1398 return bdrv_rw_co(bs
, sector_num
, buf
, nb_sectors
, false);
1401 static void set_dirty_bitmap(BlockDriverState
*bs
, int64_t sector_num
,
1402 int nb_sectors
, int dirty
)
1405 unsigned long val
, idx
, bit
;
1407 start
= sector_num
/ BDRV_SECTORS_PER_DIRTY_CHUNK
;
1408 end
= (sector_num
+ nb_sectors
- 1) / BDRV_SECTORS_PER_DIRTY_CHUNK
;
1410 for (; start
<= end
; start
++) {
1411 idx
= start
/ (sizeof(unsigned long) * 8);
1412 bit
= start
% (sizeof(unsigned long) * 8);
1413 val
= bs
->dirty_bitmap
[idx
];
1415 if (!(val
& (1UL << bit
))) {
1420 if (val
& (1UL << bit
)) {
1422 val
&= ~(1UL << bit
);
1425 bs
->dirty_bitmap
[idx
] = val
;
1429 /* Return < 0 if error. Important errors are:
1430 -EIO generic I/O error (may happen for all errors)
1431 -ENOMEDIUM No media inserted.
1432 -EINVAL Invalid sector number or nb_sectors
1433 -EACCES Trying to write a read-only device
1435 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
1436 const uint8_t *buf
, int nb_sectors
)
1438 return bdrv_rw_co(bs
, sector_num
, (uint8_t *)buf
, nb_sectors
, true);
1441 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
1442 void *buf
, int count1
)
1444 uint8_t tmp_buf
[BDRV_SECTOR_SIZE
];
1445 int len
, nb_sectors
, count
;
1450 /* first read to align to sector start */
1451 len
= (BDRV_SECTOR_SIZE
- offset
) & (BDRV_SECTOR_SIZE
- 1);
1454 sector_num
= offset
>> BDRV_SECTOR_BITS
;
1456 if ((ret
= bdrv_read(bs
, sector_num
, tmp_buf
, 1)) < 0)
1458 memcpy(buf
, tmp_buf
+ (offset
& (BDRV_SECTOR_SIZE
- 1)), len
);
1466 /* read the sectors "in place" */
1467 nb_sectors
= count
>> BDRV_SECTOR_BITS
;
1468 if (nb_sectors
> 0) {
1469 if ((ret
= bdrv_read(bs
, sector_num
, buf
, nb_sectors
)) < 0)
1471 sector_num
+= nb_sectors
;
1472 len
= nb_sectors
<< BDRV_SECTOR_BITS
;
1477 /* add data from the last sector */
1479 if ((ret
= bdrv_read(bs
, sector_num
, tmp_buf
, 1)) < 0)
1481 memcpy(buf
, tmp_buf
, count
);
1486 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
1487 const void *buf
, int count1
)
1489 uint8_t tmp_buf
[BDRV_SECTOR_SIZE
];
1490 int len
, nb_sectors
, count
;
1495 /* first write to align to sector start */
1496 len
= (BDRV_SECTOR_SIZE
- offset
) & (BDRV_SECTOR_SIZE
- 1);
1499 sector_num
= offset
>> BDRV_SECTOR_BITS
;
1501 if ((ret
= bdrv_read(bs
, sector_num
, tmp_buf
, 1)) < 0)
1503 memcpy(tmp_buf
+ (offset
& (BDRV_SECTOR_SIZE
- 1)), buf
, len
);
1504 if ((ret
= bdrv_write(bs
, sector_num
, tmp_buf
, 1)) < 0)
1513 /* write the sectors "in place" */
1514 nb_sectors
= count
>> BDRV_SECTOR_BITS
;
1515 if (nb_sectors
> 0) {
1516 if ((ret
= bdrv_write(bs
, sector_num
, buf
, nb_sectors
)) < 0)
1518 sector_num
+= nb_sectors
;
1519 len
= nb_sectors
<< BDRV_SECTOR_BITS
;
1524 /* add data from the last sector */
1526 if ((ret
= bdrv_read(bs
, sector_num
, tmp_buf
, 1)) < 0)
1528 memcpy(tmp_buf
, buf
, count
);
1529 if ((ret
= bdrv_write(bs
, sector_num
, tmp_buf
, 1)) < 0)
1536 * Writes to the file and ensures that no writes are reordered across this
1537 * request (acts as a barrier)
1539 * Returns 0 on success, -errno in error cases.
1541 int bdrv_pwrite_sync(BlockDriverState
*bs
, int64_t offset
,
1542 const void *buf
, int count
)
1546 ret
= bdrv_pwrite(bs
, offset
, buf
, count
);
1551 /* No flush needed for cache modes that use O_DSYNC */
1552 if ((bs
->open_flags
& BDRV_O_CACHE_WB
) != 0) {
1559 static int coroutine_fn
bdrv_co_do_copy_on_readv(BlockDriverState
*bs
,
1560 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
)
1562 /* Perform I/O through a temporary buffer so that users who scribble over
1563 * their read buffer while the operation is in progress do not end up
1564 * modifying the image file. This is critical for zero-copy guest I/O
1565 * where anything might happen inside guest memory.
1567 void *bounce_buffer
;
1569 BlockDriver
*drv
= bs
->drv
;
1571 QEMUIOVector bounce_qiov
;
1572 int64_t cluster_sector_num
;
1573 int cluster_nb_sectors
;
1577 /* Cover entire cluster so no additional backing file I/O is required when
1578 * allocating cluster in the image file.
1580 round_to_clusters(bs
, sector_num
, nb_sectors
,
1581 &cluster_sector_num
, &cluster_nb_sectors
);
1583 trace_bdrv_co_do_copy_on_readv(bs
, sector_num
, nb_sectors
,
1584 cluster_sector_num
, cluster_nb_sectors
);
1586 iov
.iov_len
= cluster_nb_sectors
* BDRV_SECTOR_SIZE
;
1587 iov
.iov_base
= bounce_buffer
= qemu_blockalign(bs
, iov
.iov_len
);
1588 qemu_iovec_init_external(&bounce_qiov
, &iov
, 1);
1590 ret
= drv
->bdrv_co_readv(bs
, cluster_sector_num
, cluster_nb_sectors
,
1596 if (drv
->bdrv_co_write_zeroes
&&
1597 buffer_is_zero(bounce_buffer
, iov
.iov_len
)) {
1598 ret
= drv
->bdrv_co_write_zeroes(bs
, cluster_sector_num
,
1599 cluster_nb_sectors
);
1601 ret
= drv
->bdrv_co_writev(bs
, cluster_sector_num
, cluster_nb_sectors
,
1606 /* It might be okay to ignore write errors for guest requests. If this
1607 * is a deliberate copy-on-read then we don't want to ignore the error.
1608 * Simply report it in all cases.
1613 skip_bytes
= (sector_num
- cluster_sector_num
) * BDRV_SECTOR_SIZE
;
1614 qemu_iovec_from_buffer(qiov
, bounce_buffer
+ skip_bytes
,
1615 nb_sectors
* BDRV_SECTOR_SIZE
);
1618 qemu_vfree(bounce_buffer
);
1623 * Handle a read request in coroutine context
1625 static int coroutine_fn
bdrv_co_do_readv(BlockDriverState
*bs
,
1626 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
,
1627 BdrvRequestFlags flags
)
1629 BlockDriver
*drv
= bs
->drv
;
1630 BdrvTrackedRequest req
;
1636 if (bdrv_check_request(bs
, sector_num
, nb_sectors
)) {
1640 /* throttling disk read I/O */
1641 if (bs
->io_limits_enabled
) {
1642 bdrv_io_limits_intercept(bs
, false, nb_sectors
);
1645 if (bs
->copy_on_read
) {
1646 flags
|= BDRV_REQ_COPY_ON_READ
;
1648 if (flags
& BDRV_REQ_COPY_ON_READ
) {
1649 bs
->copy_on_read_in_flight
++;
1652 if (bs
->copy_on_read_in_flight
) {
1653 wait_for_overlapping_requests(bs
, sector_num
, nb_sectors
);
1656 tracked_request_begin(&req
, bs
, sector_num
, nb_sectors
, false);
1658 if (flags
& BDRV_REQ_COPY_ON_READ
) {
1661 ret
= bdrv_co_is_allocated(bs
, sector_num
, nb_sectors
, &pnum
);
1666 if (!ret
|| pnum
!= nb_sectors
) {
1667 ret
= bdrv_co_do_copy_on_readv(bs
, sector_num
, nb_sectors
, qiov
);
1672 ret
= drv
->bdrv_co_readv(bs
, sector_num
, nb_sectors
, qiov
);
1675 tracked_request_end(&req
);
1677 if (flags
& BDRV_REQ_COPY_ON_READ
) {
1678 bs
->copy_on_read_in_flight
--;
1684 int coroutine_fn
bdrv_co_readv(BlockDriverState
*bs
, int64_t sector_num
,
1685 int nb_sectors
, QEMUIOVector
*qiov
)
1687 trace_bdrv_co_readv(bs
, sector_num
, nb_sectors
);
1689 return bdrv_co_do_readv(bs
, sector_num
, nb_sectors
, qiov
, 0);
1692 int coroutine_fn
bdrv_co_copy_on_readv(BlockDriverState
*bs
,
1693 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
)
1695 trace_bdrv_co_copy_on_readv(bs
, sector_num
, nb_sectors
);
1697 return bdrv_co_do_readv(bs
, sector_num
, nb_sectors
, qiov
,
1698 BDRV_REQ_COPY_ON_READ
);
1701 static int coroutine_fn
bdrv_co_do_write_zeroes(BlockDriverState
*bs
,
1702 int64_t sector_num
, int nb_sectors
)
1704 BlockDriver
*drv
= bs
->drv
;
1709 /* First try the efficient write zeroes operation */
1710 if (drv
->bdrv_co_write_zeroes
) {
1711 return drv
->bdrv_co_write_zeroes(bs
, sector_num
, nb_sectors
);
1714 /* Fall back to bounce buffer if write zeroes is unsupported */
1715 iov
.iov_len
= nb_sectors
* BDRV_SECTOR_SIZE
;
1716 iov
.iov_base
= qemu_blockalign(bs
, iov
.iov_len
);
1717 memset(iov
.iov_base
, 0, iov
.iov_len
);
1718 qemu_iovec_init_external(&qiov
, &iov
, 1);
1720 ret
= drv
->bdrv_co_writev(bs
, sector_num
, nb_sectors
, &qiov
);
1722 qemu_vfree(iov
.iov_base
);
1727 * Handle a write request in coroutine context
1729 static int coroutine_fn
bdrv_co_do_writev(BlockDriverState
*bs
,
1730 int64_t sector_num
, int nb_sectors
, QEMUIOVector
*qiov
,
1731 BdrvRequestFlags flags
)
1733 BlockDriver
*drv
= bs
->drv
;
1734 BdrvTrackedRequest req
;
1740 if (bs
->read_only
) {
1743 if (bdrv_check_request(bs
, sector_num
, nb_sectors
)) {
1747 /* throttling disk write I/O */
1748 if (bs
->io_limits_enabled
) {
1749 bdrv_io_limits_intercept(bs
, true, nb_sectors
);
1752 if (bs
->copy_on_read_in_flight
) {
1753 wait_for_overlapping_requests(bs
, sector_num
, nb_sectors
);
1756 tracked_request_begin(&req
, bs
, sector_num
, nb_sectors
, true);
1758 if (flags
& BDRV_REQ_ZERO_WRITE
) {
1759 ret
= bdrv_co_do_write_zeroes(bs
, sector_num
, nb_sectors
);
1761 ret
= drv
->bdrv_co_writev(bs
, sector_num
, nb_sectors
, qiov
);
1764 if (bs
->dirty_bitmap
) {
1765 set_dirty_bitmap(bs
, sector_num
, nb_sectors
, 1);
1768 if (bs
->wr_highest_sector
< sector_num
+ nb_sectors
- 1) {
1769 bs
->wr_highest_sector
= sector_num
+ nb_sectors
- 1;
1772 tracked_request_end(&req
);
1777 int coroutine_fn
bdrv_co_writev(BlockDriverState
*bs
, int64_t sector_num
,
1778 int nb_sectors
, QEMUIOVector
*qiov
)
1780 trace_bdrv_co_writev(bs
, sector_num
, nb_sectors
);
1782 return bdrv_co_do_writev(bs
, sector_num
, nb_sectors
, qiov
, 0);
1785 int coroutine_fn
bdrv_co_write_zeroes(BlockDriverState
*bs
,
1786 int64_t sector_num
, int nb_sectors
)
1788 trace_bdrv_co_write_zeroes(bs
, sector_num
, nb_sectors
);
1790 return bdrv_co_do_writev(bs
, sector_num
, nb_sectors
, NULL
,
1791 BDRV_REQ_ZERO_WRITE
);
1795 * Truncate file to 'offset' bytes (needed only for file protocols)
1797 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
)
1799 BlockDriver
*drv
= bs
->drv
;
1803 if (!drv
->bdrv_truncate
)
1807 if (bdrv_in_use(bs
))
1809 ret
= drv
->bdrv_truncate(bs
, offset
);
1811 ret
= refresh_total_sectors(bs
, offset
>> BDRV_SECTOR_BITS
);
1812 bdrv_dev_resize_cb(bs
);
1818 * Length of a allocated file in bytes. Sparse files are counted by actual
1819 * allocated space. Return < 0 if error or unknown.
1821 int64_t bdrv_get_allocated_file_size(BlockDriverState
*bs
)
1823 BlockDriver
*drv
= bs
->drv
;
1827 if (drv
->bdrv_get_allocated_file_size
) {
1828 return drv
->bdrv_get_allocated_file_size(bs
);
1831 return bdrv_get_allocated_file_size(bs
->file
);
1837 * Length of a file in bytes. Return < 0 if error or unknown.
1839 int64_t bdrv_getlength(BlockDriverState
*bs
)
1841 BlockDriver
*drv
= bs
->drv
;
1845 if (bs
->growable
|| bdrv_dev_has_removable_media(bs
)) {
1846 if (drv
->bdrv_getlength
) {
1847 return drv
->bdrv_getlength(bs
);
1850 return bs
->total_sectors
* BDRV_SECTOR_SIZE
;
1853 /* return 0 as number of sectors if no device present or error */
1854 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
)
1857 length
= bdrv_getlength(bs
);
1861 length
= length
>> BDRV_SECTOR_BITS
;
1862 *nb_sectors_ptr
= length
;
1866 uint8_t boot_ind
; /* 0x80 - active */
1867 uint8_t head
; /* starting head */
1868 uint8_t sector
; /* starting sector */
1869 uint8_t cyl
; /* starting cylinder */
1870 uint8_t sys_ind
; /* What partition type */
1871 uint8_t end_head
; /* end head */
1872 uint8_t end_sector
; /* end sector */
1873 uint8_t end_cyl
; /* end cylinder */
1874 uint32_t start_sect
; /* starting sector counting from 0 */
1875 uint32_t nr_sects
; /* nr of sectors in partition */
1878 /* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
1879 static int guess_disk_lchs(BlockDriverState
*bs
,
1880 int *pcylinders
, int *pheads
, int *psectors
)
1882 uint8_t buf
[BDRV_SECTOR_SIZE
];
1883 int ret
, i
, heads
, sectors
, cylinders
;
1884 struct partition
*p
;
1886 uint64_t nb_sectors
;
1888 bdrv_get_geometry(bs
, &nb_sectors
);
1890 ret
= bdrv_read(bs
, 0, buf
, 1);
1893 /* test msdos magic */
1894 if (buf
[510] != 0x55 || buf
[511] != 0xaa)
1896 for(i
= 0; i
< 4; i
++) {
1897 p
= ((struct partition
*)(buf
+ 0x1be)) + i
;
1898 nr_sects
= le32_to_cpu(p
->nr_sects
);
1899 if (nr_sects
&& p
->end_head
) {
1900 /* We make the assumption that the partition terminates on
1901 a cylinder boundary */
1902 heads
= p
->end_head
+ 1;
1903 sectors
= p
->end_sector
& 63;
1906 cylinders
= nb_sectors
/ (heads
* sectors
);
1907 if (cylinders
< 1 || cylinders
> 16383)
1910 *psectors
= sectors
;
1911 *pcylinders
= cylinders
;
1913 printf("guessed geometry: LCHS=%d %d %d\n",
1914 cylinders
, heads
, sectors
);
1922 void bdrv_guess_geometry(BlockDriverState
*bs
, int *pcyls
, int *pheads
, int *psecs
)
1924 int translation
, lba_detected
= 0;
1925 int cylinders
, heads
, secs
;
1926 uint64_t nb_sectors
;
1928 /* if a geometry hint is available, use it */
1929 bdrv_get_geometry(bs
, &nb_sectors
);
1930 bdrv_get_geometry_hint(bs
, &cylinders
, &heads
, &secs
);
1931 translation
= bdrv_get_translation_hint(bs
);
1932 if (cylinders
!= 0) {
1937 if (guess_disk_lchs(bs
, &cylinders
, &heads
, &secs
) == 0) {
1939 /* if heads > 16, it means that a BIOS LBA
1940 translation was active, so the default
1941 hardware geometry is OK */
1943 goto default_geometry
;
1948 /* disable any translation to be in sync with
1949 the logical geometry */
1950 if (translation
== BIOS_ATA_TRANSLATION_AUTO
) {
1951 bdrv_set_translation_hint(bs
,
1952 BIOS_ATA_TRANSLATION_NONE
);
1957 /* if no geometry, use a standard physical disk geometry */
1958 cylinders
= nb_sectors
/ (16 * 63);
1960 if (cylinders
> 16383)
1962 else if (cylinders
< 2)
1967 if ((lba_detected
== 1) && (translation
== BIOS_ATA_TRANSLATION_AUTO
)) {
1968 if ((*pcyls
* *pheads
) <= 131072) {
1969 bdrv_set_translation_hint(bs
,
1970 BIOS_ATA_TRANSLATION_LARGE
);
1972 bdrv_set_translation_hint(bs
,
1973 BIOS_ATA_TRANSLATION_LBA
);
1977 bdrv_set_geometry_hint(bs
, *pcyls
, *pheads
, *psecs
);
1981 void bdrv_set_geometry_hint(BlockDriverState
*bs
,
1982 int cyls
, int heads
, int secs
)
1989 void bdrv_set_translation_hint(BlockDriverState
*bs
, int translation
)
1991 bs
->translation
= translation
;
1994 void bdrv_get_geometry_hint(BlockDriverState
*bs
,
1995 int *pcyls
, int *pheads
, int *psecs
)
1998 *pheads
= bs
->heads
;
2002 /* throttling disk io limits */
2003 void bdrv_set_io_limits(BlockDriverState
*bs
,
2004 BlockIOLimit
*io_limits
)
2006 bs
->io_limits
= *io_limits
;
2007 bs
->io_limits_enabled
= bdrv_io_limits_enabled(bs
);
2010 /* Recognize floppy formats */
2011 typedef struct FDFormat
{
2019 static const FDFormat fd_formats
[] = {
2020 /* First entry is default format */
2021 /* 1.44 MB 3"1/2 floppy disks */
2022 { FDRIVE_DRV_144
, 18, 80, 1, FDRIVE_RATE_500K
, },
2023 { FDRIVE_DRV_144
, 20, 80, 1, FDRIVE_RATE_500K
, },
2024 { FDRIVE_DRV_144
, 21, 80, 1, FDRIVE_RATE_500K
, },
2025 { FDRIVE_DRV_144
, 21, 82, 1, FDRIVE_RATE_500K
, },
2026 { FDRIVE_DRV_144
, 21, 83, 1, FDRIVE_RATE_500K
, },
2027 { FDRIVE_DRV_144
, 22, 80, 1, FDRIVE_RATE_500K
, },
2028 { FDRIVE_DRV_144
, 23, 80, 1, FDRIVE_RATE_500K
, },
2029 { FDRIVE_DRV_144
, 24, 80, 1, FDRIVE_RATE_500K
, },
2030 /* 2.88 MB 3"1/2 floppy disks */
2031 { FDRIVE_DRV_288
, 36, 80, 1, FDRIVE_RATE_1M
, },
2032 { FDRIVE_DRV_288
, 39, 80, 1, FDRIVE_RATE_1M
, },
2033 { FDRIVE_DRV_288
, 40, 80, 1, FDRIVE_RATE_1M
, },
2034 { FDRIVE_DRV_288
, 44, 80, 1, FDRIVE_RATE_1M
, },
2035 { FDRIVE_DRV_288
, 48, 80, 1, FDRIVE_RATE_1M
, },
2036 /* 720 kB 3"1/2 floppy disks */
2037 { FDRIVE_DRV_144
, 9, 80, 1, FDRIVE_RATE_250K
, },
2038 { FDRIVE_DRV_144
, 10, 80, 1, FDRIVE_RATE_250K
, },
2039 { FDRIVE_DRV_144
, 10, 82, 1, FDRIVE_RATE_250K
, },
2040 { FDRIVE_DRV_144
, 10, 83, 1, FDRIVE_RATE_250K
, },
2041 { FDRIVE_DRV_144
, 13, 80, 1, FDRIVE_RATE_250K
, },
2042 { FDRIVE_DRV_144
, 14, 80, 1, FDRIVE_RATE_250K
, },
2043 /* 1.2 MB 5"1/4 floppy disks */
2044 { FDRIVE_DRV_120
, 15, 80, 1, FDRIVE_RATE_500K
, },
2045 { FDRIVE_DRV_120
, 18, 80, 1, FDRIVE_RATE_500K
, },
2046 { FDRIVE_DRV_120
, 18, 82, 1, FDRIVE_RATE_500K
, },
2047 { FDRIVE_DRV_120
, 18, 83, 1, FDRIVE_RATE_500K
, },
2048 { FDRIVE_DRV_120
, 20, 80, 1, FDRIVE_RATE_500K
, },
2049 /* 720 kB 5"1/4 floppy disks */
2050 { FDRIVE_DRV_120
, 9, 80, 1, FDRIVE_RATE_250K
, },
2051 { FDRIVE_DRV_120
, 11, 80, 1, FDRIVE_RATE_250K
, },
2052 /* 360 kB 5"1/4 floppy disks */
2053 { FDRIVE_DRV_120
, 9, 40, 1, FDRIVE_RATE_300K
, },
2054 { FDRIVE_DRV_120
, 9, 40, 0, FDRIVE_RATE_300K
, },
2055 { FDRIVE_DRV_120
, 10, 41, 1, FDRIVE_RATE_300K
, },
2056 { FDRIVE_DRV_120
, 10, 42, 1, FDRIVE_RATE_300K
, },
2057 /* 320 kB 5"1/4 floppy disks */
2058 { FDRIVE_DRV_120
, 8, 40, 1, FDRIVE_RATE_250K
, },
2059 { FDRIVE_DRV_120
, 8, 40, 0, FDRIVE_RATE_250K
, },
2060 /* 360 kB must match 5"1/4 better than 3"1/2... */
2061 { FDRIVE_DRV_144
, 9, 80, 0, FDRIVE_RATE_250K
, },
2063 { FDRIVE_DRV_NONE
, -1, -1, 0, 0, },
2066 void bdrv_get_floppy_geometry_hint(BlockDriverState
*bs
, int *nb_heads
,
2067 int *max_track
, int *last_sect
,
2068 FDriveType drive_in
, FDriveType
*drive
,
2071 const FDFormat
*parse
;
2072 uint64_t nb_sectors
, size
;
2073 int i
, first_match
, match
;
2075 bdrv_get_geometry_hint(bs
, nb_heads
, max_track
, last_sect
);
2076 if (*nb_heads
!= 0 && *max_track
!= 0 && *last_sect
!= 0) {
2077 /* User defined disk */
2078 *rate
= FDRIVE_RATE_500K
;
2080 bdrv_get_geometry(bs
, &nb_sectors
);
2083 for (i
= 0; ; i
++) {
2084 parse
= &fd_formats
[i
];
2085 if (parse
->drive
== FDRIVE_DRV_NONE
) {
2088 if (drive_in
== parse
->drive
||
2089 drive_in
== FDRIVE_DRV_NONE
) {
2090 size
= (parse
->max_head
+ 1) * parse
->max_track
*
2092 if (nb_sectors
== size
) {
2096 if (first_match
== -1) {
2102 if (first_match
== -1) {
2105 match
= first_match
;
2107 parse
= &fd_formats
[match
];
2109 *nb_heads
= parse
->max_head
+ 1;
2110 *max_track
= parse
->max_track
;
2111 *last_sect
= parse
->last_sect
;
2112 *drive
= parse
->drive
;
2113 *rate
= parse
->rate
;
2117 int bdrv_get_translation_hint(BlockDriverState
*bs
)
2119 return bs
->translation
;
2122 void bdrv_set_on_error(BlockDriverState
*bs
, BlockErrorAction on_read_error
,
2123 BlockErrorAction on_write_error
)
2125 bs
->on_read_error
= on_read_error
;
2126 bs
->on_write_error
= on_write_error
;
2129 BlockErrorAction
bdrv_get_on_error(BlockDriverState
*bs
, int is_read
)
2131 return is_read
? bs
->on_read_error
: bs
->on_write_error
;
2134 int bdrv_is_read_only(BlockDriverState
*bs
)
2136 return bs
->read_only
;
2139 int bdrv_is_sg(BlockDriverState
*bs
)
2144 int bdrv_enable_write_cache(BlockDriverState
*bs
)
2146 return bs
->enable_write_cache
;
2149 int bdrv_is_encrypted(BlockDriverState
*bs
)
2151 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
2153 return bs
->encrypted
;
2156 int bdrv_key_required(BlockDriverState
*bs
)
2158 BlockDriverState
*backing_hd
= bs
->backing_hd
;
2160 if (backing_hd
&& backing_hd
->encrypted
&& !backing_hd
->valid_key
)
2162 return (bs
->encrypted
&& !bs
->valid_key
);
2165 int bdrv_set_key(BlockDriverState
*bs
, const char *key
)
2168 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
) {
2169 ret
= bdrv_set_key(bs
->backing_hd
, key
);
2175 if (!bs
->encrypted
) {
2177 } else if (!bs
->drv
|| !bs
->drv
->bdrv_set_key
) {
2180 ret
= bs
->drv
->bdrv_set_key(bs
, key
);
2183 } else if (!bs
->valid_key
) {
2185 /* call the change callback now, we skipped it on open */
2186 bdrv_dev_change_media_cb(bs
, true);
2191 void bdrv_get_format(BlockDriverState
*bs
, char *buf
, int buf_size
)
2196 pstrcpy(buf
, buf_size
, bs
->drv
->format_name
);
2200 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
2205 QLIST_FOREACH(drv
, &bdrv_drivers
, list
) {
2206 it(opaque
, drv
->format_name
);
2210 BlockDriverState
*bdrv_find(const char *name
)
2212 BlockDriverState
*bs
;
2214 QTAILQ_FOREACH(bs
, &bdrv_states
, list
) {
2215 if (!strcmp(name
, bs
->device_name
)) {
2222 BlockDriverState
*bdrv_next(BlockDriverState
*bs
)
2225 return QTAILQ_FIRST(&bdrv_states
);
2227 return QTAILQ_NEXT(bs
, list
);
2230 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
), void *opaque
)
2232 BlockDriverState
*bs
;
2234 QTAILQ_FOREACH(bs
, &bdrv_states
, list
) {
2239 const char *bdrv_get_device_name(BlockDriverState
*bs
)
2241 return bs
->device_name
;
2244 void bdrv_flush_all(void)
2246 BlockDriverState
*bs
;
2248 QTAILQ_FOREACH(bs
, &bdrv_states
, list
) {
2249 if (!bdrv_is_read_only(bs
) && bdrv_is_inserted(bs
)) {
2255 int bdrv_has_zero_init(BlockDriverState
*bs
)
2259 if (bs
->drv
->bdrv_has_zero_init
) {
2260 return bs
->drv
->bdrv_has_zero_init(bs
);
2266 typedef struct BdrvCoIsAllocatedData
{
2267 BlockDriverState
*bs
;
2273 } BdrvCoIsAllocatedData
;
2276 * Returns true iff the specified sector is present in the disk image. Drivers
2277 * not implementing the functionality are assumed to not support backing files,
2278 * hence all their sectors are reported as allocated.
2280 * If 'sector_num' is beyond the end of the disk image the return value is 0
2281 * and 'pnum' is set to 0.
2283 * 'pnum' is set to the number of sectors (including and immediately following
2284 * the specified sector) that are known to be in the same
2285 * allocated/unallocated state.
2287 * 'nb_sectors' is the max value 'pnum' should be set to. If nb_sectors goes
2288 * beyond the end of the disk image it will be clamped.
2290 int coroutine_fn
bdrv_co_is_allocated(BlockDriverState
*bs
, int64_t sector_num
,
2291 int nb_sectors
, int *pnum
)
2295 if (sector_num
>= bs
->total_sectors
) {
2300 n
= bs
->total_sectors
- sector_num
;
2301 if (n
< nb_sectors
) {
2305 if (!bs
->drv
->bdrv_co_is_allocated
) {
2310 return bs
->drv
->bdrv_co_is_allocated(bs
, sector_num
, nb_sectors
, pnum
);
2313 /* Coroutine wrapper for bdrv_is_allocated() */
2314 static void coroutine_fn
bdrv_is_allocated_co_entry(void *opaque
)
2316 BdrvCoIsAllocatedData
*data
= opaque
;
2317 BlockDriverState
*bs
= data
->bs
;
2319 data
->ret
= bdrv_co_is_allocated(bs
, data
->sector_num
, data
->nb_sectors
,
2325 * Synchronous wrapper around bdrv_co_is_allocated().
2327 * See bdrv_co_is_allocated() for details.
2329 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
2333 BdrvCoIsAllocatedData data
= {
2335 .sector_num
= sector_num
,
2336 .nb_sectors
= nb_sectors
,
2341 co
= qemu_coroutine_create(bdrv_is_allocated_co_entry
);
2342 qemu_coroutine_enter(co
, &data
);
2343 while (!data
.done
) {
2349 BlockInfoList
*qmp_query_block(Error
**errp
)
2351 BlockInfoList
*head
= NULL
, *cur_item
= NULL
;
2352 BlockDriverState
*bs
;
2354 QTAILQ_FOREACH(bs
, &bdrv_states
, list
) {
2355 BlockInfoList
*info
= g_malloc0(sizeof(*info
));
2357 info
->value
= g_malloc0(sizeof(*info
->value
));
2358 info
->value
->device
= g_strdup(bs
->device_name
);
2359 info
->value
->type
= g_strdup("unknown");
2360 info
->value
->locked
= bdrv_dev_is_medium_locked(bs
);
2361 info
->value
->removable
= bdrv_dev_has_removable_media(bs
);
2363 if (bdrv_dev_has_removable_media(bs
)) {
2364 info
->value
->has_tray_open
= true;
2365 info
->value
->tray_open
= bdrv_dev_is_tray_open(bs
);
2368 if (bdrv_iostatus_is_enabled(bs
)) {
2369 info
->value
->has_io_status
= true;
2370 info
->value
->io_status
= bs
->iostatus
;
2374 info
->value
->has_inserted
= true;
2375 info
->value
->inserted
= g_malloc0(sizeof(*info
->value
->inserted
));
2376 info
->value
->inserted
->file
= g_strdup(bs
->filename
);
2377 info
->value
->inserted
->ro
= bs
->read_only
;
2378 info
->value
->inserted
->drv
= g_strdup(bs
->drv
->format_name
);
2379 info
->value
->inserted
->encrypted
= bs
->encrypted
;
2380 if (bs
->backing_file
[0]) {
2381 info
->value
->inserted
->has_backing_file
= true;
2382 info
->value
->inserted
->backing_file
= g_strdup(bs
->backing_file
);
2385 if (bs
->io_limits_enabled
) {
2386 info
->value
->inserted
->bps
=
2387 bs
->io_limits
.bps
[BLOCK_IO_LIMIT_TOTAL
];
2388 info
->value
->inserted
->bps_rd
=
2389 bs
->io_limits
.bps
[BLOCK_IO_LIMIT_READ
];
2390 info
->value
->inserted
->bps_wr
=
2391 bs
->io_limits
.bps
[BLOCK_IO_LIMIT_WRITE
];
2392 info
->value
->inserted
->iops
=
2393 bs
->io_limits
.iops
[BLOCK_IO_LIMIT_TOTAL
];
2394 info
->value
->inserted
->iops_rd
=
2395 bs
->io_limits
.iops
[BLOCK_IO_LIMIT_READ
];
2396 info
->value
->inserted
->iops_wr
=
2397 bs
->io_limits
.iops
[BLOCK_IO_LIMIT_WRITE
];
2401 /* XXX: waiting for the qapi to support GSList */
2403 head
= cur_item
= info
;
2405 cur_item
->next
= info
;
2413 /* Consider exposing this as a full fledged QMP command */
2414 static BlockStats
*qmp_query_blockstat(const BlockDriverState
*bs
, Error
**errp
)
2418 s
= g_malloc0(sizeof(*s
));
2420 if (bs
->device_name
[0]) {
2421 s
->has_device
= true;
2422 s
->device
= g_strdup(bs
->device_name
);
2425 s
->stats
= g_malloc0(sizeof(*s
->stats
));
2426 s
->stats
->rd_bytes
= bs
->nr_bytes
[BDRV_ACCT_READ
];
2427 s
->stats
->wr_bytes
= bs
->nr_bytes
[BDRV_ACCT_WRITE
];
2428 s
->stats
->rd_operations
= bs
->nr_ops
[BDRV_ACCT_READ
];
2429 s
->stats
->wr_operations
= bs
->nr_ops
[BDRV_ACCT_WRITE
];
2430 s
->stats
->wr_highest_offset
= bs
->wr_highest_sector
* BDRV_SECTOR_SIZE
;
2431 s
->stats
->flush_operations
= bs
->nr_ops
[BDRV_ACCT_FLUSH
];
2432 s
->stats
->wr_total_time_ns
= bs
->total_time_ns
[BDRV_ACCT_WRITE
];
2433 s
->stats
->rd_total_time_ns
= bs
->total_time_ns
[BDRV_ACCT_READ
];
2434 s
->stats
->flush_total_time_ns
= bs
->total_time_ns
[BDRV_ACCT_FLUSH
];
2437 s
->has_parent
= true;
2438 s
->parent
= qmp_query_blockstat(bs
->file
, NULL
);
2444 BlockStatsList
*qmp_query_blockstats(Error
**errp
)
2446 BlockStatsList
*head
= NULL
, *cur_item
= NULL
;
2447 BlockDriverState
*bs
;
2449 QTAILQ_FOREACH(bs
, &bdrv_states
, list
) {
2450 BlockStatsList
*info
= g_malloc0(sizeof(*info
));
2451 info
->value
= qmp_query_blockstat(bs
, NULL
);
2453 /* XXX: waiting for the qapi to support GSList */
2455 head
= cur_item
= info
;
2457 cur_item
->next
= info
;
2465 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
)
2467 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
2468 return bs
->backing_file
;
2469 else if (bs
->encrypted
)
2470 return bs
->filename
;
2475 void bdrv_get_backing_filename(BlockDriverState
*bs
,
2476 char *filename
, int filename_size
)
2478 pstrcpy(filename
, filename_size
, bs
->backing_file
);
2481 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
2482 const uint8_t *buf
, int nb_sectors
)
2484 BlockDriver
*drv
= bs
->drv
;
2487 if (!drv
->bdrv_write_compressed
)
2489 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
2492 if (bs
->dirty_bitmap
) {
2493 set_dirty_bitmap(bs
, sector_num
, nb_sectors
, 1);
2496 return drv
->bdrv_write_compressed(bs
, sector_num
, buf
, nb_sectors
);
2499 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
2501 BlockDriver
*drv
= bs
->drv
;
2504 if (!drv
->bdrv_get_info
)
2506 memset(bdi
, 0, sizeof(*bdi
));
2507 return drv
->bdrv_get_info(bs
, bdi
);
2510 int bdrv_save_vmstate(BlockDriverState
*bs
, const uint8_t *buf
,
2511 int64_t pos
, int size
)
2513 BlockDriver
*drv
= bs
->drv
;
2516 if (drv
->bdrv_save_vmstate
)
2517 return drv
->bdrv_save_vmstate(bs
, buf
, pos
, size
);
2519 return bdrv_save_vmstate(bs
->file
, buf
, pos
, size
);
2523 int bdrv_load_vmstate(BlockDriverState
*bs
, uint8_t *buf
,
2524 int64_t pos
, int size
)
2526 BlockDriver
*drv
= bs
->drv
;
2529 if (drv
->bdrv_load_vmstate
)
2530 return drv
->bdrv_load_vmstate(bs
, buf
, pos
, size
);
2532 return bdrv_load_vmstate(bs
->file
, buf
, pos
, size
);
2536 void bdrv_debug_event(BlockDriverState
*bs
, BlkDebugEvent event
)
2538 BlockDriver
*drv
= bs
->drv
;
2540 if (!drv
|| !drv
->bdrv_debug_event
) {
2544 return drv
->bdrv_debug_event(bs
, event
);
2548 /**************************************************************/
2549 /* handling of snapshots */
2551 int bdrv_can_snapshot(BlockDriverState
*bs
)
2553 BlockDriver
*drv
= bs
->drv
;
2554 if (!drv
|| !bdrv_is_inserted(bs
) || bdrv_is_read_only(bs
)) {
2558 if (!drv
->bdrv_snapshot_create
) {
2559 if (bs
->file
!= NULL
) {
2560 return bdrv_can_snapshot(bs
->file
);
2568 int bdrv_is_snapshot(BlockDriverState
*bs
)
2570 return !!(bs
->open_flags
& BDRV_O_SNAPSHOT
);
2573 BlockDriverState
*bdrv_snapshots(void)
2575 BlockDriverState
*bs
;
2578 return bs_snapshots
;
2582 while ((bs
= bdrv_next(bs
))) {
2583 if (bdrv_can_snapshot(bs
)) {
2591 int bdrv_snapshot_create(BlockDriverState
*bs
,
2592 QEMUSnapshotInfo
*sn_info
)
2594 BlockDriver
*drv
= bs
->drv
;
2597 if (drv
->bdrv_snapshot_create
)
2598 return drv
->bdrv_snapshot_create(bs
, sn_info
);
2600 return bdrv_snapshot_create(bs
->file
, sn_info
);
2604 int bdrv_snapshot_goto(BlockDriverState
*bs
,
2605 const char *snapshot_id
)
2607 BlockDriver
*drv
= bs
->drv
;
2612 if (drv
->bdrv_snapshot_goto
)
2613 return drv
->bdrv_snapshot_goto(bs
, snapshot_id
);
2616 drv
->bdrv_close(bs
);
2617 ret
= bdrv_snapshot_goto(bs
->file
, snapshot_id
);
2618 open_ret
= drv
->bdrv_open(bs
, bs
->open_flags
);
2620 bdrv_delete(bs
->file
);
2630 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
)
2632 BlockDriver
*drv
= bs
->drv
;
2635 if (drv
->bdrv_snapshot_delete
)
2636 return drv
->bdrv_snapshot_delete(bs
, snapshot_id
);
2638 return bdrv_snapshot_delete(bs
->file
, snapshot_id
);
2642 int bdrv_snapshot_list(BlockDriverState
*bs
,
2643 QEMUSnapshotInfo
**psn_info
)
2645 BlockDriver
*drv
= bs
->drv
;
2648 if (drv
->bdrv_snapshot_list
)
2649 return drv
->bdrv_snapshot_list(bs
, psn_info
);
2651 return bdrv_snapshot_list(bs
->file
, psn_info
);
2655 int bdrv_snapshot_load_tmp(BlockDriverState
*bs
,
2656 const char *snapshot_name
)
2658 BlockDriver
*drv
= bs
->drv
;
2662 if (!bs
->read_only
) {
2665 if (drv
->bdrv_snapshot_load_tmp
) {
2666 return drv
->bdrv_snapshot_load_tmp(bs
, snapshot_name
);
2671 BlockDriverState
*bdrv_find_backing_image(BlockDriverState
*bs
,
2672 const char *backing_file
)
2678 if (bs
->backing_hd
) {
2679 if (strcmp(bs
->backing_file
, backing_file
) == 0) {
2680 return bs
->backing_hd
;
2682 return bdrv_find_backing_image(bs
->backing_hd
, backing_file
);
2689 #define NB_SUFFIXES 4
2691 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
)
2693 static const char suffixes
[NB_SUFFIXES
] = "KMGT";
2698 snprintf(buf
, buf_size
, "%" PRId64
, size
);
2701 for(i
= 0; i
< NB_SUFFIXES
; i
++) {
2702 if (size
< (10 * base
)) {
2703 snprintf(buf
, buf_size
, "%0.1f%c",
2704 (double)size
/ base
,
2707 } else if (size
< (1000 * base
) || i
== (NB_SUFFIXES
- 1)) {
2708 snprintf(buf
, buf_size
, "%" PRId64
"%c",
2709 ((size
+ (base
>> 1)) / base
),
2719 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
)
2721 char buf1
[128], date_buf
[128], clock_buf
[128];
2731 snprintf(buf
, buf_size
,
2732 "%-10s%-20s%7s%20s%15s",
2733 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
2737 ptm
= localtime(&ti
);
2738 strftime(date_buf
, sizeof(date_buf
),
2739 "%Y-%m-%d %H:%M:%S", ptm
);
2741 localtime_r(&ti
, &tm
);
2742 strftime(date_buf
, sizeof(date_buf
),
2743 "%Y-%m-%d %H:%M:%S", &tm
);
2745 secs
= sn
->vm_clock_nsec
/ 1000000000;
2746 snprintf(clock_buf
, sizeof(clock_buf
),
2747 "%02d:%02d:%02d.%03d",
2749 (int)((secs
/ 60) % 60),
2751 (int)((sn
->vm_clock_nsec
/ 1000000) % 1000));
2752 snprintf(buf
, buf_size
,
2753 "%-10s%-20s%7s%20s%15s",
2754 sn
->id_str
, sn
->name
,
2755 get_human_readable_size(buf1
, sizeof(buf1
), sn
->vm_state_size
),
2762 /**************************************************************/
2765 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
2766 QEMUIOVector
*qiov
, int nb_sectors
,
2767 BlockDriverCompletionFunc
*cb
, void *opaque
)
2769 trace_bdrv_aio_readv(bs
, sector_num
, nb_sectors
, opaque
);
2771 return bdrv_co_aio_rw_vector(bs
, sector_num
, qiov
, nb_sectors
,
2775 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
2776 QEMUIOVector
*qiov
, int nb_sectors
,
2777 BlockDriverCompletionFunc
*cb
, void *opaque
)
2779 trace_bdrv_aio_writev(bs
, sector_num
, nb_sectors
, opaque
);
2781 return bdrv_co_aio_rw_vector(bs
, sector_num
, qiov
, nb_sectors
,
2786 typedef struct MultiwriteCB
{
2791 BlockDriverCompletionFunc
*cb
;
2793 QEMUIOVector
*free_qiov
;
2798 static void multiwrite_user_cb(MultiwriteCB
*mcb
)
2802 for (i
= 0; i
< mcb
->num_callbacks
; i
++) {
2803 mcb
->callbacks
[i
].cb(mcb
->callbacks
[i
].opaque
, mcb
->error
);
2804 if (mcb
->callbacks
[i
].free_qiov
) {
2805 qemu_iovec_destroy(mcb
->callbacks
[i
].free_qiov
);
2807 g_free(mcb
->callbacks
[i
].free_qiov
);
2808 qemu_vfree(mcb
->callbacks
[i
].free_buf
);
2812 static void multiwrite_cb(void *opaque
, int ret
)
2814 MultiwriteCB
*mcb
= opaque
;
2816 trace_multiwrite_cb(mcb
, ret
);
2818 if (ret
< 0 && !mcb
->error
) {
2822 mcb
->num_requests
--;
2823 if (mcb
->num_requests
== 0) {
2824 multiwrite_user_cb(mcb
);
2829 static int multiwrite_req_compare(const void *a
, const void *b
)
2831 const BlockRequest
*req1
= a
, *req2
= b
;
2834 * Note that we can't simply subtract req2->sector from req1->sector
2835 * here as that could overflow the return value.
2837 if (req1
->sector
> req2
->sector
) {
2839 } else if (req1
->sector
< req2
->sector
) {
2847 * Takes a bunch of requests and tries to merge them. Returns the number of
2848 * requests that remain after merging.
2850 static int multiwrite_merge(BlockDriverState
*bs
, BlockRequest
*reqs
,
2851 int num_reqs
, MultiwriteCB
*mcb
)
2855 // Sort requests by start sector
2856 qsort(reqs
, num_reqs
, sizeof(*reqs
), &multiwrite_req_compare
);
2858 // Check if adjacent requests touch the same clusters. If so, combine them,
2859 // filling up gaps with zero sectors.
2861 for (i
= 1; i
< num_reqs
; i
++) {
2863 int64_t oldreq_last
= reqs
[outidx
].sector
+ reqs
[outidx
].nb_sectors
;
2865 // This handles the cases that are valid for all block drivers, namely
2866 // exactly sequential writes and overlapping writes.
2867 if (reqs
[i
].sector
<= oldreq_last
) {
2871 // The block driver may decide that it makes sense to combine requests
2872 // even if there is a gap of some sectors between them. In this case,
2873 // the gap is filled with zeros (therefore only applicable for yet
2874 // unused space in format like qcow2).
2875 if (!merge
&& bs
->drv
->bdrv_merge_requests
) {
2876 merge
= bs
->drv
->bdrv_merge_requests(bs
, &reqs
[outidx
], &reqs
[i
]);
2879 if (reqs
[outidx
].qiov
->niov
+ reqs
[i
].qiov
->niov
+ 1 > IOV_MAX
) {
2885 QEMUIOVector
*qiov
= g_malloc0(sizeof(*qiov
));
2886 qemu_iovec_init(qiov
,
2887 reqs
[outidx
].qiov
->niov
+ reqs
[i
].qiov
->niov
+ 1);
2889 // Add the first request to the merged one. If the requests are
2890 // overlapping, drop the last sectors of the first request.
2891 size
= (reqs
[i
].sector
- reqs
[outidx
].sector
) << 9;
2892 qemu_iovec_concat(qiov
, reqs
[outidx
].qiov
, size
);
2894 // We might need to add some zeros between the two requests
2895 if (reqs
[i
].sector
> oldreq_last
) {
2896 size_t zero_bytes
= (reqs
[i
].sector
- oldreq_last
) << 9;
2897 uint8_t *buf
= qemu_blockalign(bs
, zero_bytes
);
2898 memset(buf
, 0, zero_bytes
);
2899 qemu_iovec_add(qiov
, buf
, zero_bytes
);
2900 mcb
->callbacks
[i
].free_buf
= buf
;
2903 // Add the second request
2904 qemu_iovec_concat(qiov
, reqs
[i
].qiov
, reqs
[i
].qiov
->size
);
2906 reqs
[outidx
].nb_sectors
= qiov
->size
>> 9;
2907 reqs
[outidx
].qiov
= qiov
;
2909 mcb
->callbacks
[i
].free_qiov
= reqs
[outidx
].qiov
;
2912 reqs
[outidx
].sector
= reqs
[i
].sector
;
2913 reqs
[outidx
].nb_sectors
= reqs
[i
].nb_sectors
;
2914 reqs
[outidx
].qiov
= reqs
[i
].qiov
;
2922 * Submit multiple AIO write requests at once.
2924 * On success, the function returns 0 and all requests in the reqs array have
2925 * been submitted. In error case this function returns -1, and any of the
2926 * requests may or may not be submitted yet. In particular, this means that the
2927 * callback will be called for some of the requests, for others it won't. The
2928 * caller must check the error field of the BlockRequest to wait for the right
2929 * callbacks (if error != 0, no callback will be called).
2931 * The implementation may modify the contents of the reqs array, e.g. to merge
2932 * requests. However, the fields opaque and error are left unmodified as they
2933 * are used to signal failure for a single request to the caller.
2935 int bdrv_aio_multiwrite(BlockDriverState
*bs
, BlockRequest
*reqs
, int num_reqs
)
2940 /* don't submit writes if we don't have a medium */
2941 if (bs
->drv
== NULL
) {
2942 for (i
= 0; i
< num_reqs
; i
++) {
2943 reqs
[i
].error
= -ENOMEDIUM
;
2948 if (num_reqs
== 0) {
2952 // Create MultiwriteCB structure
2953 mcb
= g_malloc0(sizeof(*mcb
) + num_reqs
* sizeof(*mcb
->callbacks
));
2954 mcb
->num_requests
= 0;
2955 mcb
->num_callbacks
= num_reqs
;
2957 for (i
= 0; i
< num_reqs
; i
++) {
2958 mcb
->callbacks
[i
].cb
= reqs
[i
].cb
;
2959 mcb
->callbacks
[i
].opaque
= reqs
[i
].opaque
;
2962 // Check for mergable requests
2963 num_reqs
= multiwrite_merge(bs
, reqs
, num_reqs
, mcb
);
2965 trace_bdrv_aio_multiwrite(mcb
, mcb
->num_callbacks
, num_reqs
);
2967 /* Run the aio requests. */
2968 mcb
->num_requests
= num_reqs
;
2969 for (i
= 0; i
< num_reqs
; i
++) {
2970 bdrv_aio_writev(bs
, reqs
[i
].sector
, reqs
[i
].qiov
,
2971 reqs
[i
].nb_sectors
, multiwrite_cb
, mcb
);
2977 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
)
2979 acb
->pool
->cancel(acb
);
2982 /* block I/O throttling */
2983 static bool bdrv_exceed_bps_limits(BlockDriverState
*bs
, int nb_sectors
,
2984 bool is_write
, double elapsed_time
, uint64_t *wait
)
2986 uint64_t bps_limit
= 0;
2987 double bytes_limit
, bytes_base
, bytes_res
;
2988 double slice_time
, wait_time
;
2990 if (bs
->io_limits
.bps
[BLOCK_IO_LIMIT_TOTAL
]) {
2991 bps_limit
= bs
->io_limits
.bps
[BLOCK_IO_LIMIT_TOTAL
];
2992 } else if (bs
->io_limits
.bps
[is_write
]) {
2993 bps_limit
= bs
->io_limits
.bps
[is_write
];
3002 slice_time
= bs
->slice_end
- bs
->slice_start
;
3003 slice_time
/= (NANOSECONDS_PER_SECOND
);
3004 bytes_limit
= bps_limit
* slice_time
;
3005 bytes_base
= bs
->nr_bytes
[is_write
] - bs
->io_base
.bytes
[is_write
];
3006 if (bs
->io_limits
.bps
[BLOCK_IO_LIMIT_TOTAL
]) {
3007 bytes_base
+= bs
->nr_bytes
[!is_write
] - bs
->io_base
.bytes
[!is_write
];
3010 /* bytes_base: the bytes of data which have been read/written; and
3011 * it is obtained from the history statistic info.
3012 * bytes_res: the remaining bytes of data which need to be read/written.
3013 * (bytes_base + bytes_res) / bps_limit: used to calcuate
3014 * the total time for completing reading/writting all data.
3016 bytes_res
= (unsigned) nb_sectors
* BDRV_SECTOR_SIZE
;
3018 if (bytes_base
+ bytes_res
<= bytes_limit
) {
3026 /* Calc approx time to dispatch */
3027 wait_time
= (bytes_base
+ bytes_res
) / bps_limit
- elapsed_time
;
3029 /* When the I/O rate at runtime exceeds the limits,
3030 * bs->slice_end need to be extended in order that the current statistic
3031 * info can be kept until the timer fire, so it is increased and tuned
3032 * based on the result of experiment.
3034 bs
->slice_time
= wait_time
* BLOCK_IO_SLICE_TIME
* 10;
3035 bs
->slice_end
+= bs
->slice_time
- 3 * BLOCK_IO_SLICE_TIME
;
3037 *wait
= wait_time
* BLOCK_IO_SLICE_TIME
* 10;
3043 static bool bdrv_exceed_iops_limits(BlockDriverState
*bs
, bool is_write
,
3044 double elapsed_time
, uint64_t *wait
)
3046 uint64_t iops_limit
= 0;
3047 double ios_limit
, ios_base
;
3048 double slice_time
, wait_time
;
3050 if (bs
->io_limits
.iops
[BLOCK_IO_LIMIT_TOTAL
]) {
3051 iops_limit
= bs
->io_limits
.iops
[BLOCK_IO_LIMIT_TOTAL
];
3052 } else if (bs
->io_limits
.iops
[is_write
]) {
3053 iops_limit
= bs
->io_limits
.iops
[is_write
];
3062 slice_time
= bs
->slice_end
- bs
->slice_start
;
3063 slice_time
/= (NANOSECONDS_PER_SECOND
);
3064 ios_limit
= iops_limit
* slice_time
;
3065 ios_base
= bs
->nr_ops
[is_write
] - bs
->io_base
.ios
[is_write
];
3066 if (bs
->io_limits
.iops
[BLOCK_IO_LIMIT_TOTAL
]) {
3067 ios_base
+= bs
->nr_ops
[!is_write
] - bs
->io_base
.ios
[!is_write
];
3070 if (ios_base
+ 1 <= ios_limit
) {
3078 /* Calc approx time to dispatch */
3079 wait_time
= (ios_base
+ 1) / iops_limit
;
3080 if (wait_time
> elapsed_time
) {
3081 wait_time
= wait_time
- elapsed_time
;
3086 bs
->slice_time
= wait_time
* BLOCK_IO_SLICE_TIME
* 10;
3087 bs
->slice_end
+= bs
->slice_time
- 3 * BLOCK_IO_SLICE_TIME
;
3089 *wait
= wait_time
* BLOCK_IO_SLICE_TIME
* 10;
3095 static bool bdrv_exceed_io_limits(BlockDriverState
*bs
, int nb_sectors
,
3096 bool is_write
, int64_t *wait
)
3098 int64_t now
, max_wait
;
3099 uint64_t bps_wait
= 0, iops_wait
= 0;
3100 double elapsed_time
;
3101 int bps_ret
, iops_ret
;
3103 now
= qemu_get_clock_ns(vm_clock
);
3104 if ((bs
->slice_start
< now
)
3105 && (bs
->slice_end
> now
)) {
3106 bs
->slice_end
= now
+ bs
->slice_time
;
3108 bs
->slice_time
= 5 * BLOCK_IO_SLICE_TIME
;
3109 bs
->slice_start
= now
;
3110 bs
->slice_end
= now
+ bs
->slice_time
;
3112 bs
->io_base
.bytes
[is_write
] = bs
->nr_bytes
[is_write
];
3113 bs
->io_base
.bytes
[!is_write
] = bs
->nr_bytes
[!is_write
];
3115 bs
->io_base
.ios
[is_write
] = bs
->nr_ops
[is_write
];
3116 bs
->io_base
.ios
[!is_write
] = bs
->nr_ops
[!is_write
];
3119 elapsed_time
= now
- bs
->slice_start
;
3120 elapsed_time
/= (NANOSECONDS_PER_SECOND
);
3122 bps_ret
= bdrv_exceed_bps_limits(bs
, nb_sectors
,
3123 is_write
, elapsed_time
, &bps_wait
);
3124 iops_ret
= bdrv_exceed_iops_limits(bs
, is_write
,
3125 elapsed_time
, &iops_wait
);
3126 if (bps_ret
|| iops_ret
) {
3127 max_wait
= bps_wait
> iops_wait
? bps_wait
: iops_wait
;
3132 now
= qemu_get_clock_ns(vm_clock
);
3133 if (bs
->slice_end
< now
+ max_wait
) {
3134 bs
->slice_end
= now
+ max_wait
;
3147 /**************************************************************/
3148 /* async block device emulation */
3150 typedef struct BlockDriverAIOCBSync
{
3151 BlockDriverAIOCB common
;
3154 /* vector translation state */
3158 } BlockDriverAIOCBSync
;
3160 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*blockacb
)
3162 BlockDriverAIOCBSync
*acb
=
3163 container_of(blockacb
, BlockDriverAIOCBSync
, common
);
3164 qemu_bh_delete(acb
->bh
);
3166 qemu_aio_release(acb
);
3169 static AIOPool bdrv_em_aio_pool
= {
3170 .aiocb_size
= sizeof(BlockDriverAIOCBSync
),
3171 .cancel
= bdrv_aio_cancel_em
,
3174 static void bdrv_aio_bh_cb(void *opaque
)
3176 BlockDriverAIOCBSync
*acb
= opaque
;
3179 qemu_iovec_from_buffer(acb
->qiov
, acb
->bounce
, acb
->qiov
->size
);
3180 qemu_vfree(acb
->bounce
);
3181 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
3182 qemu_bh_delete(acb
->bh
);
3184 qemu_aio_release(acb
);
3187 static BlockDriverAIOCB
*bdrv_aio_rw_vector(BlockDriverState
*bs
,
3191 BlockDriverCompletionFunc
*cb
,
3196 BlockDriverAIOCBSync
*acb
;
3198 acb
= qemu_aio_get(&bdrv_em_aio_pool
, bs
, cb
, opaque
);
3199 acb
->is_write
= is_write
;
3201 acb
->bounce
= qemu_blockalign(bs
, qiov
->size
);
3202 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
3205 qemu_iovec_to_buffer(acb
->qiov
, acb
->bounce
);
3206 acb
->ret
= bs
->drv
->bdrv_write(bs
, sector_num
, acb
->bounce
, nb_sectors
);
3208 acb
->ret
= bs
->drv
->bdrv_read(bs
, sector_num
, acb
->bounce
, nb_sectors
);
3211 qemu_bh_schedule(acb
->bh
);
3213 return &acb
->common
;
3216 static BlockDriverAIOCB
*bdrv_aio_readv_em(BlockDriverState
*bs
,
3217 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
3218 BlockDriverCompletionFunc
*cb
, void *opaque
)
3220 return bdrv_aio_rw_vector(bs
, sector_num
, qiov
, nb_sectors
, cb
, opaque
, 0);
3223 static BlockDriverAIOCB
*bdrv_aio_writev_em(BlockDriverState
*bs
,
3224 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
3225 BlockDriverCompletionFunc
*cb
, void *opaque
)
3227 return bdrv_aio_rw_vector(bs
, sector_num
, qiov
, nb_sectors
, cb
, opaque
, 1);
3231 typedef struct BlockDriverAIOCBCoroutine
{
3232 BlockDriverAIOCB common
;
3236 } BlockDriverAIOCBCoroutine
;
3238 static void bdrv_aio_co_cancel_em(BlockDriverAIOCB
*blockacb
)
3243 static AIOPool bdrv_em_co_aio_pool
= {
3244 .aiocb_size
= sizeof(BlockDriverAIOCBCoroutine
),
3245 .cancel
= bdrv_aio_co_cancel_em
,
3248 static void bdrv_co_em_bh(void *opaque
)
3250 BlockDriverAIOCBCoroutine
*acb
= opaque
;
3252 acb
->common
.cb(acb
->common
.opaque
, acb
->req
.error
);
3253 qemu_bh_delete(acb
->bh
);
3254 qemu_aio_release(acb
);
3257 /* Invoke bdrv_co_do_readv/bdrv_co_do_writev */
3258 static void coroutine_fn
bdrv_co_do_rw(void *opaque
)
3260 BlockDriverAIOCBCoroutine
*acb
= opaque
;
3261 BlockDriverState
*bs
= acb
->common
.bs
;
3263 if (!acb
->is_write
) {
3264 acb
->req
.error
= bdrv_co_do_readv(bs
, acb
->req
.sector
,
3265 acb
->req
.nb_sectors
, acb
->req
.qiov
, 0);
3267 acb
->req
.error
= bdrv_co_do_writev(bs
, acb
->req
.sector
,
3268 acb
->req
.nb_sectors
, acb
->req
.qiov
, 0);
3271 acb
->bh
= qemu_bh_new(bdrv_co_em_bh
, acb
);
3272 qemu_bh_schedule(acb
->bh
);
3275 static BlockDriverAIOCB
*bdrv_co_aio_rw_vector(BlockDriverState
*bs
,
3279 BlockDriverCompletionFunc
*cb
,
3284 BlockDriverAIOCBCoroutine
*acb
;
3286 acb
= qemu_aio_get(&bdrv_em_co_aio_pool
, bs
, cb
, opaque
);
3287 acb
->req
.sector
= sector_num
;
3288 acb
->req
.nb_sectors
= nb_sectors
;
3289 acb
->req
.qiov
= qiov
;
3290 acb
->is_write
= is_write
;
3292 co
= qemu_coroutine_create(bdrv_co_do_rw
);
3293 qemu_coroutine_enter(co
, acb
);
3295 return &acb
->common
;
3298 static void coroutine_fn
bdrv_aio_flush_co_entry(void *opaque
)
3300 BlockDriverAIOCBCoroutine
*acb
= opaque
;
3301 BlockDriverState
*bs
= acb
->common
.bs
;
3303 acb
->req
.error
= bdrv_co_flush(bs
);
3304 acb
->bh
= qemu_bh_new(bdrv_co_em_bh
, acb
);
3305 qemu_bh_schedule(acb
->bh
);
3308 BlockDriverAIOCB
*bdrv_aio_flush(BlockDriverState
*bs
,
3309 BlockDriverCompletionFunc
*cb
, void *opaque
)
3311 trace_bdrv_aio_flush(bs
, opaque
);
3314 BlockDriverAIOCBCoroutine
*acb
;
3316 acb
= qemu_aio_get(&bdrv_em_co_aio_pool
, bs
, cb
, opaque
);
3317 co
= qemu_coroutine_create(bdrv_aio_flush_co_entry
);
3318 qemu_coroutine_enter(co
, acb
);
3320 return &acb
->common
;
3323 static void coroutine_fn
bdrv_aio_discard_co_entry(void *opaque
)
3325 BlockDriverAIOCBCoroutine
*acb
= opaque
;
3326 BlockDriverState
*bs
= acb
->common
.bs
;
3328 acb
->req
.error
= bdrv_co_discard(bs
, acb
->req
.sector
, acb
->req
.nb_sectors
);
3329 acb
->bh
= qemu_bh_new(bdrv_co_em_bh
, acb
);
3330 qemu_bh_schedule(acb
->bh
);
3333 BlockDriverAIOCB
*bdrv_aio_discard(BlockDriverState
*bs
,
3334 int64_t sector_num
, int nb_sectors
,
3335 BlockDriverCompletionFunc
*cb
, void *opaque
)
3338 BlockDriverAIOCBCoroutine
*acb
;
3340 trace_bdrv_aio_discard(bs
, sector_num
, nb_sectors
, opaque
);
3342 acb
= qemu_aio_get(&bdrv_em_co_aio_pool
, bs
, cb
, opaque
);
3343 acb
->req
.sector
= sector_num
;
3344 acb
->req
.nb_sectors
= nb_sectors
;
3345 co
= qemu_coroutine_create(bdrv_aio_discard_co_entry
);
3346 qemu_coroutine_enter(co
, acb
);
3348 return &acb
->common
;
3351 void bdrv_init(void)
3353 module_call_init(MODULE_INIT_BLOCK
);
3356 void bdrv_init_with_whitelist(void)
3358 use_bdrv_whitelist
= 1;
3362 void *qemu_aio_get(AIOPool
*pool
, BlockDriverState
*bs
,
3363 BlockDriverCompletionFunc
*cb
, void *opaque
)
3365 BlockDriverAIOCB
*acb
;
3367 if (pool
->free_aiocb
) {
3368 acb
= pool
->free_aiocb
;
3369 pool
->free_aiocb
= acb
->next
;
3371 acb
= g_malloc0(pool
->aiocb_size
);
3376 acb
->opaque
= opaque
;
3380 void qemu_aio_release(void *p
)
3382 BlockDriverAIOCB
*acb
= (BlockDriverAIOCB
*)p
;
3383 AIOPool
*pool
= acb
->pool
;
3384 acb
->next
= pool
->free_aiocb
;
3385 pool
->free_aiocb
= acb
;
3388 /**************************************************************/
3389 /* Coroutine block device emulation */
3391 typedef struct CoroutineIOCompletion
{
3392 Coroutine
*coroutine
;
3394 } CoroutineIOCompletion
;
3396 static void bdrv_co_io_em_complete(void *opaque
, int ret
)
3398 CoroutineIOCompletion
*co
= opaque
;
3401 qemu_coroutine_enter(co
->coroutine
, NULL
);
3404 static int coroutine_fn
bdrv_co_io_em(BlockDriverState
*bs
, int64_t sector_num
,
3405 int nb_sectors
, QEMUIOVector
*iov
,
3408 CoroutineIOCompletion co
= {
3409 .coroutine
= qemu_coroutine_self(),
3411 BlockDriverAIOCB
*acb
;
3414 acb
= bs
->drv
->bdrv_aio_writev(bs
, sector_num
, iov
, nb_sectors
,
3415 bdrv_co_io_em_complete
, &co
);
3417 acb
= bs
->drv
->bdrv_aio_readv(bs
, sector_num
, iov
, nb_sectors
,
3418 bdrv_co_io_em_complete
, &co
);
3421 trace_bdrv_co_io_em(bs
, sector_num
, nb_sectors
, is_write
, acb
);
3425 qemu_coroutine_yield();
3430 static int coroutine_fn
bdrv_co_readv_em(BlockDriverState
*bs
,
3431 int64_t sector_num
, int nb_sectors
,
3434 return bdrv_co_io_em(bs
, sector_num
, nb_sectors
, iov
, false);
3437 static int coroutine_fn
bdrv_co_writev_em(BlockDriverState
*bs
,
3438 int64_t sector_num
, int nb_sectors
,
3441 return bdrv_co_io_em(bs
, sector_num
, nb_sectors
, iov
, true);
3444 static void coroutine_fn
bdrv_flush_co_entry(void *opaque
)
3446 RwCo
*rwco
= opaque
;
3448 rwco
->ret
= bdrv_co_flush(rwco
->bs
);
3451 int coroutine_fn
bdrv_co_flush(BlockDriverState
*bs
)
3459 /* Write back cached data to the OS even with cache=unsafe */
3460 if (bs
->drv
->bdrv_co_flush_to_os
) {
3461 ret
= bs
->drv
->bdrv_co_flush_to_os(bs
);
3467 /* But don't actually force it to the disk with cache=unsafe */
3468 if (bs
->open_flags
& BDRV_O_NO_FLUSH
) {
3472 if (bs
->drv
->bdrv_co_flush_to_disk
) {
3473 return bs
->drv
->bdrv_co_flush_to_disk(bs
);
3474 } else if (bs
->drv
->bdrv_aio_flush
) {
3475 BlockDriverAIOCB
*acb
;
3476 CoroutineIOCompletion co
= {
3477 .coroutine
= qemu_coroutine_self(),
3480 acb
= bs
->drv
->bdrv_aio_flush(bs
, bdrv_co_io_em_complete
, &co
);
3484 qemu_coroutine_yield();
3489 * Some block drivers always operate in either writethrough or unsafe
3490 * mode and don't support bdrv_flush therefore. Usually qemu doesn't
3491 * know how the server works (because the behaviour is hardcoded or
3492 * depends on server-side configuration), so we can't ensure that
3493 * everything is safe on disk. Returning an error doesn't work because
3494 * that would break guests even if the server operates in writethrough
3497 * Let's hope the user knows what he's doing.
3503 void bdrv_invalidate_cache(BlockDriverState
*bs
)
3505 if (bs
->drv
&& bs
->drv
->bdrv_invalidate_cache
) {
3506 bs
->drv
->bdrv_invalidate_cache(bs
);
3510 void bdrv_invalidate_cache_all(void)
3512 BlockDriverState
*bs
;
3514 QTAILQ_FOREACH(bs
, &bdrv_states
, list
) {
3515 bdrv_invalidate_cache(bs
);
3519 int bdrv_flush(BlockDriverState
*bs
)
3527 if (qemu_in_coroutine()) {
3528 /* Fast-path if already in coroutine context */
3529 bdrv_flush_co_entry(&rwco
);
3531 co
= qemu_coroutine_create(bdrv_flush_co_entry
);
3532 qemu_coroutine_enter(co
, &rwco
);
3533 while (rwco
.ret
== NOT_DONE
) {
3541 static void coroutine_fn
bdrv_discard_co_entry(void *opaque
)
3543 RwCo
*rwco
= opaque
;
3545 rwco
->ret
= bdrv_co_discard(rwco
->bs
, rwco
->sector_num
, rwco
->nb_sectors
);
3548 int coroutine_fn
bdrv_co_discard(BlockDriverState
*bs
, int64_t sector_num
,
3553 } else if (bdrv_check_request(bs
, sector_num
, nb_sectors
)) {
3555 } else if (bs
->read_only
) {
3557 } else if (bs
->drv
->bdrv_co_discard
) {
3558 return bs
->drv
->bdrv_co_discard(bs
, sector_num
, nb_sectors
);
3559 } else if (bs
->drv
->bdrv_aio_discard
) {
3560 BlockDriverAIOCB
*acb
;
3561 CoroutineIOCompletion co
= {
3562 .coroutine
= qemu_coroutine_self(),
3565 acb
= bs
->drv
->bdrv_aio_discard(bs
, sector_num
, nb_sectors
,
3566 bdrv_co_io_em_complete
, &co
);
3570 qemu_coroutine_yield();
3578 int bdrv_discard(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
)
3583 .sector_num
= sector_num
,
3584 .nb_sectors
= nb_sectors
,
3588 if (qemu_in_coroutine()) {
3589 /* Fast-path if already in coroutine context */
3590 bdrv_discard_co_entry(&rwco
);
3592 co
= qemu_coroutine_create(bdrv_discard_co_entry
);
3593 qemu_coroutine_enter(co
, &rwco
);
3594 while (rwco
.ret
== NOT_DONE
) {
3602 /**************************************************************/
3603 /* removable device support */
3606 * Return TRUE if the media is present
3608 int bdrv_is_inserted(BlockDriverState
*bs
)
3610 BlockDriver
*drv
= bs
->drv
;
3614 if (!drv
->bdrv_is_inserted
)
3616 return drv
->bdrv_is_inserted(bs
);
3620 * Return whether the media changed since the last call to this
3621 * function, or -ENOTSUP if we don't know. Most drivers don't know.
3623 int bdrv_media_changed(BlockDriverState
*bs
)
3625 BlockDriver
*drv
= bs
->drv
;
3627 if (drv
&& drv
->bdrv_media_changed
) {
3628 return drv
->bdrv_media_changed(bs
);
3634 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
3636 void bdrv_eject(BlockDriverState
*bs
, bool eject_flag
)
3638 BlockDriver
*drv
= bs
->drv
;
3640 if (drv
&& drv
->bdrv_eject
) {
3641 drv
->bdrv_eject(bs
, eject_flag
);
3644 if (bs
->device_name
[0] != '\0') {
3645 bdrv_emit_qmp_eject_event(bs
, eject_flag
);
3650 * Lock or unlock the media (if it is locked, the user won't be able
3651 * to eject it manually).
3653 void bdrv_lock_medium(BlockDriverState
*bs
, bool locked
)
3655 BlockDriver
*drv
= bs
->drv
;
3657 trace_bdrv_lock_medium(bs
, locked
);
3659 if (drv
&& drv
->bdrv_lock_medium
) {
3660 drv
->bdrv_lock_medium(bs
, locked
);
3664 /* needed for generic scsi interface */
3666 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
)
3668 BlockDriver
*drv
= bs
->drv
;
3670 if (drv
&& drv
->bdrv_ioctl
)
3671 return drv
->bdrv_ioctl(bs
, req
, buf
);
3675 BlockDriverAIOCB
*bdrv_aio_ioctl(BlockDriverState
*bs
,
3676 unsigned long int req
, void *buf
,
3677 BlockDriverCompletionFunc
*cb
, void *opaque
)
3679 BlockDriver
*drv
= bs
->drv
;
3681 if (drv
&& drv
->bdrv_aio_ioctl
)
3682 return drv
->bdrv_aio_ioctl(bs
, req
, buf
, cb
, opaque
);
3686 void bdrv_set_buffer_alignment(BlockDriverState
*bs
, int align
)
3688 bs
->buffer_alignment
= align
;
3691 void *qemu_blockalign(BlockDriverState
*bs
, size_t size
)
3693 return qemu_memalign((bs
&& bs
->buffer_alignment
) ? bs
->buffer_alignment
: 512, size
);
3696 void bdrv_set_dirty_tracking(BlockDriverState
*bs
, int enable
)
3698 int64_t bitmap_size
;
3700 bs
->dirty_count
= 0;
3702 if (!bs
->dirty_bitmap
) {
3703 bitmap_size
= (bdrv_getlength(bs
) >> BDRV_SECTOR_BITS
) +
3704 BDRV_SECTORS_PER_DIRTY_CHUNK
* 8 - 1;
3705 bitmap_size
/= BDRV_SECTORS_PER_DIRTY_CHUNK
* 8;
3707 bs
->dirty_bitmap
= g_malloc0(bitmap_size
);
3710 if (bs
->dirty_bitmap
) {
3711 g_free(bs
->dirty_bitmap
);
3712 bs
->dirty_bitmap
= NULL
;
3717 int bdrv_get_dirty(BlockDriverState
*bs
, int64_t sector
)
3719 int64_t chunk
= sector
/ (int64_t)BDRV_SECTORS_PER_DIRTY_CHUNK
;
3721 if (bs
->dirty_bitmap
&&
3722 (sector
<< BDRV_SECTOR_BITS
) < bdrv_getlength(bs
)) {
3723 return !!(bs
->dirty_bitmap
[chunk
/ (sizeof(unsigned long) * 8)] &
3724 (1UL << (chunk
% (sizeof(unsigned long) * 8))));
3730 void bdrv_reset_dirty(BlockDriverState
*bs
, int64_t cur_sector
,
3733 set_dirty_bitmap(bs
, cur_sector
, nr_sectors
, 0);
3736 int64_t bdrv_get_dirty_count(BlockDriverState
*bs
)
3738 return bs
->dirty_count
;
3741 void bdrv_set_in_use(BlockDriverState
*bs
, int in_use
)
3743 assert(bs
->in_use
!= in_use
);
3744 bs
->in_use
= in_use
;
3747 int bdrv_in_use(BlockDriverState
*bs
)
3752 void bdrv_iostatus_enable(BlockDriverState
*bs
)
3754 bs
->iostatus_enabled
= true;
3755 bs
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
3758 /* The I/O status is only enabled if the drive explicitly
3759 * enables it _and_ the VM is configured to stop on errors */
3760 bool bdrv_iostatus_is_enabled(const BlockDriverState
*bs
)
3762 return (bs
->iostatus_enabled
&&
3763 (bs
->on_write_error
== BLOCK_ERR_STOP_ENOSPC
||
3764 bs
->on_write_error
== BLOCK_ERR_STOP_ANY
||
3765 bs
->on_read_error
== BLOCK_ERR_STOP_ANY
));
3768 void bdrv_iostatus_disable(BlockDriverState
*bs
)
3770 bs
->iostatus_enabled
= false;
3773 void bdrv_iostatus_reset(BlockDriverState
*bs
)
3775 if (bdrv_iostatus_is_enabled(bs
)) {
3776 bs
->iostatus
= BLOCK_DEVICE_IO_STATUS_OK
;
3780 /* XXX: Today this is set by device models because it makes the implementation
3781 quite simple. However, the block layer knows about the error, so it's
3782 possible to implement this without device models being involved */
3783 void bdrv_iostatus_set_err(BlockDriverState
*bs
, int error
)
3785 if (bdrv_iostatus_is_enabled(bs
) &&
3786 bs
->iostatus
== BLOCK_DEVICE_IO_STATUS_OK
) {
3788 bs
->iostatus
= error
== ENOSPC
? BLOCK_DEVICE_IO_STATUS_NOSPACE
:
3789 BLOCK_DEVICE_IO_STATUS_FAILED
;
3794 bdrv_acct_start(BlockDriverState
*bs
, BlockAcctCookie
*cookie
, int64_t bytes
,
3795 enum BlockAcctType type
)
3797 assert(type
< BDRV_MAX_IOTYPE
);
3799 cookie
->bytes
= bytes
;
3800 cookie
->start_time_ns
= get_clock();
3801 cookie
->type
= type
;
3805 bdrv_acct_done(BlockDriverState
*bs
, BlockAcctCookie
*cookie
)
3807 assert(cookie
->type
< BDRV_MAX_IOTYPE
);
3809 bs
->nr_bytes
[cookie
->type
] += cookie
->bytes
;
3810 bs
->nr_ops
[cookie
->type
]++;
3811 bs
->total_time_ns
[cookie
->type
] += get_clock() - cookie
->start_time_ns
;
3814 int bdrv_img_create(const char *filename
, const char *fmt
,
3815 const char *base_filename
, const char *base_fmt
,
3816 char *options
, uint64_t img_size
, int flags
)
3818 QEMUOptionParameter
*param
= NULL
, *create_options
= NULL
;
3819 QEMUOptionParameter
*backing_fmt
, *backing_file
, *size
;
3820 BlockDriverState
*bs
= NULL
;
3821 BlockDriver
*drv
, *proto_drv
;
3822 BlockDriver
*backing_drv
= NULL
;
3825 /* Find driver and parse its options */
3826 drv
= bdrv_find_format(fmt
);
3828 error_report("Unknown file format '%s'", fmt
);
3833 proto_drv
= bdrv_find_protocol(filename
);
3835 error_report("Unknown protocol '%s'", filename
);
3840 create_options
= append_option_parameters(create_options
,
3841 drv
->create_options
);
3842 create_options
= append_option_parameters(create_options
,
3843 proto_drv
->create_options
);
3845 /* Create parameter list with default values */
3846 param
= parse_option_parameters("", create_options
, param
);
3848 set_option_parameter_int(param
, BLOCK_OPT_SIZE
, img_size
);
3850 /* Parse -o options */
3852 param
= parse_option_parameters(options
, create_options
, param
);
3853 if (param
== NULL
) {
3854 error_report("Invalid options for file format '%s'.", fmt
);
3860 if (base_filename
) {
3861 if (set_option_parameter(param
, BLOCK_OPT_BACKING_FILE
,
3863 error_report("Backing file not supported for file format '%s'",
3871 if (set_option_parameter(param
, BLOCK_OPT_BACKING_FMT
, base_fmt
)) {
3872 error_report("Backing file format not supported for file "
3873 "format '%s'", fmt
);
3879 backing_file
= get_option_parameter(param
, BLOCK_OPT_BACKING_FILE
);
3880 if (backing_file
&& backing_file
->value
.s
) {
3881 if (!strcmp(filename
, backing_file
->value
.s
)) {
3882 error_report("Error: Trying to create an image with the "
3883 "same filename as the backing file");
3889 backing_fmt
= get_option_parameter(param
, BLOCK_OPT_BACKING_FMT
);
3890 if (backing_fmt
&& backing_fmt
->value
.s
) {
3891 backing_drv
= bdrv_find_format(backing_fmt
->value
.s
);
3893 error_report("Unknown backing file format '%s'",
3894 backing_fmt
->value
.s
);
3900 // The size for the image must always be specified, with one exception:
3901 // If we are using a backing file, we can obtain the size from there
3902 size
= get_option_parameter(param
, BLOCK_OPT_SIZE
);
3903 if (size
&& size
->value
.n
== -1) {
3904 if (backing_file
&& backing_file
->value
.s
) {
3910 ret
= bdrv_open(bs
, backing_file
->value
.s
, flags
, backing_drv
);
3912 error_report("Could not open '%s'", backing_file
->value
.s
);
3915 bdrv_get_geometry(bs
, &size
);
3918 snprintf(buf
, sizeof(buf
), "%" PRId64
, size
);
3919 set_option_parameter(param
, BLOCK_OPT_SIZE
, buf
);
3921 error_report("Image creation needs a size parameter");
3927 printf("Formatting '%s', fmt=%s ", filename
, fmt
);
3928 print_option_parameters(param
);
3931 ret
= bdrv_create(drv
, filename
, param
);
3934 if (ret
== -ENOTSUP
) {
3935 error_report("Formatting or formatting option not supported for "
3936 "file format '%s'", fmt
);
3937 } else if (ret
== -EFBIG
) {
3938 error_report("The image size is too large for file format '%s'",
3941 error_report("%s: error while creating %s: %s", filename
, fmt
,
3947 free_option_parameters(create_options
);
3948 free_option_parameters(param
);
3957 void *block_job_create(const BlockJobType
*job_type
, BlockDriverState
*bs
,
3958 BlockDriverCompletionFunc
*cb
, void *opaque
)
3962 if (bs
->job
|| bdrv_in_use(bs
)) {
3965 bdrv_set_in_use(bs
, 1);
3967 job
= g_malloc0(job_type
->instance_size
);
3968 job
->job_type
= job_type
;
3971 job
->opaque
= opaque
;
3976 void block_job_complete(BlockJob
*job
, int ret
)
3978 BlockDriverState
*bs
= job
->bs
;
3980 assert(bs
->job
== job
);
3981 job
->cb(job
->opaque
, ret
);
3984 bdrv_set_in_use(bs
, 0);
3987 int block_job_set_speed(BlockJob
*job
, int64_t value
)
3989 if (!job
->job_type
->set_speed
) {
3992 return job
->job_type
->set_speed(job
, value
);
3995 void block_job_cancel(BlockJob
*job
)
3997 job
->cancelled
= true;
4000 bool block_job_is_cancelled(BlockJob
*job
)
4002 return job
->cancelled
;