2 * Block driver for RAW files (posix)
4 * Copyright (c) 2006 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
25 #include "qemu/osdep.h"
26 #include "qemu-common.h"
27 #include "qapi/error.h"
28 #include "qemu/cutils.h"
29 #include "qemu/error-report.h"
30 #include "block/block_int.h"
31 #include "qemu/module.h"
32 #include "qemu/option.h"
33 #include "qemu/units.h"
34 #include "qemu/memalign.h"
36 #include "block/thread-pool.h"
38 #include "block/raw-aio.h"
39 #include "qapi/qmp/qdict.h"
40 #include "qapi/qmp/qstring.h"
42 #include "scsi/pr-manager.h"
43 #include "scsi/constants.h"
45 #if defined(__APPLE__) && (__MACH__)
46 #include <sys/ioctl.h>
47 #if defined(HAVE_HOST_BLOCK_DEVICE)
49 #include <sys/param.h>
50 #include <sys/mount.h>
51 #include <IOKit/IOKitLib.h>
52 #include <IOKit/IOBSD.h>
53 #include <IOKit/storage/IOMediaBSDClient.h>
54 #include <IOKit/storage/IOMedia.h>
55 #include <IOKit/storage/IOCDMedia.h>
56 //#include <IOKit/storage/IOCDTypes.h>
57 #include <IOKit/storage/IODVDMedia.h>
58 #include <CoreFoundation/CoreFoundation.h>
59 #endif /* defined(HAVE_HOST_BLOCK_DEVICE) */
63 #define _POSIX_PTHREAD_SEMANTICS 1
67 #include <sys/ioctl.h>
68 #include <sys/param.h>
69 #include <sys/syscall.h>
71 #include <linux/cdrom.h>
74 #include <linux/hdreg.h>
75 #include <linux/magic.h>
81 #define FS_NOCOW_FL 0x00800000 /* Do not cow file */
84 #if defined(CONFIG_FALLOCATE_PUNCH_HOLE) || defined(CONFIG_FALLOCATE_ZERO_RANGE)
85 #include <linux/falloc.h>
87 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
93 #include <sys/ioctl.h>
94 #include <sys/disklabel.h>
99 #include <sys/ioctl.h>
100 #include <sys/disklabel.h>
101 #include <sys/dkio.h>
102 #include <sys/disk.h>
106 #include <sys/ioctl.h>
107 #include <sys/diskslice.h>
110 /* OS X does not have O_DSYNC */
113 #define O_DSYNC O_SYNC
114 #elif defined(O_FSYNC)
115 #define O_DSYNC O_FSYNC
119 /* Approximate O_DIRECT with O_DSYNC if O_DIRECT isn't available */
121 #define O_DIRECT O_DSYNC
127 #define MAX_BLOCKSIZE 4096
129 /* Posix file locking bytes. Libvirt takes byte 0, we start from higher bytes,
130 * leaving a few more bytes for its future use. */
131 #define RAW_LOCK_PERM_BASE 100
132 #define RAW_LOCK_SHARED_BASE 200
134 typedef struct BDRVRawState
{
141 /* The current permissions. */
143 uint64_t shared_perm
;
145 /* The perms bits whose corresponding bytes are already locked in
147 uint64_t locked_perm
;
148 uint64_t locked_shared_perm
;
150 uint64_t aio_max_batch
;
153 int perm_change_flags
;
154 BDRVReopenState
*reopen_state
;
157 bool has_write_zeroes
:1;
158 bool discard_zeroes
:1;
159 bool use_linux_aio
:1;
160 bool use_linux_io_uring
:1;
161 int page_cache_inconsistent
; /* errno from fdatasync failure */
163 bool needs_alignment
;
164 bool force_alignment
;
166 bool check_cache_dropped
;
168 uint64_t discard_nb_ok
;
169 uint64_t discard_nb_failed
;
170 uint64_t discard_bytes_ok
;
176 typedef struct BDRVRawReopenState
{
179 bool check_cache_dropped
;
180 } BDRVRawReopenState
;
182 static int fd_open(BlockDriverState
*bs
)
184 BDRVRawState
*s
= bs
->opaque
;
186 /* this is just to ensure s->fd is sane (its called by io ops) */
193 static int64_t raw_getlength(BlockDriverState
*bs
);
195 typedef struct RawPosixAIOData
{
196 BlockDriverState
*bs
;
217 PreallocMode prealloc
;
223 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
224 static int cdrom_reopen(BlockDriverState
*bs
);
228 * Elide EAGAIN and EACCES details when failing to lock, as this
229 * indicates that the specified file region is already locked by
230 * another process, which is considered a common scenario.
232 #define raw_lock_error_setg_errno(errp, err, fmt, ...) \
234 if ((err) == EAGAIN || (err) == EACCES) { \
235 error_setg((errp), (fmt), ## __VA_ARGS__); \
237 error_setg_errno((errp), (err), (fmt), ## __VA_ARGS__); \
241 #if defined(__NetBSD__)
242 static int raw_normalize_devicepath(const char **filename
, Error
**errp
)
244 static char namebuf
[PATH_MAX
];
245 const char *dp
, *fname
;
249 dp
= strrchr(fname
, '/');
250 if (lstat(fname
, &sb
) < 0) {
251 error_setg_file_open(errp
, errno
, fname
);
255 if (!S_ISBLK(sb
.st_mode
)) {
260 snprintf(namebuf
, PATH_MAX
, "r%s", fname
);
262 snprintf(namebuf
, PATH_MAX
, "%.*s/r%s",
263 (int)(dp
- fname
), fname
, dp
+ 1);
266 warn_report("%s is a block device, using %s", fname
, *filename
);
271 static int raw_normalize_devicepath(const char **filename
, Error
**errp
)
278 * Get logical block size via ioctl. On success store it in @sector_size_p.
280 static int probe_logical_blocksize(int fd
, unsigned int *sector_size_p
)
282 unsigned int sector_size
;
283 bool success
= false;
287 static const unsigned long ioctl_list
[] = {
291 #ifdef DKIOCGETBLOCKSIZE
294 #ifdef DIOCGSECTORSIZE
299 /* Try a few ioctls to get the right size */
300 for (i
= 0; i
< (int)ARRAY_SIZE(ioctl_list
); i
++) {
301 if (ioctl(fd
, ioctl_list
[i
], §or_size
) >= 0) {
302 *sector_size_p
= sector_size
;
307 return success
? 0 : -errno
;
311 * Get physical block size of @fd.
312 * On success, store it in @blk_size and return 0.
313 * On failure, return -errno.
315 static int probe_physical_blocksize(int fd
, unsigned int *blk_size
)
318 if (ioctl(fd
, BLKPBSZGET
, blk_size
) < 0) {
328 * Returns true if no alignment restrictions are necessary even for files
329 * opened with O_DIRECT.
331 * raw_probe_alignment() probes the required alignment and assume that 1 means
332 * the probing failed, so it falls back to a safe default of 4k. This can be
333 * avoided if we know that byte alignment is okay for the file.
335 static bool dio_byte_aligned(int fd
)
341 ret
= fstatfs(fd
, &buf
);
342 if (ret
== 0 && buf
.f_type
== NFS_SUPER_MAGIC
) {
349 static bool raw_needs_alignment(BlockDriverState
*bs
)
351 BDRVRawState
*s
= bs
->opaque
;
353 if ((bs
->open_flags
& BDRV_O_NOCACHE
) != 0 && !dio_byte_aligned(s
->fd
)) {
357 return s
->force_alignment
;
360 /* Check if read is allowed with given memory buffer and length.
362 * This function is used to check O_DIRECT memory buffer and request alignment.
364 static bool raw_is_io_aligned(int fd
, void *buf
, size_t len
)
366 ssize_t ret
= pread(fd
, buf
, len
, 0);
373 /* The Linux kernel returns EINVAL for misaligned O_DIRECT reads. Ignore
374 * other errors (e.g. real I/O error), which could happen on a failed
375 * drive, since we only care about probing alignment.
377 if (errno
!= EINVAL
) {
385 static void raw_probe_alignment(BlockDriverState
*bs
, int fd
, Error
**errp
)
387 BDRVRawState
*s
= bs
->opaque
;
389 size_t max_align
= MAX(MAX_BLOCKSIZE
, qemu_real_host_page_size
);
390 size_t alignments
[] = {1, 512, 1024, 2048, 4096};
392 /* For SCSI generic devices the alignment is not really used.
393 With buffered I/O, we don't have any restrictions. */
394 if (bdrv_is_sg(bs
) || !s
->needs_alignment
) {
395 bs
->bl
.request_alignment
= 1;
400 bs
->bl
.request_alignment
= 0;
402 /* Let's try to use the logical blocksize for the alignment. */
403 if (probe_logical_blocksize(fd
, &bs
->bl
.request_alignment
) < 0) {
404 bs
->bl
.request_alignment
= 0;
409 * The XFS ioctl definitions are shipped in extra packages that might
410 * not always be available. Since we just need the XFS_IOC_DIOINFO ioctl
411 * here, we simply use our own definition instead:
418 if (ioctl(fd
, _IOR('X', 30, struct xfs_dioattr
), &da
) >= 0) {
419 bs
->bl
.request_alignment
= da
.d_miniosz
;
420 /* The kernel returns wrong information for d_mem */
421 /* s->buf_align = da.d_mem; */
426 * If we could not get the sizes so far, we can only guess them. First try
427 * to detect request alignment, since it is more likely to succeed. Then
428 * try to detect buf_align, which cannot be detected in some cases (e.g.
429 * Gluster). If buf_align cannot be detected, we fallback to the value of
433 if (!bs
->bl
.request_alignment
) {
436 buf
= qemu_memalign(max_align
, max_align
);
437 for (i
= 0; i
< ARRAY_SIZE(alignments
); i
++) {
438 align
= alignments
[i
];
439 if (raw_is_io_aligned(fd
, buf
, align
)) {
440 /* Fallback to safe value. */
441 bs
->bl
.request_alignment
= (align
!= 1) ? align
: max_align
;
451 buf
= qemu_memalign(max_align
, 2 * max_align
);
452 for (i
= 0; i
< ARRAY_SIZE(alignments
); i
++) {
453 align
= alignments
[i
];
454 if (raw_is_io_aligned(fd
, buf
+ align
, max_align
)) {
455 /* Fallback to request_alignment. */
456 s
->buf_align
= (align
!= 1) ? align
: bs
->bl
.request_alignment
;
463 if (!s
->buf_align
|| !bs
->bl
.request_alignment
) {
464 error_setg(errp
, "Could not find working O_DIRECT alignment");
465 error_append_hint(errp
, "Try cache.direct=off\n");
469 static int check_hdev_writable(int fd
)
471 #if defined(BLKROGET)
472 /* Linux block devices can be configured "read-only" using blockdev(8).
473 * This is independent of device node permissions and therefore open(2)
474 * with O_RDWR succeeds. Actual writes fail with EPERM.
476 * bdrv_open() is supposed to fail if the disk is read-only. Explicitly
477 * check for read-only block devices so that Linux block devices behave
483 if (fstat(fd
, &st
)) {
487 if (!S_ISBLK(st
.st_mode
)) {
491 if (ioctl(fd
, BLKROGET
, &readonly
) < 0) {
498 #endif /* defined(BLKROGET) */
502 static void raw_parse_flags(int bdrv_flags
, int *open_flags
, bool has_writers
)
504 bool read_write
= false;
505 assert(open_flags
!= NULL
);
507 *open_flags
|= O_BINARY
;
508 *open_flags
&= ~O_ACCMODE
;
510 if (bdrv_flags
& BDRV_O_AUTO_RDONLY
) {
511 read_write
= has_writers
;
512 } else if (bdrv_flags
& BDRV_O_RDWR
) {
517 *open_flags
|= O_RDWR
;
519 *open_flags
|= O_RDONLY
;
522 /* Use O_DSYNC for write-through caching, no flags for write-back caching,
523 * and O_DIRECT for no caching. */
524 if ((bdrv_flags
& BDRV_O_NOCACHE
)) {
525 *open_flags
|= O_DIRECT
;
529 static void raw_parse_filename(const char *filename
, QDict
*options
,
532 bdrv_parse_filename_strip_prefix(filename
, "file:", options
);
535 static QemuOptsList raw_runtime_opts
= {
537 .head
= QTAILQ_HEAD_INITIALIZER(raw_runtime_opts
.head
),
541 .type
= QEMU_OPT_STRING
,
542 .help
= "File name of the image",
546 .type
= QEMU_OPT_STRING
,
547 .help
= "host AIO implementation (threads, native, io_uring)",
550 .name
= "aio-max-batch",
551 .type
= QEMU_OPT_NUMBER
,
552 .help
= "AIO max batch size (0 = auto handled by AIO backend, default: 0)",
556 .type
= QEMU_OPT_STRING
,
557 .help
= "file locking mode (on/off/auto, default: auto)",
560 .name
= "pr-manager",
561 .type
= QEMU_OPT_STRING
,
562 .help
= "id of persistent reservation manager object (default: none)",
564 #if defined(__linux__)
566 .name
= "drop-cache",
567 .type
= QEMU_OPT_BOOL
,
568 .help
= "invalidate page cache during live migration (default: on)",
572 .name
= "x-check-cache-dropped",
573 .type
= QEMU_OPT_BOOL
,
574 .help
= "check that page cache was dropped on live migration (default: off)"
576 { /* end of list */ }
580 static const char *const mutable_opts
[] = { "x-check-cache-dropped", NULL
};
582 static int raw_open_common(BlockDriverState
*bs
, QDict
*options
,
583 int bdrv_flags
, int open_flags
,
584 bool device
, Error
**errp
)
586 BDRVRawState
*s
= bs
->opaque
;
588 Error
*local_err
= NULL
;
589 const char *filename
= NULL
;
591 BlockdevAioOptions aio
, aio_default
;
596 opts
= qemu_opts_create(&raw_runtime_opts
, NULL
, 0, &error_abort
);
597 if (!qemu_opts_absorb_qdict(opts
, options
, errp
)) {
602 filename
= qemu_opt_get(opts
, "filename");
604 ret
= raw_normalize_devicepath(&filename
, errp
);
609 if (bdrv_flags
& BDRV_O_NATIVE_AIO
) {
610 aio_default
= BLOCKDEV_AIO_OPTIONS_NATIVE
;
611 #ifdef CONFIG_LINUX_IO_URING
612 } else if (bdrv_flags
& BDRV_O_IO_URING
) {
613 aio_default
= BLOCKDEV_AIO_OPTIONS_IO_URING
;
616 aio_default
= BLOCKDEV_AIO_OPTIONS_THREADS
;
619 aio
= qapi_enum_parse(&BlockdevAioOptions_lookup
,
620 qemu_opt_get(opts
, "aio"),
621 aio_default
, &local_err
);
623 error_propagate(errp
, local_err
);
628 s
->use_linux_aio
= (aio
== BLOCKDEV_AIO_OPTIONS_NATIVE
);
629 #ifdef CONFIG_LINUX_IO_URING
630 s
->use_linux_io_uring
= (aio
== BLOCKDEV_AIO_OPTIONS_IO_URING
);
633 s
->aio_max_batch
= qemu_opt_get_number(opts
, "aio-max-batch", 0);
635 locking
= qapi_enum_parse(&OnOffAuto_lookup
,
636 qemu_opt_get(opts
, "locking"),
637 ON_OFF_AUTO_AUTO
, &local_err
);
639 error_propagate(errp
, local_err
);
646 if (!qemu_has_ofd_lock()) {
647 warn_report("File lock requested but OFD locking syscall is "
648 "unavailable, falling back to POSIX file locks");
649 error_printf("Due to the implementation, locks can be lost "
653 case ON_OFF_AUTO_OFF
:
656 case ON_OFF_AUTO_AUTO
:
657 s
->use_lock
= qemu_has_ofd_lock();
663 str
= qemu_opt_get(opts
, "pr-manager");
665 s
->pr_mgr
= pr_manager_lookup(str
, &local_err
);
667 error_propagate(errp
, local_err
);
673 s
->drop_cache
= qemu_opt_get_bool(opts
, "drop-cache", true);
674 s
->check_cache_dropped
= qemu_opt_get_bool(opts
, "x-check-cache-dropped",
677 s
->open_flags
= open_flags
;
678 raw_parse_flags(bdrv_flags
, &s
->open_flags
, false);
681 fd
= qemu_open(filename
, s
->open_flags
, errp
);
682 ret
= fd
< 0 ? -errno
: 0;
692 /* Check s->open_flags rather than bdrv_flags due to auto-read-only */
693 if (s
->open_flags
& O_RDWR
) {
694 ret
= check_hdev_writable(s
->fd
);
696 error_setg_errno(errp
, -ret
, "The device is not writable");
702 s
->shared_perm
= BLK_PERM_ALL
;
704 #ifdef CONFIG_LINUX_AIO
705 /* Currently Linux does AIO only for files opened with O_DIRECT */
706 if (s
->use_linux_aio
) {
707 if (!(s
->open_flags
& O_DIRECT
)) {
708 error_setg(errp
, "aio=native was specified, but it requires "
709 "cache.direct=on, which was not specified.");
713 if (!aio_setup_linux_aio(bdrv_get_aio_context(bs
), errp
)) {
714 error_prepend(errp
, "Unable to use native AIO: ");
719 if (s
->use_linux_aio
) {
720 error_setg(errp
, "aio=native was specified, but is not supported "
725 #endif /* !defined(CONFIG_LINUX_AIO) */
727 #ifdef CONFIG_LINUX_IO_URING
728 if (s
->use_linux_io_uring
) {
729 if (!aio_setup_linux_io_uring(bdrv_get_aio_context(bs
), errp
)) {
730 error_prepend(errp
, "Unable to use io_uring: ");
735 if (s
->use_linux_io_uring
) {
736 error_setg(errp
, "aio=io_uring was specified, but is not supported "
741 #endif /* !defined(CONFIG_LINUX_IO_URING) */
743 s
->has_discard
= true;
744 s
->has_write_zeroes
= true;
746 if (fstat(s
->fd
, &st
) < 0) {
748 error_setg_errno(errp
, errno
, "Could not stat file");
753 if (!S_ISREG(st
.st_mode
)) {
754 error_setg(errp
, "'%s' driver requires '%s' to be a regular file",
755 bs
->drv
->format_name
, bs
->filename
);
759 s
->discard_zeroes
= true;
760 s
->has_fallocate
= true;
763 if (!(S_ISCHR(st
.st_mode
) || S_ISBLK(st
.st_mode
))) {
764 error_setg(errp
, "'%s' driver requires '%s' to be either "
765 "a character or block device",
766 bs
->drv
->format_name
, bs
->filename
);
772 if (S_ISBLK(st
.st_mode
)) {
773 #ifdef BLKDISCARDZEROES
775 if (ioctl(s
->fd
, BLKDISCARDZEROES
, &arg
) == 0 && arg
) {
776 s
->discard_zeroes
= true;
780 /* On Linux 3.10, BLKDISCARD leaves stale data in the page cache. Do
781 * not rely on the contents of discarded blocks unless using O_DIRECT.
782 * Same for BLKZEROOUT.
784 if (!(bs
->open_flags
& BDRV_O_NOCACHE
)) {
785 s
->discard_zeroes
= false;
786 s
->has_write_zeroes
= false;
791 if (S_ISCHR(st
.st_mode
)) {
793 * The file is a char device (disk), which on FreeBSD isn't behind
794 * a pager, so force all requests to be aligned. This is needed
795 * so QEMU makes sure all IO operations on the device are aligned
796 * to sector size, or else FreeBSD will reject them with EINVAL.
798 s
->force_alignment
= true;
801 s
->needs_alignment
= raw_needs_alignment(bs
);
803 bs
->supported_zero_flags
= BDRV_REQ_MAY_UNMAP
| BDRV_REQ_NO_FALLBACK
;
804 if (S_ISREG(st
.st_mode
)) {
805 /* When extending regular files, we get zeros from the OS */
806 bs
->supported_truncate_flags
= BDRV_REQ_ZERO_WRITE
;
810 if (ret
< 0 && s
->fd
!= -1) {
813 if (filename
&& (bdrv_flags
& BDRV_O_TEMPORARY
)) {
820 static int raw_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
823 BDRVRawState
*s
= bs
->opaque
;
825 s
->type
= FTYPE_FILE
;
826 return raw_open_common(bs
, options
, flags
, 0, false, errp
);
835 #define PERM_FOREACH(i) \
836 for ((i) = 0; (1ULL << (i)) <= BLK_PERM_ALL; i++)
838 /* Lock bytes indicated by @perm_lock_bits and @shared_perm_lock_bits in the
839 * file; if @unlock == true, also unlock the unneeded bytes.
840 * @shared_perm_lock_bits is the mask of all permissions that are NOT shared.
842 static int raw_apply_lock_bytes(BDRVRawState
*s
, int fd
,
843 uint64_t perm_lock_bits
,
844 uint64_t shared_perm_lock_bits
,
845 bool unlock
, Error
**errp
)
849 uint64_t locked_perm
, locked_shared_perm
;
852 locked_perm
= s
->locked_perm
;
853 locked_shared_perm
= s
->locked_shared_perm
;
856 * We don't have the previous bits, just lock/unlock for each of the
860 locked_perm
= BLK_PERM_ALL
;
861 locked_shared_perm
= BLK_PERM_ALL
;
864 locked_shared_perm
= 0;
869 int off
= RAW_LOCK_PERM_BASE
+ i
;
870 uint64_t bit
= (1ULL << i
);
871 if ((perm_lock_bits
& bit
) && !(locked_perm
& bit
)) {
872 ret
= qemu_lock_fd(fd
, off
, 1, false);
874 raw_lock_error_setg_errno(errp
, -ret
, "Failed to lock byte %d",
878 s
->locked_perm
|= bit
;
880 } else if (unlock
&& (locked_perm
& bit
) && !(perm_lock_bits
& bit
)) {
881 ret
= qemu_unlock_fd(fd
, off
, 1);
883 error_setg_errno(errp
, -ret
, "Failed to unlock byte %d", off
);
886 s
->locked_perm
&= ~bit
;
891 int off
= RAW_LOCK_SHARED_BASE
+ i
;
892 uint64_t bit
= (1ULL << i
);
893 if ((shared_perm_lock_bits
& bit
) && !(locked_shared_perm
& bit
)) {
894 ret
= qemu_lock_fd(fd
, off
, 1, false);
896 raw_lock_error_setg_errno(errp
, -ret
, "Failed to lock byte %d",
900 s
->locked_shared_perm
|= bit
;
902 } else if (unlock
&& (locked_shared_perm
& bit
) &&
903 !(shared_perm_lock_bits
& bit
)) {
904 ret
= qemu_unlock_fd(fd
, off
, 1);
906 error_setg_errno(errp
, -ret
, "Failed to unlock byte %d", off
);
909 s
->locked_shared_perm
&= ~bit
;
916 /* Check "unshared" bytes implied by @perm and ~@shared_perm in the file. */
917 static int raw_check_lock_bytes(int fd
, uint64_t perm
, uint64_t shared_perm
,
924 int off
= RAW_LOCK_SHARED_BASE
+ i
;
925 uint64_t p
= 1ULL << i
;
927 ret
= qemu_lock_fd_test(fd
, off
, 1, true);
929 char *perm_name
= bdrv_perm_names(p
);
931 raw_lock_error_setg_errno(errp
, -ret
,
932 "Failed to get \"%s\" lock",
940 int off
= RAW_LOCK_PERM_BASE
+ i
;
941 uint64_t p
= 1ULL << i
;
942 if (!(shared_perm
& p
)) {
943 ret
= qemu_lock_fd_test(fd
, off
, 1, true);
945 char *perm_name
= bdrv_perm_names(p
);
947 raw_lock_error_setg_errno(errp
, -ret
,
948 "Failed to get shared \"%s\" lock",
958 static int raw_handle_perm_lock(BlockDriverState
*bs
,
960 uint64_t new_perm
, uint64_t new_shared
,
963 BDRVRawState
*s
= bs
->opaque
;
965 Error
*local_err
= NULL
;
971 if (bdrv_get_flags(bs
) & BDRV_O_INACTIVE
) {
977 if ((s
->perm
| new_perm
) == s
->perm
&&
978 (s
->shared_perm
& new_shared
) == s
->shared_perm
)
981 * We are going to unlock bytes, it should not fail. If it fail due
982 * to some fs-dependent permission-unrelated reasons (which occurs
983 * sometimes on NFS and leads to abort in bdrv_replace_child) we
984 * can't prevent such errors by any check here. And we ignore them
985 * anyway in ABORT and COMMIT.
989 ret
= raw_apply_lock_bytes(s
, s
->fd
, s
->perm
| new_perm
,
990 ~s
->shared_perm
| ~new_shared
,
993 ret
= raw_check_lock_bytes(s
->fd
, new_perm
, new_shared
, errp
);
997 error_append_hint(errp
,
998 "Is another process using the image [%s]?\n",
1001 /* fall through to unlock bytes. */
1003 raw_apply_lock_bytes(s
, s
->fd
, s
->perm
, ~s
->shared_perm
,
1006 /* Theoretically the above call only unlocks bytes and it cannot
1007 * fail. Something weird happened, report it.
1009 warn_report_err(local_err
);
1013 raw_apply_lock_bytes(s
, s
->fd
, new_perm
, ~new_shared
,
1016 /* Theoretically the above call only unlocks bytes and it cannot
1017 * fail. Something weird happened, report it.
1019 warn_report_err(local_err
);
1026 static int raw_reconfigure_getfd(BlockDriverState
*bs
, int flags
,
1027 int *open_flags
, uint64_t perm
, bool force_dup
,
1030 BDRVRawState
*s
= bs
->opaque
;
1033 bool has_writers
= perm
&
1034 (BLK_PERM_WRITE
| BLK_PERM_WRITE_UNCHANGED
| BLK_PERM_RESIZE
);
1035 int fcntl_flags
= O_APPEND
| O_NONBLOCK
;
1037 fcntl_flags
|= O_NOATIME
;
1041 if (s
->type
== FTYPE_CD
) {
1042 *open_flags
|= O_NONBLOCK
;
1045 raw_parse_flags(flags
, open_flags
, has_writers
);
1048 /* Not all operating systems have O_ASYNC, and those that don't
1049 * will not let us track the state into rs->open_flags (typically
1050 * you achieve the same effect with an ioctl, for example I_SETSIG
1051 * on Solaris). But we do not use O_ASYNC, so that's fine.
1053 assert((s
->open_flags
& O_ASYNC
) == 0);
1056 if (!force_dup
&& *open_flags
== s
->open_flags
) {
1057 /* We're lucky, the existing fd is fine */
1061 if ((*open_flags
& ~fcntl_flags
) == (s
->open_flags
& ~fcntl_flags
)) {
1062 /* dup the original fd */
1063 fd
= qemu_dup(s
->fd
);
1065 ret
= fcntl_setfl(fd
, *open_flags
);
1073 /* If we cannot use fcntl, or fcntl failed, fall back to qemu_open() */
1075 const char *normalized_filename
= bs
->filename
;
1076 ret
= raw_normalize_devicepath(&normalized_filename
, errp
);
1078 fd
= qemu_open(normalized_filename
, *open_flags
, errp
);
1085 if (fd
!= -1 && (*open_flags
& O_RDWR
)) {
1086 ret
= check_hdev_writable(fd
);
1089 error_setg_errno(errp
, -ret
, "The device is not writable");
1097 static int raw_reopen_prepare(BDRVReopenState
*state
,
1098 BlockReopenQueue
*queue
, Error
**errp
)
1101 BDRVRawReopenState
*rs
;
1105 assert(state
!= NULL
);
1106 assert(state
->bs
!= NULL
);
1108 s
= state
->bs
->opaque
;
1110 state
->opaque
= g_new0(BDRVRawReopenState
, 1);
1113 /* Handle options changes */
1114 opts
= qemu_opts_create(&raw_runtime_opts
, NULL
, 0, &error_abort
);
1115 if (!qemu_opts_absorb_qdict(opts
, state
->options
, errp
)) {
1120 rs
->drop_cache
= qemu_opt_get_bool_del(opts
, "drop-cache", true);
1121 rs
->check_cache_dropped
=
1122 qemu_opt_get_bool_del(opts
, "x-check-cache-dropped", false);
1124 /* This driver's reopen function doesn't currently allow changing
1125 * other options, so let's put them back in the original QDict and
1126 * bdrv_reopen_prepare() will detect changes and complain. */
1127 qemu_opts_to_qdict(opts
, state
->options
);
1130 * As part of reopen prepare we also want to create new fd by
1131 * raw_reconfigure_getfd(). But it wants updated "perm", when in
1132 * bdrv_reopen_multiple() .bdrv_reopen_prepare() callback called prior to
1133 * permission update. Happily, permission update is always a part (a seprate
1134 * stage) of bdrv_reopen_multiple() so we can rely on this fact and
1135 * reconfigure fd in raw_check_perm().
1138 s
->reopen_state
= state
;
1142 qemu_opts_del(opts
);
1146 static void raw_reopen_commit(BDRVReopenState
*state
)
1148 BDRVRawReopenState
*rs
= state
->opaque
;
1149 BDRVRawState
*s
= state
->bs
->opaque
;
1151 s
->drop_cache
= rs
->drop_cache
;
1152 s
->check_cache_dropped
= rs
->check_cache_dropped
;
1153 s
->open_flags
= rs
->open_flags
;
1154 g_free(state
->opaque
);
1155 state
->opaque
= NULL
;
1157 assert(s
->reopen_state
== state
);
1158 s
->reopen_state
= NULL
;
1162 static void raw_reopen_abort(BDRVReopenState
*state
)
1164 BDRVRawReopenState
*rs
= state
->opaque
;
1165 BDRVRawState
*s
= state
->bs
->opaque
;
1167 /* nothing to do if NULL, we didn't get far enough */
1172 g_free(state
->opaque
);
1173 state
->opaque
= NULL
;
1175 assert(s
->reopen_state
== state
);
1176 s
->reopen_state
= NULL
;
1179 static int hdev_get_max_hw_transfer(int fd
, struct stat
*st
)
1182 if (S_ISBLK(st
->st_mode
)) {
1183 unsigned short max_sectors
= 0;
1184 if (ioctl(fd
, BLKSECTGET
, &max_sectors
) == 0) {
1185 return max_sectors
* 512;
1189 if (ioctl(fd
, BLKSECTGET
, &max_bytes
) == 0) {
1199 static int hdev_get_max_segments(int fd
, struct stat
*st
)
1204 char *sysfspath
= NULL
;
1209 if (S_ISCHR(st
->st_mode
)) {
1210 if (ioctl(fd
, SG_GET_SG_TABLESIZE
, &ret
) == 0) {
1216 if (!S_ISBLK(st
->st_mode
)) {
1220 sysfspath
= g_strdup_printf("/sys/dev/block/%u:%u/queue/max_segments",
1221 major(st
->st_rdev
), minor(st
->st_rdev
));
1222 sysfd
= open(sysfspath
, O_RDONLY
);
1228 ret
= read(sysfd
, buf
, sizeof(buf
) - 1);
1229 } while (ret
== -1 && errno
== EINTR
);
1233 } else if (ret
== 0) {
1238 /* The file is ended with '\n', pass 'end' to accept that. */
1239 ret
= qemu_strtol(buf
, &end
, 10, &max_segments
);
1240 if (ret
== 0 && end
&& *end
== '\n') {
1255 static void raw_refresh_limits(BlockDriverState
*bs
, Error
**errp
)
1257 BDRVRawState
*s
= bs
->opaque
;
1260 s
->needs_alignment
= raw_needs_alignment(bs
);
1261 raw_probe_alignment(bs
, s
->fd
, errp
);
1263 bs
->bl
.min_mem_alignment
= s
->buf_align
;
1264 bs
->bl
.opt_mem_alignment
= MAX(s
->buf_align
, qemu_real_host_page_size
);
1267 * Maximum transfers are best effort, so it is okay to ignore any
1268 * errors. That said, based on the man page errors in fstat would be
1269 * very much unexpected; the only possible case seems to be ENOMEM.
1271 if (fstat(s
->fd
, &st
)) {
1275 #if defined(__APPLE__) && (__MACH__)
1278 if (!fstatfs(s
->fd
, &buf
)) {
1279 bs
->bl
.opt_transfer
= buf
.f_iosize
;
1280 bs
->bl
.pdiscard_alignment
= buf
.f_bsize
;
1284 if (bs
->sg
|| S_ISBLK(st
.st_mode
)) {
1285 int ret
= hdev_get_max_hw_transfer(s
->fd
, &st
);
1287 if (ret
> 0 && ret
<= BDRV_REQUEST_MAX_BYTES
) {
1288 bs
->bl
.max_hw_transfer
= ret
;
1291 ret
= hdev_get_max_segments(s
->fd
, &st
);
1293 bs
->bl
.max_hw_iov
= ret
;
1298 static int check_for_dasd(int fd
)
1301 struct dasd_information2_t info
= {0};
1303 return ioctl(fd
, BIODASDINFO2
, &info
);
1310 * Try to get @bs's logical and physical block size.
1311 * On success, store them in @bsz and return zero.
1312 * On failure, return negative errno.
1314 static int hdev_probe_blocksizes(BlockDriverState
*bs
, BlockSizes
*bsz
)
1316 BDRVRawState
*s
= bs
->opaque
;
1319 /* If DASD, get blocksizes */
1320 if (check_for_dasd(s
->fd
) < 0) {
1323 ret
= probe_logical_blocksize(s
->fd
, &bsz
->log
);
1327 return probe_physical_blocksize(s
->fd
, &bsz
->phys
);
1331 * Try to get @bs's geometry: cyls, heads, sectors.
1332 * On success, store them in @geo and return 0.
1333 * On failure return -errno.
1334 * (Allows block driver to assign default geometry values that guest sees)
1337 static int hdev_probe_geometry(BlockDriverState
*bs
, HDGeometry
*geo
)
1339 BDRVRawState
*s
= bs
->opaque
;
1340 struct hd_geometry ioctl_geo
= {0};
1342 /* If DASD, get its geometry */
1343 if (check_for_dasd(s
->fd
) < 0) {
1346 if (ioctl(s
->fd
, HDIO_GETGEO
, &ioctl_geo
) < 0) {
1349 /* HDIO_GETGEO may return success even though geo contains zeros
1350 (e.g. certain multipath setups) */
1351 if (!ioctl_geo
.heads
|| !ioctl_geo
.sectors
|| !ioctl_geo
.cylinders
) {
1354 /* Do not return a geometry for partition */
1355 if (ioctl_geo
.start
!= 0) {
1358 geo
->heads
= ioctl_geo
.heads
;
1359 geo
->sectors
= ioctl_geo
.sectors
;
1360 geo
->cylinders
= ioctl_geo
.cylinders
;
1364 #else /* __linux__ */
1365 static int hdev_probe_geometry(BlockDriverState
*bs
, HDGeometry
*geo
)
1371 #if defined(__linux__)
1372 static int handle_aiocb_ioctl(void *opaque
)
1374 RawPosixAIOData
*aiocb
= opaque
;
1378 ret
= ioctl(aiocb
->aio_fildes
, aiocb
->ioctl
.cmd
, aiocb
->ioctl
.buf
);
1379 } while (ret
== -1 && errno
== EINTR
);
1388 static int handle_aiocb_flush(void *opaque
)
1390 RawPosixAIOData
*aiocb
= opaque
;
1391 BDRVRawState
*s
= aiocb
->bs
->opaque
;
1394 if (s
->page_cache_inconsistent
) {
1395 return -s
->page_cache_inconsistent
;
1398 ret
= qemu_fdatasync(aiocb
->aio_fildes
);
1400 trace_file_flush_fdatasync_failed(errno
);
1402 /* There is no clear definition of the semantics of a failing fsync(),
1403 * so we may have to assume the worst. The sad truth is that this
1404 * assumption is correct for Linux. Some pages are now probably marked
1405 * clean in the page cache even though they are inconsistent with the
1406 * on-disk contents. The next fdatasync() call would succeed, but no
1407 * further writeback attempt will be made. We can't get back to a state
1408 * in which we know what is on disk (we would have to rewrite
1409 * everything that was touched since the last fdatasync() at least), so
1410 * make bdrv_flush() fail permanently. Given that the behaviour isn't
1411 * really defined, I have little hope that other OSes are doing better.
1413 * Obviously, this doesn't affect O_DIRECT, which bypasses the page
1415 if ((s
->open_flags
& O_DIRECT
) == 0) {
1416 s
->page_cache_inconsistent
= errno
;
1423 #ifdef CONFIG_PREADV
1425 static bool preadv_present
= true;
1428 qemu_preadv(int fd
, const struct iovec
*iov
, int nr_iov
, off_t offset
)
1430 return preadv(fd
, iov
, nr_iov
, offset
);
1434 qemu_pwritev(int fd
, const struct iovec
*iov
, int nr_iov
, off_t offset
)
1436 return pwritev(fd
, iov
, nr_iov
, offset
);
1441 static bool preadv_present
= false;
1444 qemu_preadv(int fd
, const struct iovec
*iov
, int nr_iov
, off_t offset
)
1450 qemu_pwritev(int fd
, const struct iovec
*iov
, int nr_iov
, off_t offset
)
1457 static ssize_t
handle_aiocb_rw_vector(RawPosixAIOData
*aiocb
)
1462 if (aiocb
->aio_type
& QEMU_AIO_WRITE
)
1463 len
= qemu_pwritev(aiocb
->aio_fildes
,
1468 len
= qemu_preadv(aiocb
->aio_fildes
,
1472 } while (len
== -1 && errno
== EINTR
);
1481 * Read/writes the data to/from a given linear buffer.
1483 * Returns the number of bytes handles or -errno in case of an error. Short
1484 * reads are only returned if the end of the file is reached.
1486 static ssize_t
handle_aiocb_rw_linear(RawPosixAIOData
*aiocb
, char *buf
)
1491 while (offset
< aiocb
->aio_nbytes
) {
1492 if (aiocb
->aio_type
& QEMU_AIO_WRITE
) {
1493 len
= pwrite(aiocb
->aio_fildes
,
1494 (const char *)buf
+ offset
,
1495 aiocb
->aio_nbytes
- offset
,
1496 aiocb
->aio_offset
+ offset
);
1498 len
= pread(aiocb
->aio_fildes
,
1500 aiocb
->aio_nbytes
- offset
,
1501 aiocb
->aio_offset
+ offset
);
1503 if (len
== -1 && errno
== EINTR
) {
1505 } else if (len
== -1 && errno
== EINVAL
&&
1506 (aiocb
->bs
->open_flags
& BDRV_O_NOCACHE
) &&
1507 !(aiocb
->aio_type
& QEMU_AIO_WRITE
) &&
1509 /* O_DIRECT pread() may fail with EINVAL when offset is unaligned
1510 * after a short read. Assume that O_DIRECT short reads only occur
1511 * at EOF. Therefore this is a short read, not an I/O error.
1514 } else if (len
== -1) {
1517 } else if (len
== 0) {
1526 static int handle_aiocb_rw(void *opaque
)
1528 RawPosixAIOData
*aiocb
= opaque
;
1532 if (!(aiocb
->aio_type
& QEMU_AIO_MISALIGNED
)) {
1534 * If there is just a single buffer, and it is properly aligned
1535 * we can just use plain pread/pwrite without any problems.
1537 if (aiocb
->io
.niov
== 1) {
1538 nbytes
= handle_aiocb_rw_linear(aiocb
, aiocb
->io
.iov
->iov_base
);
1542 * We have more than one iovec, and all are properly aligned.
1544 * Try preadv/pwritev first and fall back to linearizing the
1545 * buffer if it's not supported.
1547 if (preadv_present
) {
1548 nbytes
= handle_aiocb_rw_vector(aiocb
);
1549 if (nbytes
== aiocb
->aio_nbytes
||
1550 (nbytes
< 0 && nbytes
!= -ENOSYS
)) {
1553 preadv_present
= false;
1557 * XXX(hch): short read/write. no easy way to handle the reminder
1558 * using these interfaces. For now retry using plain
1564 * Ok, we have to do it the hard way, copy all segments into
1565 * a single aligned buffer.
1567 buf
= qemu_try_blockalign(aiocb
->bs
, aiocb
->aio_nbytes
);
1573 if (aiocb
->aio_type
& QEMU_AIO_WRITE
) {
1577 for (i
= 0; i
< aiocb
->io
.niov
; ++i
) {
1578 memcpy(p
, aiocb
->io
.iov
[i
].iov_base
, aiocb
->io
.iov
[i
].iov_len
);
1579 p
+= aiocb
->io
.iov
[i
].iov_len
;
1581 assert(p
- buf
== aiocb
->aio_nbytes
);
1584 nbytes
= handle_aiocb_rw_linear(aiocb
, buf
);
1585 if (!(aiocb
->aio_type
& QEMU_AIO_WRITE
)) {
1587 size_t count
= aiocb
->aio_nbytes
, copy
;
1590 for (i
= 0; i
< aiocb
->io
.niov
&& count
; ++i
) {
1592 if (copy
> aiocb
->io
.iov
[i
].iov_len
) {
1593 copy
= aiocb
->io
.iov
[i
].iov_len
;
1595 memcpy(aiocb
->io
.iov
[i
].iov_base
, p
, copy
);
1596 assert(count
>= copy
);
1605 if (nbytes
== aiocb
->aio_nbytes
) {
1607 } else if (nbytes
>= 0 && nbytes
< aiocb
->aio_nbytes
) {
1608 if (aiocb
->aio_type
& QEMU_AIO_WRITE
) {
1611 iov_memset(aiocb
->io
.iov
, aiocb
->io
.niov
, nbytes
,
1612 0, aiocb
->aio_nbytes
- nbytes
);
1621 #if defined(CONFIG_FALLOCATE) || defined(BLKZEROOUT) || defined(BLKDISCARD)
1622 static int translate_err(int err
)
1624 if (err
== -ENODEV
|| err
== -ENOSYS
|| err
== -EOPNOTSUPP
||
1632 #ifdef CONFIG_FALLOCATE
1633 static int do_fallocate(int fd
, int mode
, off_t offset
, off_t len
)
1636 if (fallocate(fd
, mode
, offset
, len
) == 0) {
1639 } while (errno
== EINTR
);
1640 return translate_err(-errno
);
1644 static ssize_t
handle_aiocb_write_zeroes_block(RawPosixAIOData
*aiocb
)
1647 BDRVRawState
*s
= aiocb
->bs
->opaque
;
1649 if (!s
->has_write_zeroes
) {
1654 /* The BLKZEROOUT implementation in the kernel doesn't set
1655 * BLKDEV_ZERO_NOFALLBACK, so we can't call this if we have to avoid slow
1657 if (!(aiocb
->aio_type
& QEMU_AIO_NO_FALLBACK
)) {
1659 uint64_t range
[2] = { aiocb
->aio_offset
, aiocb
->aio_nbytes
};
1660 if (ioctl(aiocb
->aio_fildes
, BLKZEROOUT
, range
) == 0) {
1663 } while (errno
== EINTR
);
1665 ret
= translate_err(-errno
);
1666 if (ret
== -ENOTSUP
) {
1667 s
->has_write_zeroes
= false;
1675 static int handle_aiocb_write_zeroes(void *opaque
)
1677 RawPosixAIOData
*aiocb
= opaque
;
1678 #ifdef CONFIG_FALLOCATE
1679 BDRVRawState
*s
= aiocb
->bs
->opaque
;
1683 if (aiocb
->aio_type
& QEMU_AIO_BLKDEV
) {
1684 return handle_aiocb_write_zeroes_block(aiocb
);
1687 #ifdef CONFIG_FALLOCATE_ZERO_RANGE
1688 if (s
->has_write_zeroes
) {
1689 int ret
= do_fallocate(s
->fd
, FALLOC_FL_ZERO_RANGE
,
1690 aiocb
->aio_offset
, aiocb
->aio_nbytes
);
1691 if (ret
== -ENOTSUP
) {
1692 s
->has_write_zeroes
= false;
1693 } else if (ret
== 0 || ret
!= -EINVAL
) {
1697 * Note: Some file systems do not like unaligned byte ranges, and
1698 * return EINVAL in such a case, though they should not do it according
1699 * to the man-page of fallocate(). Thus we simply ignore this return
1700 * value and try the other fallbacks instead.
1705 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1706 if (s
->has_discard
&& s
->has_fallocate
) {
1707 int ret
= do_fallocate(s
->fd
,
1708 FALLOC_FL_PUNCH_HOLE
| FALLOC_FL_KEEP_SIZE
,
1709 aiocb
->aio_offset
, aiocb
->aio_nbytes
);
1711 ret
= do_fallocate(s
->fd
, 0, aiocb
->aio_offset
, aiocb
->aio_nbytes
);
1712 if (ret
== 0 || ret
!= -ENOTSUP
) {
1715 s
->has_fallocate
= false;
1716 } else if (ret
== -EINVAL
) {
1718 * Some file systems like older versions of GPFS do not like un-
1719 * aligned byte ranges, and return EINVAL in such a case, though
1720 * they should not do it according to the man-page of fallocate().
1721 * Warn about the bad filesystem and try the final fallback instead.
1723 warn_report_once("Your file system is misbehaving: "
1724 "fallocate(FALLOC_FL_PUNCH_HOLE) returned EINVAL. "
1725 "Please report this bug to your file system "
1727 } else if (ret
!= -ENOTSUP
) {
1730 s
->has_discard
= false;
1735 #ifdef CONFIG_FALLOCATE
1736 /* Last resort: we are trying to extend the file with zeroed data. This
1737 * can be done via fallocate(fd, 0) */
1738 len
= bdrv_getlength(aiocb
->bs
);
1739 if (s
->has_fallocate
&& len
>= 0 && aiocb
->aio_offset
>= len
) {
1740 int ret
= do_fallocate(s
->fd
, 0, aiocb
->aio_offset
, aiocb
->aio_nbytes
);
1741 if (ret
== 0 || ret
!= -ENOTSUP
) {
1744 s
->has_fallocate
= false;
1751 static int handle_aiocb_write_zeroes_unmap(void *opaque
)
1753 RawPosixAIOData
*aiocb
= opaque
;
1754 BDRVRawState
*s G_GNUC_UNUSED
= aiocb
->bs
->opaque
;
1756 /* First try to write zeros and unmap at the same time */
1758 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1759 int ret
= do_fallocate(s
->fd
, FALLOC_FL_PUNCH_HOLE
| FALLOC_FL_KEEP_SIZE
,
1760 aiocb
->aio_offset
, aiocb
->aio_nbytes
);
1771 /* If we couldn't manage to unmap while guaranteed that the area reads as
1772 * all-zero afterwards, just write zeroes without unmapping */
1773 return handle_aiocb_write_zeroes(aiocb
);
1776 #ifndef HAVE_COPY_FILE_RANGE
1777 static off_t
copy_file_range(int in_fd
, off_t
*in_off
, int out_fd
,
1778 off_t
*out_off
, size_t len
, unsigned int flags
)
1780 #ifdef __NR_copy_file_range
1781 return syscall(__NR_copy_file_range
, in_fd
, in_off
, out_fd
,
1782 out_off
, len
, flags
);
1790 static int handle_aiocb_copy_range(void *opaque
)
1792 RawPosixAIOData
*aiocb
= opaque
;
1793 uint64_t bytes
= aiocb
->aio_nbytes
;
1794 off_t in_off
= aiocb
->aio_offset
;
1795 off_t out_off
= aiocb
->copy_range
.aio_offset2
;
1798 ssize_t ret
= copy_file_range(aiocb
->aio_fildes
, &in_off
,
1799 aiocb
->copy_range
.aio_fd2
, &out_off
,
1801 trace_file_copy_file_range(aiocb
->bs
, aiocb
->aio_fildes
, in_off
,
1802 aiocb
->copy_range
.aio_fd2
, out_off
, bytes
,
1805 /* No progress (e.g. when beyond EOF), let the caller fall back to
1824 static int handle_aiocb_discard(void *opaque
)
1826 RawPosixAIOData
*aiocb
= opaque
;
1828 BDRVRawState
*s
= aiocb
->bs
->opaque
;
1830 if (!s
->has_discard
) {
1834 if (aiocb
->aio_type
& QEMU_AIO_BLKDEV
) {
1837 uint64_t range
[2] = { aiocb
->aio_offset
, aiocb
->aio_nbytes
};
1838 if (ioctl(aiocb
->aio_fildes
, BLKDISCARD
, range
) == 0) {
1841 } while (errno
== EINTR
);
1843 ret
= translate_err(-errno
);
1846 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1847 ret
= do_fallocate(s
->fd
, FALLOC_FL_PUNCH_HOLE
| FALLOC_FL_KEEP_SIZE
,
1848 aiocb
->aio_offset
, aiocb
->aio_nbytes
);
1849 ret
= translate_err(ret
);
1850 #elif defined(__APPLE__) && (__MACH__)
1851 fpunchhole_t fpunchhole
;
1852 fpunchhole
.fp_flags
= 0;
1853 fpunchhole
.reserved
= 0;
1854 fpunchhole
.fp_offset
= aiocb
->aio_offset
;
1855 fpunchhole
.fp_length
= aiocb
->aio_nbytes
;
1856 if (fcntl(s
->fd
, F_PUNCHHOLE
, &fpunchhole
) == -1) {
1857 ret
= errno
== ENODEV
? -ENOTSUP
: -errno
;
1864 if (ret
== -ENOTSUP
) {
1865 s
->has_discard
= false;
1871 * Help alignment probing by allocating the first block.
1873 * When reading with direct I/O from unallocated area on Gluster backed by XFS,
1874 * reading succeeds regardless of request length. In this case we fallback to
1875 * safe alignment which is not optimal. Allocating the first block avoids this
1878 * fd may be opened with O_DIRECT, but we don't know the buffer alignment or
1879 * request alignment, so we use safe values.
1881 * Returns: 0 on success, -errno on failure. Since this is an optimization,
1882 * caller may ignore failures.
1884 static int allocate_first_block(int fd
, size_t max_size
)
1886 size_t write_size
= (max_size
< MAX_BLOCKSIZE
)
1889 size_t max_align
= MAX(MAX_BLOCKSIZE
, qemu_real_host_page_size
);
1894 buf
= qemu_memalign(max_align
, write_size
);
1895 memset(buf
, 0, write_size
);
1898 n
= pwrite(fd
, buf
, write_size
, 0);
1899 } while (n
== -1 && errno
== EINTR
);
1901 ret
= (n
== -1) ? -errno
: 0;
1907 static int handle_aiocb_truncate(void *opaque
)
1909 RawPosixAIOData
*aiocb
= opaque
;
1911 int64_t current_length
= 0;
1914 int fd
= aiocb
->aio_fildes
;
1915 int64_t offset
= aiocb
->aio_offset
;
1916 PreallocMode prealloc
= aiocb
->truncate
.prealloc
;
1917 Error
**errp
= aiocb
->truncate
.errp
;
1919 if (fstat(fd
, &st
) < 0) {
1921 error_setg_errno(errp
, -result
, "Could not stat file");
1925 current_length
= st
.st_size
;
1926 if (current_length
> offset
&& prealloc
!= PREALLOC_MODE_OFF
) {
1927 error_setg(errp
, "Cannot use preallocation for shrinking files");
1932 #ifdef CONFIG_POSIX_FALLOCATE
1933 case PREALLOC_MODE_FALLOC
:
1935 * Truncating before posix_fallocate() makes it about twice slower on
1936 * file systems that do not support fallocate(), trying to check if a
1937 * block is allocated before allocating it, so don't do that here.
1939 if (offset
!= current_length
) {
1940 result
= -posix_fallocate(fd
, current_length
,
1941 offset
- current_length
);
1943 /* posix_fallocate() doesn't set errno. */
1944 error_setg_errno(errp
, -result
,
1945 "Could not preallocate new data");
1946 } else if (current_length
== 0) {
1948 * posix_fallocate() uses fallocate() if the filesystem
1949 * supports it, or fallback to manually writing zeroes. If
1950 * fallocate() was used, unaligned reads from the fallocated
1951 * area in raw_probe_alignment() will succeed, hence we need to
1952 * allocate the first block.
1954 * Optimize future alignment probing; ignore failures.
1956 allocate_first_block(fd
, offset
);
1963 case PREALLOC_MODE_FULL
:
1965 int64_t num
= 0, left
= offset
- current_length
;
1969 * Knowing the final size from the beginning could allow the file
1970 * system driver to do less allocations and possibly avoid
1971 * fragmentation of the file.
1973 if (ftruncate(fd
, offset
) != 0) {
1975 error_setg_errno(errp
, -result
, "Could not resize file");
1979 buf
= g_malloc0(65536);
1981 seek_result
= lseek(fd
, current_length
, SEEK_SET
);
1982 if (seek_result
< 0) {
1984 error_setg_errno(errp
, -result
,
1985 "Failed to seek to the old end of file");
1990 num
= MIN(left
, 65536);
1991 result
= write(fd
, buf
, num
);
1993 if (errno
== EINTR
) {
1997 error_setg_errno(errp
, -result
,
1998 "Could not write zeros for preallocation");
2007 error_setg_errno(errp
, -result
,
2008 "Could not flush file to disk");
2014 case PREALLOC_MODE_OFF
:
2015 if (ftruncate(fd
, offset
) != 0) {
2017 error_setg_errno(errp
, -result
, "Could not resize file");
2018 } else if (current_length
== 0 && offset
> current_length
) {
2019 /* Optimize future alignment probing; ignore failures. */
2020 allocate_first_block(fd
, offset
);
2025 error_setg(errp
, "Unsupported preallocation mode: %s",
2026 PreallocMode_str(prealloc
));
2032 if (ftruncate(fd
, current_length
) < 0) {
2033 error_report("Failed to restore old file length: %s",
2042 static int coroutine_fn
raw_thread_pool_submit(BlockDriverState
*bs
,
2043 ThreadPoolFunc func
, void *arg
)
2045 /* @bs can be NULL, bdrv_get_aio_context() returns the main context then */
2046 ThreadPool
*pool
= aio_get_thread_pool(bdrv_get_aio_context(bs
));
2047 return thread_pool_submit_co(pool
, func
, arg
);
2050 static int coroutine_fn
raw_co_prw(BlockDriverState
*bs
, uint64_t offset
,
2051 uint64_t bytes
, QEMUIOVector
*qiov
, int type
)
2053 BDRVRawState
*s
= bs
->opaque
;
2054 RawPosixAIOData acb
;
2056 if (fd_open(bs
) < 0)
2060 * When using O_DIRECT, the request must be aligned to be able to use
2061 * either libaio or io_uring interface. If not fail back to regular thread
2062 * pool read/write code which emulates this for us if we
2063 * set QEMU_AIO_MISALIGNED.
2065 if (s
->needs_alignment
&& !bdrv_qiov_is_aligned(bs
, qiov
)) {
2066 type
|= QEMU_AIO_MISALIGNED
;
2067 #ifdef CONFIG_LINUX_IO_URING
2068 } else if (s
->use_linux_io_uring
) {
2069 LuringState
*aio
= aio_get_linux_io_uring(bdrv_get_aio_context(bs
));
2070 assert(qiov
->size
== bytes
);
2071 return luring_co_submit(bs
, aio
, s
->fd
, offset
, qiov
, type
);
2073 #ifdef CONFIG_LINUX_AIO
2074 } else if (s
->use_linux_aio
) {
2075 LinuxAioState
*aio
= aio_get_linux_aio(bdrv_get_aio_context(bs
));
2076 assert(qiov
->size
== bytes
);
2077 return laio_co_submit(bs
, aio
, s
->fd
, offset
, qiov
, type
,
2082 acb
= (RawPosixAIOData
) {
2084 .aio_fildes
= s
->fd
,
2086 .aio_offset
= offset
,
2087 .aio_nbytes
= bytes
,
2094 assert(qiov
->size
== bytes
);
2095 return raw_thread_pool_submit(bs
, handle_aiocb_rw
, &acb
);
2098 static int coroutine_fn
raw_co_preadv(BlockDriverState
*bs
, int64_t offset
,
2099 int64_t bytes
, QEMUIOVector
*qiov
,
2100 BdrvRequestFlags flags
)
2102 return raw_co_prw(bs
, offset
, bytes
, qiov
, QEMU_AIO_READ
);
2105 static int coroutine_fn
raw_co_pwritev(BlockDriverState
*bs
, int64_t offset
,
2106 int64_t bytes
, QEMUIOVector
*qiov
,
2107 BdrvRequestFlags flags
)
2110 return raw_co_prw(bs
, offset
, bytes
, qiov
, QEMU_AIO_WRITE
);
2113 static void raw_aio_plug(BlockDriverState
*bs
)
2115 BDRVRawState
__attribute__((unused
)) *s
= bs
->opaque
;
2116 #ifdef CONFIG_LINUX_AIO
2117 if (s
->use_linux_aio
) {
2118 LinuxAioState
*aio
= aio_get_linux_aio(bdrv_get_aio_context(bs
));
2119 laio_io_plug(bs
, aio
);
2122 #ifdef CONFIG_LINUX_IO_URING
2123 if (s
->use_linux_io_uring
) {
2124 LuringState
*aio
= aio_get_linux_io_uring(bdrv_get_aio_context(bs
));
2125 luring_io_plug(bs
, aio
);
2130 static void raw_aio_unplug(BlockDriverState
*bs
)
2132 BDRVRawState
__attribute__((unused
)) *s
= bs
->opaque
;
2133 #ifdef CONFIG_LINUX_AIO
2134 if (s
->use_linux_aio
) {
2135 LinuxAioState
*aio
= aio_get_linux_aio(bdrv_get_aio_context(bs
));
2136 laio_io_unplug(bs
, aio
, s
->aio_max_batch
);
2139 #ifdef CONFIG_LINUX_IO_URING
2140 if (s
->use_linux_io_uring
) {
2141 LuringState
*aio
= aio_get_linux_io_uring(bdrv_get_aio_context(bs
));
2142 luring_io_unplug(bs
, aio
);
2147 static int raw_co_flush_to_disk(BlockDriverState
*bs
)
2149 BDRVRawState
*s
= bs
->opaque
;
2150 RawPosixAIOData acb
;
2158 acb
= (RawPosixAIOData
) {
2160 .aio_fildes
= s
->fd
,
2161 .aio_type
= QEMU_AIO_FLUSH
,
2164 #ifdef CONFIG_LINUX_IO_URING
2165 if (s
->use_linux_io_uring
) {
2166 LuringState
*aio
= aio_get_linux_io_uring(bdrv_get_aio_context(bs
));
2167 return luring_co_submit(bs
, aio
, s
->fd
, 0, NULL
, QEMU_AIO_FLUSH
);
2170 return raw_thread_pool_submit(bs
, handle_aiocb_flush
, &acb
);
2173 static void raw_aio_attach_aio_context(BlockDriverState
*bs
,
2174 AioContext
*new_context
)
2176 BDRVRawState
__attribute__((unused
)) *s
= bs
->opaque
;
2177 #ifdef CONFIG_LINUX_AIO
2178 if (s
->use_linux_aio
) {
2179 Error
*local_err
= NULL
;
2180 if (!aio_setup_linux_aio(new_context
, &local_err
)) {
2181 error_reportf_err(local_err
, "Unable to use native AIO, "
2182 "falling back to thread pool: ");
2183 s
->use_linux_aio
= false;
2187 #ifdef CONFIG_LINUX_IO_URING
2188 if (s
->use_linux_io_uring
) {
2189 Error
*local_err
= NULL
;
2190 if (!aio_setup_linux_io_uring(new_context
, &local_err
)) {
2191 error_reportf_err(local_err
, "Unable to use linux io_uring, "
2192 "falling back to thread pool: ");
2193 s
->use_linux_io_uring
= false;
2199 static void raw_close(BlockDriverState
*bs
)
2201 BDRVRawState
*s
= bs
->opaque
;
2210 * Truncates the given regular file @fd to @offset and, when growing, fills the
2211 * new space according to @prealloc.
2213 * Returns: 0 on success, -errno on failure.
2215 static int coroutine_fn
2216 raw_regular_truncate(BlockDriverState
*bs
, int fd
, int64_t offset
,
2217 PreallocMode prealloc
, Error
**errp
)
2219 RawPosixAIOData acb
;
2221 acb
= (RawPosixAIOData
) {
2224 .aio_type
= QEMU_AIO_TRUNCATE
,
2225 .aio_offset
= offset
,
2227 .prealloc
= prealloc
,
2232 return raw_thread_pool_submit(bs
, handle_aiocb_truncate
, &acb
);
2235 static int coroutine_fn
raw_co_truncate(BlockDriverState
*bs
, int64_t offset
,
2236 bool exact
, PreallocMode prealloc
,
2237 BdrvRequestFlags flags
, Error
**errp
)
2239 BDRVRawState
*s
= bs
->opaque
;
2243 if (fstat(s
->fd
, &st
)) {
2245 error_setg_errno(errp
, -ret
, "Failed to fstat() the file");
2249 if (S_ISREG(st
.st_mode
)) {
2250 /* Always resizes to the exact @offset */
2251 return raw_regular_truncate(bs
, s
->fd
, offset
, prealloc
, errp
);
2254 if (prealloc
!= PREALLOC_MODE_OFF
) {
2255 error_setg(errp
, "Preallocation mode '%s' unsupported for this "
2256 "non-regular file", PreallocMode_str(prealloc
));
2260 if (S_ISCHR(st
.st_mode
) || S_ISBLK(st
.st_mode
)) {
2261 int64_t cur_length
= raw_getlength(bs
);
2263 if (offset
!= cur_length
&& exact
) {
2264 error_setg(errp
, "Cannot resize device files");
2266 } else if (offset
> cur_length
) {
2267 error_setg(errp
, "Cannot grow device files");
2271 error_setg(errp
, "Resizing this file is not supported");
2279 static int64_t raw_getlength(BlockDriverState
*bs
)
2281 BDRVRawState
*s
= bs
->opaque
;
2287 if (S_ISCHR(st
.st_mode
) || S_ISBLK(st
.st_mode
)) {
2288 struct disklabel dl
;
2290 if (ioctl(fd
, DIOCGDINFO
, &dl
))
2292 return (uint64_t)dl
.d_secsize
*
2293 dl
.d_partitions
[DISKPART(st
.st_rdev
)].p_size
;
2297 #elif defined(__NetBSD__)
2298 static int64_t raw_getlength(BlockDriverState
*bs
)
2300 BDRVRawState
*s
= bs
->opaque
;
2306 if (S_ISCHR(st
.st_mode
) || S_ISBLK(st
.st_mode
)) {
2307 struct dkwedge_info dkw
;
2309 if (ioctl(fd
, DIOCGWEDGEINFO
, &dkw
) != -1) {
2310 return dkw
.dkw_size
* 512;
2312 struct disklabel dl
;
2314 if (ioctl(fd
, DIOCGDINFO
, &dl
))
2316 return (uint64_t)dl
.d_secsize
*
2317 dl
.d_partitions
[DISKPART(st
.st_rdev
)].p_size
;
2322 #elif defined(__sun__)
2323 static int64_t raw_getlength(BlockDriverState
*bs
)
2325 BDRVRawState
*s
= bs
->opaque
;
2326 struct dk_minfo minfo
;
2336 * Use the DKIOCGMEDIAINFO ioctl to read the size.
2338 ret
= ioctl(s
->fd
, DKIOCGMEDIAINFO
, &minfo
);
2340 return minfo
.dki_lbsize
* minfo
.dki_capacity
;
2344 * There are reports that lseek on some devices fails, but
2345 * irc discussion said that contingency on contingency was overkill.
2347 size
= lseek(s
->fd
, 0, SEEK_END
);
2353 #elif defined(CONFIG_BSD)
2354 static int64_t raw_getlength(BlockDriverState
*bs
)
2356 BDRVRawState
*s
= bs
->opaque
;
2360 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2369 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2372 if (!fstat(fd
, &sb
) && (S_IFCHR
& sb
.st_mode
)) {
2374 #ifdef DIOCGMEDIASIZE
2375 if (ioctl(fd
, DIOCGMEDIASIZE
, (off_t
*)&size
)) {
2382 if (ioctl(fd
, DIOCGPART
, &pi
) == 0) {
2383 size
= pi
.media_size
;
2387 #if defined(DKIOCGETBLOCKCOUNT) && defined(DKIOCGETBLOCKSIZE)
2389 uint64_t sectors
= 0;
2390 uint32_t sector_size
= 0;
2392 if (ioctl(fd
, DKIOCGETBLOCKCOUNT
, §ors
) == 0
2393 && ioctl(fd
, DKIOCGETBLOCKSIZE
, §or_size
) == 0) {
2394 size
= sectors
* sector_size
;
2399 size
= lseek(fd
, 0LL, SEEK_END
);
2404 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
2407 /* XXX FreeBSD acd returns UINT_MAX sectors for an empty drive */
2408 if (size
== 2048LL * (unsigned)-1)
2410 /* XXX no disc? maybe we need to reopen... */
2411 if (size
<= 0 && !reopened
&& cdrom_reopen(bs
) >= 0) {
2418 size
= lseek(fd
, 0, SEEK_END
);
2426 static int64_t raw_getlength(BlockDriverState
*bs
)
2428 BDRVRawState
*s
= bs
->opaque
;
2437 size
= lseek(s
->fd
, 0, SEEK_END
);
2445 static int64_t raw_get_allocated_file_size(BlockDriverState
*bs
)
2448 BDRVRawState
*s
= bs
->opaque
;
2450 if (fstat(s
->fd
, &st
) < 0) {
2453 return (int64_t)st
.st_blocks
* 512;
2456 static int coroutine_fn
2457 raw_co_create(BlockdevCreateOptions
*options
, Error
**errp
)
2459 BlockdevCreateOptionsFile
*file_opts
;
2460 Error
*local_err
= NULL
;
2462 uint64_t perm
, shared
;
2465 /* Validate options and set default values */
2466 assert(options
->driver
== BLOCKDEV_DRIVER_FILE
);
2467 file_opts
= &options
->u
.file
;
2469 if (!file_opts
->has_nocow
) {
2470 file_opts
->nocow
= false;
2472 if (!file_opts
->has_preallocation
) {
2473 file_opts
->preallocation
= PREALLOC_MODE_OFF
;
2475 if (!file_opts
->has_extent_size_hint
) {
2476 file_opts
->extent_size_hint
= 1 * MiB
;
2478 if (file_opts
->extent_size_hint
> UINT32_MAX
) {
2480 error_setg(errp
, "Extent size hint is too large");
2485 fd
= qemu_create(file_opts
->filename
, O_RDWR
| O_BINARY
, 0644, errp
);
2491 /* Take permissions: We want to discard everything, so we need
2492 * BLK_PERM_WRITE; and truncation to the desired size requires
2494 * On the other hand, we cannot share the RESIZE permission
2495 * because we promise that after this function, the file has the
2496 * size given in the options. If someone else were to resize it
2497 * concurrently, we could not guarantee that.
2498 * Note that after this function, we can no longer guarantee that
2499 * the file is not touched by a third party, so it may be resized
2501 perm
= BLK_PERM_WRITE
| BLK_PERM_RESIZE
;
2502 shared
= BLK_PERM_ALL
& ~BLK_PERM_RESIZE
;
2504 /* Step one: Take locks */
2505 result
= raw_apply_lock_bytes(NULL
, fd
, perm
, ~shared
, false, errp
);
2510 /* Step two: Check that nobody else has taken conflicting locks */
2511 result
= raw_check_lock_bytes(fd
, perm
, shared
, errp
);
2513 error_append_hint(errp
,
2514 "Is another process using the image [%s]?\n",
2515 file_opts
->filename
);
2519 /* Clear the file by truncating it to 0 */
2520 result
= raw_regular_truncate(NULL
, fd
, 0, PREALLOC_MODE_OFF
, errp
);
2525 if (file_opts
->nocow
) {
2527 /* Set NOCOW flag to solve performance issue on fs like btrfs.
2528 * This is an optimisation. The FS_IOC_SETFLAGS ioctl return value
2529 * will be ignored since any failure of this operation should not
2530 * block the left work.
2533 if (ioctl(fd
, FS_IOC_GETFLAGS
, &attr
) == 0) {
2534 attr
|= FS_NOCOW_FL
;
2535 ioctl(fd
, FS_IOC_SETFLAGS
, &attr
);
2539 #ifdef FS_IOC_FSSETXATTR
2541 * Try to set the extent size hint. Failure is not fatal, and a warning is
2542 * only printed if the option was explicitly specified.
2545 struct fsxattr attr
;
2546 result
= ioctl(fd
, FS_IOC_FSGETXATTR
, &attr
);
2548 attr
.fsx_xflags
|= FS_XFLAG_EXTSIZE
;
2549 attr
.fsx_extsize
= file_opts
->extent_size_hint
;
2550 result
= ioctl(fd
, FS_IOC_FSSETXATTR
, &attr
);
2552 if (result
< 0 && file_opts
->has_extent_size_hint
&&
2553 file_opts
->extent_size_hint
)
2555 warn_report("Failed to set extent size hint: %s",
2561 /* Resize and potentially preallocate the file to the desired
2563 result
= raw_regular_truncate(NULL
, fd
, file_opts
->size
,
2564 file_opts
->preallocation
, errp
);
2570 raw_apply_lock_bytes(NULL
, fd
, 0, 0, true, &local_err
);
2572 /* The above call should not fail, and if it does, that does
2573 * not mean the whole creation operation has failed. So
2574 * report it the user for their convenience, but do not report
2575 * it to the caller. */
2576 warn_report_err(local_err
);
2580 if (qemu_close(fd
) != 0 && result
== 0) {
2582 error_setg_errno(errp
, -result
, "Could not close the new file");
2588 static int coroutine_fn
raw_co_create_opts(BlockDriver
*drv
,
2589 const char *filename
,
2593 BlockdevCreateOptions options
;
2594 int64_t total_size
= 0;
2595 int64_t extent_size_hint
= 0;
2596 bool has_extent_size_hint
= false;
2598 PreallocMode prealloc
;
2600 Error
*local_err
= NULL
;
2602 /* Skip file: protocol prefix */
2603 strstart(filename
, "file:", &filename
);
2605 /* Read out options */
2606 total_size
= ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
2608 if (qemu_opt_get(opts
, BLOCK_OPT_EXTENT_SIZE_HINT
)) {
2609 has_extent_size_hint
= true;
2611 qemu_opt_get_size_del(opts
, BLOCK_OPT_EXTENT_SIZE_HINT
, -1);
2613 nocow
= qemu_opt_get_bool(opts
, BLOCK_OPT_NOCOW
, false);
2614 buf
= qemu_opt_get_del(opts
, BLOCK_OPT_PREALLOC
);
2615 prealloc
= qapi_enum_parse(&PreallocMode_lookup
, buf
,
2616 PREALLOC_MODE_OFF
, &local_err
);
2619 error_propagate(errp
, local_err
);
2623 options
= (BlockdevCreateOptions
) {
2624 .driver
= BLOCKDEV_DRIVER_FILE
,
2626 .filename
= (char *) filename
,
2628 .has_preallocation
= true,
2629 .preallocation
= prealloc
,
2632 .has_extent_size_hint
= has_extent_size_hint
,
2633 .extent_size_hint
= extent_size_hint
,
2636 return raw_co_create(&options
, errp
);
2639 static int coroutine_fn
raw_co_delete_file(BlockDriverState
*bs
,
2645 if (!(stat(bs
->filename
, &st
) == 0) || !S_ISREG(st
.st_mode
)) {
2646 error_setg_errno(errp
, ENOENT
, "%s is not a regular file",
2651 ret
= unlink(bs
->filename
);
2654 error_setg_errno(errp
, -ret
, "Error when deleting file %s",
2662 * Find allocation range in @bs around offset @start.
2663 * May change underlying file descriptor's file offset.
2664 * If @start is not in a hole, store @start in @data, and the
2665 * beginning of the next hole in @hole, and return 0.
2666 * If @start is in a non-trailing hole, store @start in @hole and the
2667 * beginning of the next non-hole in @data, and return 0.
2668 * If @start is in a trailing hole or beyond EOF, return -ENXIO.
2669 * If we can't find out, return a negative errno other than -ENXIO.
2671 static int find_allocation(BlockDriverState
*bs
, off_t start
,
2672 off_t
*data
, off_t
*hole
)
2674 #if defined SEEK_HOLE && defined SEEK_DATA
2675 BDRVRawState
*s
= bs
->opaque
;
2680 * D1. offs == start: start is in data
2681 * D2. offs > start: start is in a hole, next data at offs
2682 * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
2683 * or start is beyond EOF
2684 * If the latter happens, the file has been truncated behind
2685 * our back since we opened it. All bets are off then.
2686 * Treating like a trailing hole is simplest.
2687 * D4. offs < 0, errno != ENXIO: we learned nothing
2689 offs
= lseek(s
->fd
, start
, SEEK_DATA
);
2691 return -errno
; /* D3 or D4 */
2695 /* This is not a valid return by lseek(). We are safe to just return
2696 * -EIO in this case, and we'll treat it like D4. */
2701 /* D2: in hole, next data at offs */
2707 /* D1: in data, end not yet known */
2711 * H1. offs == start: start is in a hole
2712 * If this happens here, a hole has been dug behind our back
2713 * since the previous lseek().
2714 * H2. offs > start: either start is in data, next hole at offs,
2715 * or start is in trailing hole, EOF at offs
2716 * Linux treats trailing holes like any other hole: offs ==
2717 * start. Solaris seeks to EOF instead: offs > start (blech).
2718 * If that happens here, a hole has been dug behind our back
2719 * since the previous lseek().
2720 * H3. offs < 0, errno = ENXIO: start is beyond EOF
2721 * If this happens, the file has been truncated behind our
2722 * back since we opened it. Treat it like a trailing hole.
2723 * H4. offs < 0, errno != ENXIO: we learned nothing
2724 * Pretend we know nothing at all, i.e. "forget" about D1.
2726 offs
= lseek(s
->fd
, start
, SEEK_HOLE
);
2728 return -errno
; /* D1 and (H3 or H4) */
2732 /* This is not a valid return by lseek(). We are safe to just return
2733 * -EIO in this case, and we'll treat it like H4. */
2739 * D1 and H2: either in data, next hole at offs, or it was in
2740 * data but is now in a trailing hole. In the latter case,
2741 * all bets are off. Treating it as if it there was data all
2742 * the way to EOF is safe, so simply do that.
2757 * Returns the allocation status of the specified offset.
2759 * The block layer guarantees 'offset' and 'bytes' are within bounds.
2761 * 'pnum' is set to the number of bytes (including and immediately following
2762 * the specified offset) that are known to be in the same
2763 * allocated/unallocated state.
2765 * 'bytes' is a soft cap for 'pnum'. If the information is free, 'pnum' may
2768 static int coroutine_fn
raw_co_block_status(BlockDriverState
*bs
,
2771 int64_t bytes
, int64_t *pnum
,
2773 BlockDriverState
**file
)
2775 off_t data
= 0, hole
= 0;
2778 assert(QEMU_IS_ALIGNED(offset
| bytes
, bs
->bl
.request_alignment
));
2789 return BDRV_BLOCK_DATA
| BDRV_BLOCK_OFFSET_VALID
;
2792 ret
= find_allocation(bs
, offset
, &data
, &hole
);
2793 if (ret
== -ENXIO
) {
2796 ret
= BDRV_BLOCK_ZERO
;
2797 } else if (ret
< 0) {
2798 /* No info available, so pretend there are no holes */
2800 ret
= BDRV_BLOCK_DATA
;
2801 } else if (data
== offset
) {
2802 /* On a data extent, compute bytes to the end of the extent,
2803 * possibly including a partial sector at EOF. */
2804 *pnum
= hole
- offset
;
2807 * We are not allowed to return partial sectors, though, so
2808 * round up if necessary.
2810 if (!QEMU_IS_ALIGNED(*pnum
, bs
->bl
.request_alignment
)) {
2811 int64_t file_length
= raw_getlength(bs
);
2812 if (file_length
> 0) {
2813 /* Ignore errors, this is just a safeguard */
2814 assert(hole
== file_length
);
2816 *pnum
= ROUND_UP(*pnum
, bs
->bl
.request_alignment
);
2819 ret
= BDRV_BLOCK_DATA
;
2821 /* On a hole, compute bytes to the beginning of the next extent. */
2822 assert(hole
== offset
);
2823 *pnum
= data
- offset
;
2824 ret
= BDRV_BLOCK_ZERO
;
2828 return ret
| BDRV_BLOCK_OFFSET_VALID
;
2831 #if defined(__linux__)
2832 /* Verify that the file is not in the page cache */
2833 static void check_cache_dropped(BlockDriverState
*bs
, Error
**errp
)
2835 const size_t window_size
= 128 * 1024 * 1024;
2836 BDRVRawState
*s
= bs
->opaque
;
2837 void *window
= NULL
;
2844 /* mincore(2) page status information requires 1 byte per page */
2845 page_size
= sysconf(_SC_PAGESIZE
);
2846 vec
= g_malloc(DIV_ROUND_UP(window_size
, page_size
));
2848 end
= raw_getlength(bs
);
2850 for (offset
= 0; offset
< end
; offset
+= window_size
) {
2857 /* Unmap previous window if size has changed */
2858 new_length
= MIN(end
- offset
, window_size
);
2859 if (new_length
!= length
) {
2860 munmap(window
, length
);
2865 new_window
= mmap(window
, new_length
, PROT_NONE
, MAP_PRIVATE
,
2867 if (new_window
== MAP_FAILED
) {
2868 error_setg_errno(errp
, errno
, "mmap failed");
2872 window
= new_window
;
2873 length
= new_length
;
2875 ret
= mincore(window
, length
, vec
);
2877 error_setg_errno(errp
, errno
, "mincore failed");
2881 vec_end
= DIV_ROUND_UP(length
, page_size
);
2882 for (i
= 0; i
< vec_end
; i
++) {
2888 error_setg(errp
, "page cache still in use!");
2894 munmap(window
, length
);
2899 #endif /* __linux__ */
2901 static void coroutine_fn
raw_co_invalidate_cache(BlockDriverState
*bs
,
2904 BDRVRawState
*s
= bs
->opaque
;
2909 error_setg_errno(errp
, -ret
, "The file descriptor is not open");
2913 if (!s
->drop_cache
) {
2917 if (s
->open_flags
& O_DIRECT
) {
2918 return; /* No host kernel page cache */
2921 #if defined(__linux__)
2922 /* This sets the scene for the next syscall... */
2923 ret
= bdrv_co_flush(bs
);
2925 error_setg_errno(errp
, -ret
, "flush failed");
2929 /* Linux does not invalidate pages that are dirty, locked, or mmapped by a
2930 * process. These limitations are okay because we just fsynced the file,
2931 * we don't use mmap, and the file should not be in use by other processes.
2933 ret
= posix_fadvise(s
->fd
, 0, 0, POSIX_FADV_DONTNEED
);
2934 if (ret
!= 0) { /* the return value is a positive errno */
2935 error_setg_errno(errp
, ret
, "fadvise failed");
2939 if (s
->check_cache_dropped
) {
2940 check_cache_dropped(bs
, errp
);
2942 #else /* __linux__ */
2943 /* Do nothing. Live migration to a remote host with cache.direct=off is
2944 * unsupported on other host operating systems. Cache consistency issues
2945 * may occur but no error is reported here, partly because that's the
2946 * historical behavior and partly because it's hard to differentiate valid
2947 * configurations that should not cause errors.
2949 #endif /* !__linux__ */
2952 static void raw_account_discard(BDRVRawState
*s
, uint64_t nbytes
, int ret
)
2955 s
->stats
.discard_nb_failed
++;
2957 s
->stats
.discard_nb_ok
++;
2958 s
->stats
.discard_bytes_ok
+= nbytes
;
2962 static coroutine_fn
int
2963 raw_do_pdiscard(BlockDriverState
*bs
, int64_t offset
, int64_t bytes
,
2966 BDRVRawState
*s
= bs
->opaque
;
2967 RawPosixAIOData acb
;
2970 acb
= (RawPosixAIOData
) {
2972 .aio_fildes
= s
->fd
,
2973 .aio_type
= QEMU_AIO_DISCARD
,
2974 .aio_offset
= offset
,
2975 .aio_nbytes
= bytes
,
2979 acb
.aio_type
|= QEMU_AIO_BLKDEV
;
2982 ret
= raw_thread_pool_submit(bs
, handle_aiocb_discard
, &acb
);
2983 raw_account_discard(s
, bytes
, ret
);
2987 static coroutine_fn
int
2988 raw_co_pdiscard(BlockDriverState
*bs
, int64_t offset
, int64_t bytes
)
2990 return raw_do_pdiscard(bs
, offset
, bytes
, false);
2993 static int coroutine_fn
2994 raw_do_pwrite_zeroes(BlockDriverState
*bs
, int64_t offset
, int64_t bytes
,
2995 BdrvRequestFlags flags
, bool blkdev
)
2997 BDRVRawState
*s
= bs
->opaque
;
2998 RawPosixAIOData acb
;
2999 ThreadPoolFunc
*handler
;
3001 #ifdef CONFIG_FALLOCATE
3002 if (offset
+ bytes
> bs
->total_sectors
* BDRV_SECTOR_SIZE
) {
3003 BdrvTrackedRequest
*req
;
3006 * This is a workaround for a bug in the Linux XFS driver,
3007 * where writes submitted through the AIO interface will be
3008 * discarded if they happen beyond a concurrently running
3009 * fallocate() that increases the file length (i.e., both the
3010 * write and the fallocate() happen beyond the EOF).
3012 * To work around it, we extend the tracked request for this
3013 * zero write until INT64_MAX (effectively infinity), and mark
3014 * it as serializing.
3016 * We have to enable this workaround for all filesystems and
3017 * AIO modes (not just XFS with aio=native), because for
3018 * remote filesystems we do not know the host configuration.
3021 req
= bdrv_co_get_self_request(bs
);
3023 assert(req
->type
== BDRV_TRACKED_WRITE
);
3024 assert(req
->offset
<= offset
);
3025 assert(req
->offset
+ req
->bytes
>= offset
+ bytes
);
3027 req
->bytes
= BDRV_MAX_LENGTH
- req
->offset
;
3029 bdrv_check_request(req
->offset
, req
->bytes
, &error_abort
);
3031 bdrv_make_request_serialising(req
, bs
->bl
.request_alignment
);
3035 acb
= (RawPosixAIOData
) {
3037 .aio_fildes
= s
->fd
,
3038 .aio_type
= QEMU_AIO_WRITE_ZEROES
,
3039 .aio_offset
= offset
,
3040 .aio_nbytes
= bytes
,
3044 acb
.aio_type
|= QEMU_AIO_BLKDEV
;
3046 if (flags
& BDRV_REQ_NO_FALLBACK
) {
3047 acb
.aio_type
|= QEMU_AIO_NO_FALLBACK
;
3050 if (flags
& BDRV_REQ_MAY_UNMAP
) {
3051 acb
.aio_type
|= QEMU_AIO_DISCARD
;
3052 handler
= handle_aiocb_write_zeroes_unmap
;
3054 handler
= handle_aiocb_write_zeroes
;
3057 return raw_thread_pool_submit(bs
, handler
, &acb
);
3060 static int coroutine_fn
raw_co_pwrite_zeroes(
3061 BlockDriverState
*bs
, int64_t offset
,
3062 int64_t bytes
, BdrvRequestFlags flags
)
3064 return raw_do_pwrite_zeroes(bs
, offset
, bytes
, flags
, false);
3067 static int raw_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
3072 static BlockStatsSpecificFile
get_blockstats_specific_file(BlockDriverState
*bs
)
3074 BDRVRawState
*s
= bs
->opaque
;
3075 return (BlockStatsSpecificFile
) {
3076 .discard_nb_ok
= s
->stats
.discard_nb_ok
,
3077 .discard_nb_failed
= s
->stats
.discard_nb_failed
,
3078 .discard_bytes_ok
= s
->stats
.discard_bytes_ok
,
3082 static BlockStatsSpecific
*raw_get_specific_stats(BlockDriverState
*bs
)
3084 BlockStatsSpecific
*stats
= g_new(BlockStatsSpecific
, 1);
3086 stats
->driver
= BLOCKDEV_DRIVER_FILE
;
3087 stats
->u
.file
= get_blockstats_specific_file(bs
);
3092 #if defined(HAVE_HOST_BLOCK_DEVICE)
3093 static BlockStatsSpecific
*hdev_get_specific_stats(BlockDriverState
*bs
)
3095 BlockStatsSpecific
*stats
= g_new(BlockStatsSpecific
, 1);
3097 stats
->driver
= BLOCKDEV_DRIVER_HOST_DEVICE
;
3098 stats
->u
.host_device
= get_blockstats_specific_file(bs
);
3102 #endif /* HAVE_HOST_BLOCK_DEVICE */
3104 static QemuOptsList raw_create_opts
= {
3105 .name
= "raw-create-opts",
3106 .head
= QTAILQ_HEAD_INITIALIZER(raw_create_opts
.head
),
3109 .name
= BLOCK_OPT_SIZE
,
3110 .type
= QEMU_OPT_SIZE
,
3111 .help
= "Virtual disk size"
3114 .name
= BLOCK_OPT_NOCOW
,
3115 .type
= QEMU_OPT_BOOL
,
3116 .help
= "Turn off copy-on-write (valid only on btrfs)"
3119 .name
= BLOCK_OPT_PREALLOC
,
3120 .type
= QEMU_OPT_STRING
,
3121 .help
= "Preallocation mode (allowed values: off"
3122 #ifdef CONFIG_POSIX_FALLOCATE
3128 .name
= BLOCK_OPT_EXTENT_SIZE_HINT
,
3129 .type
= QEMU_OPT_SIZE
,
3130 .help
= "Extent size hint for the image file, 0 to disable"
3132 { /* end of list */ }
3136 static int raw_check_perm(BlockDriverState
*bs
, uint64_t perm
, uint64_t shared
,
3139 BDRVRawState
*s
= bs
->opaque
;
3140 int input_flags
= s
->reopen_state
? s
->reopen_state
->flags
: bs
->open_flags
;
3144 /* We may need a new fd if auto-read-only switches the mode */
3145 ret
= raw_reconfigure_getfd(bs
, input_flags
, &open_flags
, perm
,
3149 } else if (ret
!= s
->fd
) {
3150 Error
*local_err
= NULL
;
3153 * Fail already check_perm() if we can't get a working O_DIRECT
3154 * alignment with the new fd.
3156 raw_probe_alignment(bs
, ret
, &local_err
);
3158 error_propagate(errp
, local_err
);
3162 s
->perm_change_fd
= ret
;
3163 s
->perm_change_flags
= open_flags
;
3166 /* Prepare permissions on old fd to avoid conflicts between old and new,
3167 * but keep everything locked that new will need. */
3168 ret
= raw_handle_perm_lock(bs
, RAW_PL_PREPARE
, perm
, shared
, errp
);
3173 /* Copy locks to the new fd */
3174 if (s
->perm_change_fd
&& s
->use_lock
) {
3175 ret
= raw_apply_lock_bytes(NULL
, s
->perm_change_fd
, perm
, ~shared
,
3178 raw_handle_perm_lock(bs
, RAW_PL_ABORT
, 0, 0, NULL
);
3185 if (s
->perm_change_fd
) {
3186 qemu_close(s
->perm_change_fd
);
3188 s
->perm_change_fd
= 0;
3192 static void raw_set_perm(BlockDriverState
*bs
, uint64_t perm
, uint64_t shared
)
3194 BDRVRawState
*s
= bs
->opaque
;
3196 /* For reopen, we have already switched to the new fd (.bdrv_set_perm is
3197 * called after .bdrv_reopen_commit) */
3198 if (s
->perm_change_fd
&& s
->fd
!= s
->perm_change_fd
) {
3200 s
->fd
= s
->perm_change_fd
;
3201 s
->open_flags
= s
->perm_change_flags
;
3203 s
->perm_change_fd
= 0;
3205 raw_handle_perm_lock(bs
, RAW_PL_COMMIT
, perm
, shared
, NULL
);
3207 s
->shared_perm
= shared
;
3210 static void raw_abort_perm_update(BlockDriverState
*bs
)
3212 BDRVRawState
*s
= bs
->opaque
;
3214 /* For reopen, .bdrv_reopen_abort is called afterwards and will close
3215 * the file descriptor. */
3216 if (s
->perm_change_fd
) {
3217 qemu_close(s
->perm_change_fd
);
3219 s
->perm_change_fd
= 0;
3221 raw_handle_perm_lock(bs
, RAW_PL_ABORT
, 0, 0, NULL
);
3224 static int coroutine_fn
raw_co_copy_range_from(
3225 BlockDriverState
*bs
, BdrvChild
*src
, int64_t src_offset
,
3226 BdrvChild
*dst
, int64_t dst_offset
, int64_t bytes
,
3227 BdrvRequestFlags read_flags
, BdrvRequestFlags write_flags
)
3229 return bdrv_co_copy_range_to(src
, src_offset
, dst
, dst_offset
, bytes
,
3230 read_flags
, write_flags
);
3233 static int coroutine_fn
raw_co_copy_range_to(BlockDriverState
*bs
,
3239 BdrvRequestFlags read_flags
,
3240 BdrvRequestFlags write_flags
)
3242 RawPosixAIOData acb
;
3243 BDRVRawState
*s
= bs
->opaque
;
3244 BDRVRawState
*src_s
;
3246 assert(dst
->bs
== bs
);
3247 if (src
->bs
->drv
->bdrv_co_copy_range_to
!= raw_co_copy_range_to
) {
3251 src_s
= src
->bs
->opaque
;
3252 if (fd_open(src
->bs
) < 0 || fd_open(dst
->bs
) < 0) {
3256 acb
= (RawPosixAIOData
) {
3258 .aio_type
= QEMU_AIO_COPY_RANGE
,
3259 .aio_fildes
= src_s
->fd
,
3260 .aio_offset
= src_offset
,
3261 .aio_nbytes
= bytes
,
3264 .aio_offset2
= dst_offset
,
3268 return raw_thread_pool_submit(bs
, handle_aiocb_copy_range
, &acb
);
3271 BlockDriver bdrv_file
= {
3272 .format_name
= "file",
3273 .protocol_name
= "file",
3274 .instance_size
= sizeof(BDRVRawState
),
3275 .bdrv_needs_filename
= true,
3276 .bdrv_probe
= NULL
, /* no probe for protocols */
3277 .bdrv_parse_filename
= raw_parse_filename
,
3278 .bdrv_file_open
= raw_open
,
3279 .bdrv_reopen_prepare
= raw_reopen_prepare
,
3280 .bdrv_reopen_commit
= raw_reopen_commit
,
3281 .bdrv_reopen_abort
= raw_reopen_abort
,
3282 .bdrv_close
= raw_close
,
3283 .bdrv_co_create
= raw_co_create
,
3284 .bdrv_co_create_opts
= raw_co_create_opts
,
3285 .bdrv_has_zero_init
= bdrv_has_zero_init_1
,
3286 .bdrv_co_block_status
= raw_co_block_status
,
3287 .bdrv_co_invalidate_cache
= raw_co_invalidate_cache
,
3288 .bdrv_co_pwrite_zeroes
= raw_co_pwrite_zeroes
,
3289 .bdrv_co_delete_file
= raw_co_delete_file
,
3291 .bdrv_co_preadv
= raw_co_preadv
,
3292 .bdrv_co_pwritev
= raw_co_pwritev
,
3293 .bdrv_co_flush_to_disk
= raw_co_flush_to_disk
,
3294 .bdrv_co_pdiscard
= raw_co_pdiscard
,
3295 .bdrv_co_copy_range_from
= raw_co_copy_range_from
,
3296 .bdrv_co_copy_range_to
= raw_co_copy_range_to
,
3297 .bdrv_refresh_limits
= raw_refresh_limits
,
3298 .bdrv_io_plug
= raw_aio_plug
,
3299 .bdrv_io_unplug
= raw_aio_unplug
,
3300 .bdrv_attach_aio_context
= raw_aio_attach_aio_context
,
3302 .bdrv_co_truncate
= raw_co_truncate
,
3303 .bdrv_getlength
= raw_getlength
,
3304 .bdrv_get_info
= raw_get_info
,
3305 .bdrv_get_allocated_file_size
3306 = raw_get_allocated_file_size
,
3307 .bdrv_get_specific_stats
= raw_get_specific_stats
,
3308 .bdrv_check_perm
= raw_check_perm
,
3309 .bdrv_set_perm
= raw_set_perm
,
3310 .bdrv_abort_perm_update
= raw_abort_perm_update
,
3311 .create_opts
= &raw_create_opts
,
3312 .mutable_opts
= mutable_opts
,
3315 /***********************************************/
3318 #if defined(HAVE_HOST_BLOCK_DEVICE)
3320 #if defined(__APPLE__) && defined(__MACH__)
3321 static kern_return_t
GetBSDPath(io_iterator_t mediaIterator
, char *bsdPath
,
3322 CFIndex maxPathSize
, int flags
);
3324 #if !defined(MAC_OS_VERSION_12_0) \
3325 || (MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_VERSION_12_0)
3326 #define IOMainPort IOMasterPort
3329 static char *FindEjectableOpticalMedia(io_iterator_t
*mediaIterator
)
3331 kern_return_t kernResult
= KERN_FAILURE
;
3332 mach_port_t mainPort
;
3333 CFMutableDictionaryRef classesToMatch
;
3334 const char *matching_array
[] = {kIODVDMediaClass
, kIOCDMediaClass
};
3335 char *mediaType
= NULL
;
3337 kernResult
= IOMainPort(MACH_PORT_NULL
, &mainPort
);
3338 if ( KERN_SUCCESS
!= kernResult
) {
3339 printf("IOMainPort returned %d\n", kernResult
);
3343 for (index
= 0; index
< ARRAY_SIZE(matching_array
); index
++) {
3344 classesToMatch
= IOServiceMatching(matching_array
[index
]);
3345 if (classesToMatch
== NULL
) {
3346 error_report("IOServiceMatching returned NULL for %s",
3347 matching_array
[index
]);
3350 CFDictionarySetValue(classesToMatch
, CFSTR(kIOMediaEjectableKey
),
3352 kernResult
= IOServiceGetMatchingServices(mainPort
, classesToMatch
,
3354 if (kernResult
!= KERN_SUCCESS
) {
3355 error_report("Note: IOServiceGetMatchingServices returned %d",
3360 /* If a match was found, leave the loop */
3361 if (*mediaIterator
!= 0) {
3362 trace_file_FindEjectableOpticalMedia(matching_array
[index
]);
3363 mediaType
= g_strdup(matching_array
[index
]);
3370 kern_return_t
GetBSDPath(io_iterator_t mediaIterator
, char *bsdPath
,
3371 CFIndex maxPathSize
, int flags
)
3373 io_object_t nextMedia
;
3374 kern_return_t kernResult
= KERN_FAILURE
;
3376 nextMedia
= IOIteratorNext( mediaIterator
);
3379 CFTypeRef bsdPathAsCFString
;
3380 bsdPathAsCFString
= IORegistryEntryCreateCFProperty( nextMedia
, CFSTR( kIOBSDNameKey
), kCFAllocatorDefault
, 0 );
3381 if ( bsdPathAsCFString
) {
3382 size_t devPathLength
;
3383 strcpy( bsdPath
, _PATH_DEV
);
3384 if (flags
& BDRV_O_NOCACHE
) {
3385 strcat(bsdPath
, "r");
3387 devPathLength
= strlen( bsdPath
);
3388 if ( CFStringGetCString( bsdPathAsCFString
, bsdPath
+ devPathLength
, maxPathSize
- devPathLength
, kCFStringEncodingASCII
) ) {
3389 kernResult
= KERN_SUCCESS
;
3391 CFRelease( bsdPathAsCFString
);
3393 IOObjectRelease( nextMedia
);
3399 /* Sets up a real cdrom for use in QEMU */
3400 static bool setup_cdrom(char *bsd_path
, Error
**errp
)
3402 int index
, num_of_test_partitions
= 2, fd
;
3403 char test_partition
[MAXPATHLEN
];
3404 bool partition_found
= false;
3406 /* look for a working partition */
3407 for (index
= 0; index
< num_of_test_partitions
; index
++) {
3408 snprintf(test_partition
, sizeof(test_partition
), "%ss%d", bsd_path
,
3410 fd
= qemu_open(test_partition
, O_RDONLY
| O_BINARY
| O_LARGEFILE
, NULL
);
3412 partition_found
= true;
3418 /* if a working partition on the device was not found */
3419 if (partition_found
== false) {
3420 error_setg(errp
, "Failed to find a working partition on disc");
3422 trace_file_setup_cdrom(test_partition
);
3423 pstrcpy(bsd_path
, MAXPATHLEN
, test_partition
);
3425 return partition_found
;
3428 /* Prints directions on mounting and unmounting a device */
3429 static void print_unmounting_directions(const char *file_name
)
3431 error_report("If device %s is mounted on the desktop, unmount"
3432 " it first before using it in QEMU", file_name
);
3433 error_report("Command to unmount device: diskutil unmountDisk %s",
3435 error_report("Command to mount device: diskutil mountDisk %s", file_name
);
3438 #endif /* defined(__APPLE__) && defined(__MACH__) */
3440 static int hdev_probe_device(const char *filename
)
3444 /* allow a dedicated CD-ROM driver to match with a higher priority */
3445 if (strstart(filename
, "/dev/cdrom", NULL
))
3448 if (stat(filename
, &st
) >= 0 &&
3449 (S_ISCHR(st
.st_mode
) || S_ISBLK(st
.st_mode
))) {
3456 static void hdev_parse_filename(const char *filename
, QDict
*options
,
3459 bdrv_parse_filename_strip_prefix(filename
, "host_device:", options
);
3462 static bool hdev_is_sg(BlockDriverState
*bs
)
3465 #if defined(__linux__)
3467 BDRVRawState
*s
= bs
->opaque
;
3469 struct sg_scsi_id scsiid
;
3473 if (stat(bs
->filename
, &st
) < 0 || !S_ISCHR(st
.st_mode
)) {
3477 ret
= ioctl(s
->fd
, SG_GET_VERSION_NUM
, &sg_version
);
3482 ret
= ioctl(s
->fd
, SG_GET_SCSI_ID
, &scsiid
);
3484 trace_file_hdev_is_sg(scsiid
.scsi_type
, sg_version
);
3493 static int hdev_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
3496 BDRVRawState
*s
= bs
->opaque
;
3499 #if defined(__APPLE__) && defined(__MACH__)
3501 * Caution: while qdict_get_str() is fine, getting non-string types
3502 * would require more care. When @options come from -blockdev or
3503 * blockdev_add, its members are typed according to the QAPI
3504 * schema, but when they come from -drive, they're all QString.
3506 const char *filename
= qdict_get_str(options
, "filename");
3507 char bsd_path
[MAXPATHLEN
] = "";
3508 bool error_occurred
= false;
3510 /* If using a real cdrom */
3511 if (strcmp(filename
, "/dev/cdrom") == 0) {
3512 char *mediaType
= NULL
;
3513 kern_return_t ret_val
;
3514 io_iterator_t mediaIterator
= 0;
3516 mediaType
= FindEjectableOpticalMedia(&mediaIterator
);
3517 if (mediaType
== NULL
) {
3518 error_setg(errp
, "Please make sure your CD/DVD is in the optical"
3520 error_occurred
= true;
3521 goto hdev_open_Mac_error
;
3524 ret_val
= GetBSDPath(mediaIterator
, bsd_path
, sizeof(bsd_path
), flags
);
3525 if (ret_val
!= KERN_SUCCESS
) {
3526 error_setg(errp
, "Could not get BSD path for optical drive");
3527 error_occurred
= true;
3528 goto hdev_open_Mac_error
;
3531 /* If a real optical drive was not found */
3532 if (bsd_path
[0] == '\0') {
3533 error_setg(errp
, "Failed to obtain bsd path for optical drive");
3534 error_occurred
= true;
3535 goto hdev_open_Mac_error
;
3538 /* If using a cdrom disc and finding a partition on the disc failed */
3539 if (strncmp(mediaType
, kIOCDMediaClass
, 9) == 0 &&
3540 setup_cdrom(bsd_path
, errp
) == false) {
3541 print_unmounting_directions(bsd_path
);
3542 error_occurred
= true;
3543 goto hdev_open_Mac_error
;
3546 qdict_put_str(options
, "filename", bsd_path
);
3548 hdev_open_Mac_error
:
3550 if (mediaIterator
) {
3551 IOObjectRelease(mediaIterator
);
3553 if (error_occurred
) {
3557 #endif /* defined(__APPLE__) && defined(__MACH__) */
3559 s
->type
= FTYPE_FILE
;
3561 ret
= raw_open_common(bs
, options
, flags
, 0, true, errp
);
3563 #if defined(__APPLE__) && defined(__MACH__)
3565 filename
= bsd_path
;
3567 /* if a physical device experienced an error while being opened */
3568 if (strncmp(filename
, "/dev/", 5) == 0) {
3569 print_unmounting_directions(filename
);
3571 #endif /* defined(__APPLE__) && defined(__MACH__) */
3575 /* Since this does ioctl the device must be already opened */
3576 bs
->sg
= hdev_is_sg(bs
);
3581 #if defined(__linux__)
3582 static int coroutine_fn
3583 hdev_co_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
)
3585 BDRVRawState
*s
= bs
->opaque
;
3586 RawPosixAIOData acb
;
3594 if (req
== SG_IO
&& s
->pr_mgr
) {
3595 struct sg_io_hdr
*io_hdr
= buf
;
3596 if (io_hdr
->cmdp
[0] == PERSISTENT_RESERVE_OUT
||
3597 io_hdr
->cmdp
[0] == PERSISTENT_RESERVE_IN
) {
3598 return pr_manager_execute(s
->pr_mgr
, bdrv_get_aio_context(bs
),
3603 acb
= (RawPosixAIOData
) {
3605 .aio_type
= QEMU_AIO_IOCTL
,
3606 .aio_fildes
= s
->fd
,
3614 return raw_thread_pool_submit(bs
, handle_aiocb_ioctl
, &acb
);
3618 static coroutine_fn
int
3619 hdev_co_pdiscard(BlockDriverState
*bs
, int64_t offset
, int64_t bytes
)
3621 BDRVRawState
*s
= bs
->opaque
;
3626 raw_account_discard(s
, bytes
, ret
);
3629 return raw_do_pdiscard(bs
, offset
, bytes
, true);
3632 static coroutine_fn
int hdev_co_pwrite_zeroes(BlockDriverState
*bs
,
3633 int64_t offset
, int64_t bytes
, BdrvRequestFlags flags
)
3642 return raw_do_pwrite_zeroes(bs
, offset
, bytes
, flags
, true);
3645 static BlockDriver bdrv_host_device
= {
3646 .format_name
= "host_device",
3647 .protocol_name
= "host_device",
3648 .instance_size
= sizeof(BDRVRawState
),
3649 .bdrv_needs_filename
= true,
3650 .bdrv_probe_device
= hdev_probe_device
,
3651 .bdrv_parse_filename
= hdev_parse_filename
,
3652 .bdrv_file_open
= hdev_open
,
3653 .bdrv_close
= raw_close
,
3654 .bdrv_reopen_prepare
= raw_reopen_prepare
,
3655 .bdrv_reopen_commit
= raw_reopen_commit
,
3656 .bdrv_reopen_abort
= raw_reopen_abort
,
3657 .bdrv_co_create_opts
= bdrv_co_create_opts_simple
,
3658 .create_opts
= &bdrv_create_opts_simple
,
3659 .mutable_opts
= mutable_opts
,
3660 .bdrv_co_invalidate_cache
= raw_co_invalidate_cache
,
3661 .bdrv_co_pwrite_zeroes
= hdev_co_pwrite_zeroes
,
3663 .bdrv_co_preadv
= raw_co_preadv
,
3664 .bdrv_co_pwritev
= raw_co_pwritev
,
3665 .bdrv_co_flush_to_disk
= raw_co_flush_to_disk
,
3666 .bdrv_co_pdiscard
= hdev_co_pdiscard
,
3667 .bdrv_co_copy_range_from
= raw_co_copy_range_from
,
3668 .bdrv_co_copy_range_to
= raw_co_copy_range_to
,
3669 .bdrv_refresh_limits
= raw_refresh_limits
,
3670 .bdrv_io_plug
= raw_aio_plug
,
3671 .bdrv_io_unplug
= raw_aio_unplug
,
3672 .bdrv_attach_aio_context
= raw_aio_attach_aio_context
,
3674 .bdrv_co_truncate
= raw_co_truncate
,
3675 .bdrv_getlength
= raw_getlength
,
3676 .bdrv_get_info
= raw_get_info
,
3677 .bdrv_get_allocated_file_size
3678 = raw_get_allocated_file_size
,
3679 .bdrv_get_specific_stats
= hdev_get_specific_stats
,
3680 .bdrv_check_perm
= raw_check_perm
,
3681 .bdrv_set_perm
= raw_set_perm
,
3682 .bdrv_abort_perm_update
= raw_abort_perm_update
,
3683 .bdrv_probe_blocksizes
= hdev_probe_blocksizes
,
3684 .bdrv_probe_geometry
= hdev_probe_geometry
,
3686 /* generic scsi device */
3688 .bdrv_co_ioctl
= hdev_co_ioctl
,
3692 #if defined(__linux__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3693 static void cdrom_parse_filename(const char *filename
, QDict
*options
,
3696 bdrv_parse_filename_strip_prefix(filename
, "host_cdrom:", options
);
3701 static int cdrom_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
3704 BDRVRawState
*s
= bs
->opaque
;
3708 /* open will not fail even if no CD is inserted, so add O_NONBLOCK */
3709 return raw_open_common(bs
, options
, flags
, O_NONBLOCK
, true, errp
);
3712 static int cdrom_probe_device(const char *filename
)
3718 fd
= qemu_open(filename
, O_RDONLY
| O_NONBLOCK
, NULL
);
3722 ret
= fstat(fd
, &st
);
3723 if (ret
== -1 || !S_ISBLK(st
.st_mode
)) {
3727 /* Attempt to detect via a CDROM specific ioctl */
3728 ret
= ioctl(fd
, CDROM_DRIVE_STATUS
, CDSL_CURRENT
);
3738 static bool cdrom_is_inserted(BlockDriverState
*bs
)
3740 BDRVRawState
*s
= bs
->opaque
;
3743 ret
= ioctl(s
->fd
, CDROM_DRIVE_STATUS
, CDSL_CURRENT
);
3744 return ret
== CDS_DISC_OK
;
3747 static void cdrom_eject(BlockDriverState
*bs
, bool eject_flag
)
3749 BDRVRawState
*s
= bs
->opaque
;
3752 if (ioctl(s
->fd
, CDROMEJECT
, NULL
) < 0)
3753 perror("CDROMEJECT");
3755 if (ioctl(s
->fd
, CDROMCLOSETRAY
, NULL
) < 0)
3756 perror("CDROMEJECT");
3760 static void cdrom_lock_medium(BlockDriverState
*bs
, bool locked
)
3762 BDRVRawState
*s
= bs
->opaque
;
3764 if (ioctl(s
->fd
, CDROM_LOCKDOOR
, locked
) < 0) {
3766 * Note: an error can happen if the distribution automatically
3769 /* perror("CDROM_LOCKDOOR"); */
3773 static BlockDriver bdrv_host_cdrom
= {
3774 .format_name
= "host_cdrom",
3775 .protocol_name
= "host_cdrom",
3776 .instance_size
= sizeof(BDRVRawState
),
3777 .bdrv_needs_filename
= true,
3778 .bdrv_probe_device
= cdrom_probe_device
,
3779 .bdrv_parse_filename
= cdrom_parse_filename
,
3780 .bdrv_file_open
= cdrom_open
,
3781 .bdrv_close
= raw_close
,
3782 .bdrv_reopen_prepare
= raw_reopen_prepare
,
3783 .bdrv_reopen_commit
= raw_reopen_commit
,
3784 .bdrv_reopen_abort
= raw_reopen_abort
,
3785 .bdrv_co_create_opts
= bdrv_co_create_opts_simple
,
3786 .create_opts
= &bdrv_create_opts_simple
,
3787 .mutable_opts
= mutable_opts
,
3788 .bdrv_co_invalidate_cache
= raw_co_invalidate_cache
,
3790 .bdrv_co_preadv
= raw_co_preadv
,
3791 .bdrv_co_pwritev
= raw_co_pwritev
,
3792 .bdrv_co_flush_to_disk
= raw_co_flush_to_disk
,
3793 .bdrv_refresh_limits
= raw_refresh_limits
,
3794 .bdrv_io_plug
= raw_aio_plug
,
3795 .bdrv_io_unplug
= raw_aio_unplug
,
3796 .bdrv_attach_aio_context
= raw_aio_attach_aio_context
,
3798 .bdrv_co_truncate
= raw_co_truncate
,
3799 .bdrv_getlength
= raw_getlength
,
3800 .has_variable_length
= true,
3801 .bdrv_get_allocated_file_size
3802 = raw_get_allocated_file_size
,
3804 /* removable device support */
3805 .bdrv_is_inserted
= cdrom_is_inserted
,
3806 .bdrv_eject
= cdrom_eject
,
3807 .bdrv_lock_medium
= cdrom_lock_medium
,
3809 /* generic scsi device */
3810 .bdrv_co_ioctl
= hdev_co_ioctl
,
3812 #endif /* __linux__ */
3814 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
3815 static int cdrom_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
3818 BDRVRawState
*s
= bs
->opaque
;
3823 ret
= raw_open_common(bs
, options
, flags
, 0, true, errp
);
3828 /* make sure the door isn't locked at this time */
3829 ioctl(s
->fd
, CDIOCALLOW
);
3833 static int cdrom_probe_device(const char *filename
)
3835 if (strstart(filename
, "/dev/cd", NULL
) ||
3836 strstart(filename
, "/dev/acd", NULL
))
3841 static int cdrom_reopen(BlockDriverState
*bs
)
3843 BDRVRawState
*s
= bs
->opaque
;
3847 * Force reread of possibly changed/newly loaded disc,
3848 * FreeBSD seems to not notice sometimes...
3852 fd
= qemu_open(bs
->filename
, s
->open_flags
, NULL
);
3859 /* make sure the door isn't locked at this time */
3860 ioctl(s
->fd
, CDIOCALLOW
);
3864 static bool cdrom_is_inserted(BlockDriverState
*bs
)
3866 return raw_getlength(bs
) > 0;
3869 static void cdrom_eject(BlockDriverState
*bs
, bool eject_flag
)
3871 BDRVRawState
*s
= bs
->opaque
;
3876 (void) ioctl(s
->fd
, CDIOCALLOW
);
3879 if (ioctl(s
->fd
, CDIOCEJECT
) < 0)
3880 perror("CDIOCEJECT");
3882 if (ioctl(s
->fd
, CDIOCCLOSE
) < 0)
3883 perror("CDIOCCLOSE");
3889 static void cdrom_lock_medium(BlockDriverState
*bs
, bool locked
)
3891 BDRVRawState
*s
= bs
->opaque
;
3895 if (ioctl(s
->fd
, (locked
? CDIOCPREVENT
: CDIOCALLOW
)) < 0) {
3897 * Note: an error can happen if the distribution automatically
3900 /* perror("CDROM_LOCKDOOR"); */
3904 static BlockDriver bdrv_host_cdrom
= {
3905 .format_name
= "host_cdrom",
3906 .protocol_name
= "host_cdrom",
3907 .instance_size
= sizeof(BDRVRawState
),
3908 .bdrv_needs_filename
= true,
3909 .bdrv_probe_device
= cdrom_probe_device
,
3910 .bdrv_parse_filename
= cdrom_parse_filename
,
3911 .bdrv_file_open
= cdrom_open
,
3912 .bdrv_close
= raw_close
,
3913 .bdrv_reopen_prepare
= raw_reopen_prepare
,
3914 .bdrv_reopen_commit
= raw_reopen_commit
,
3915 .bdrv_reopen_abort
= raw_reopen_abort
,
3916 .bdrv_co_create_opts
= bdrv_co_create_opts_simple
,
3917 .create_opts
= &bdrv_create_opts_simple
,
3918 .mutable_opts
= mutable_opts
,
3920 .bdrv_co_preadv
= raw_co_preadv
,
3921 .bdrv_co_pwritev
= raw_co_pwritev
,
3922 .bdrv_co_flush_to_disk
= raw_co_flush_to_disk
,
3923 .bdrv_refresh_limits
= raw_refresh_limits
,
3924 .bdrv_io_plug
= raw_aio_plug
,
3925 .bdrv_io_unplug
= raw_aio_unplug
,
3926 .bdrv_attach_aio_context
= raw_aio_attach_aio_context
,
3928 .bdrv_co_truncate
= raw_co_truncate
,
3929 .bdrv_getlength
= raw_getlength
,
3930 .has_variable_length
= true,
3931 .bdrv_get_allocated_file_size
3932 = raw_get_allocated_file_size
,
3934 /* removable device support */
3935 .bdrv_is_inserted
= cdrom_is_inserted
,
3936 .bdrv_eject
= cdrom_eject
,
3937 .bdrv_lock_medium
= cdrom_lock_medium
,
3939 #endif /* __FreeBSD__ */
3941 #endif /* HAVE_HOST_BLOCK_DEVICE */
3943 static void bdrv_file_init(void)
3946 * Register all the drivers. Note that order is important, the driver
3947 * registered last will get probed first.
3949 bdrv_register(&bdrv_file
);
3950 #if defined(HAVE_HOST_BLOCK_DEVICE)
3951 bdrv_register(&bdrv_host_device
);
3953 bdrv_register(&bdrv_host_cdrom
);
3955 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3956 bdrv_register(&bdrv_host_cdrom
);
3958 #endif /* HAVE_HOST_BLOCK_DEVICE */
3961 block_init(bdrv_file_init
);