nbd/client: Trace server noncompliance on structured reads
[qemu/ar7.git] / block / file-posix.c
blobdb4cccbe51a8849861be820b26225e6e88320592
1 /*
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
22 * THE SOFTWARE.
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
27 #include "qemu/cutils.h"
28 #include "qemu/error-report.h"
29 #include "block/block_int.h"
30 #include "qemu/module.h"
31 #include "qemu/option.h"
32 #include "trace.h"
33 #include "block/thread-pool.h"
34 #include "qemu/iov.h"
35 #include "block/raw-aio.h"
36 #include "qapi/qmp/qdict.h"
37 #include "qapi/qmp/qstring.h"
39 #include "scsi/pr-manager.h"
40 #include "scsi/constants.h"
42 #if defined(__APPLE__) && (__MACH__)
43 #include <paths.h>
44 #include <sys/param.h>
45 #include <IOKit/IOKitLib.h>
46 #include <IOKit/IOBSD.h>
47 #include <IOKit/storage/IOMediaBSDClient.h>
48 #include <IOKit/storage/IOMedia.h>
49 #include <IOKit/storage/IOCDMedia.h>
50 //#include <IOKit/storage/IOCDTypes.h>
51 #include <IOKit/storage/IODVDMedia.h>
52 #include <CoreFoundation/CoreFoundation.h>
53 #endif
55 #ifdef __sun__
56 #define _POSIX_PTHREAD_SEMANTICS 1
57 #include <sys/dkio.h>
58 #endif
59 #ifdef __linux__
60 #include <sys/ioctl.h>
61 #include <sys/param.h>
62 #include <sys/syscall.h>
63 #include <linux/cdrom.h>
64 #include <linux/fd.h>
65 #include <linux/fs.h>
66 #include <linux/hdreg.h>
67 #include <scsi/sg.h>
68 #ifdef __s390__
69 #include <asm/dasd.h>
70 #endif
71 #ifndef FS_NOCOW_FL
72 #define FS_NOCOW_FL 0x00800000 /* Do not cow file */
73 #endif
74 #endif
75 #if defined(CONFIG_FALLOCATE_PUNCH_HOLE) || defined(CONFIG_FALLOCATE_ZERO_RANGE)
76 #include <linux/falloc.h>
77 #endif
78 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
79 #include <sys/disk.h>
80 #include <sys/cdio.h>
81 #endif
83 #ifdef __OpenBSD__
84 #include <sys/ioctl.h>
85 #include <sys/disklabel.h>
86 #include <sys/dkio.h>
87 #endif
89 #ifdef __NetBSD__
90 #include <sys/ioctl.h>
91 #include <sys/disklabel.h>
92 #include <sys/dkio.h>
93 #include <sys/disk.h>
94 #endif
96 #ifdef __DragonFly__
97 #include <sys/ioctl.h>
98 #include <sys/diskslice.h>
99 #endif
101 #ifdef CONFIG_XFS
102 #include <xfs/xfs.h>
103 #endif
105 #include "trace.h"
107 /* OS X does not have O_DSYNC */
108 #ifndef O_DSYNC
109 #ifdef O_SYNC
110 #define O_DSYNC O_SYNC
111 #elif defined(O_FSYNC)
112 #define O_DSYNC O_FSYNC
113 #endif
114 #endif
116 /* Approximate O_DIRECT with O_DSYNC if O_DIRECT isn't available */
117 #ifndef O_DIRECT
118 #define O_DIRECT O_DSYNC
119 #endif
121 #define FTYPE_FILE 0
122 #define FTYPE_CD 1
124 #define MAX_BLOCKSIZE 4096
126 /* Posix file locking bytes. Libvirt takes byte 0, we start from higher bytes,
127 * leaving a few more bytes for its future use. */
128 #define RAW_LOCK_PERM_BASE 100
129 #define RAW_LOCK_SHARED_BASE 200
131 typedef struct BDRVRawState {
132 int fd;
133 bool use_lock;
134 int type;
135 int open_flags;
136 size_t buf_align;
138 /* The current permissions. */
139 uint64_t perm;
140 uint64_t shared_perm;
142 /* The perms bits whose corresponding bytes are already locked in
143 * s->fd. */
144 uint64_t locked_perm;
145 uint64_t locked_shared_perm;
147 int perm_change_fd;
148 BDRVReopenState *reopen_state;
150 #ifdef CONFIG_XFS
151 bool is_xfs:1;
152 #endif
153 bool has_discard:1;
154 bool has_write_zeroes:1;
155 bool discard_zeroes:1;
156 bool use_linux_aio:1;
157 bool page_cache_inconsistent:1;
158 bool has_fallocate;
159 bool needs_alignment;
160 bool drop_cache;
161 bool check_cache_dropped;
163 PRManager *pr_mgr;
164 } BDRVRawState;
166 typedef struct BDRVRawReopenState {
167 int fd;
168 int open_flags;
169 bool drop_cache;
170 bool check_cache_dropped;
171 } BDRVRawReopenState;
173 static int fd_open(BlockDriverState *bs);
174 static int64_t raw_getlength(BlockDriverState *bs);
176 typedef struct RawPosixAIOData {
177 BlockDriverState *bs;
178 int aio_type;
179 int aio_fildes;
181 off_t aio_offset;
182 uint64_t aio_nbytes;
184 union {
185 struct {
186 struct iovec *iov;
187 int niov;
188 } io;
189 struct {
190 uint64_t cmd;
191 void *buf;
192 } ioctl;
193 struct {
194 int aio_fd2;
195 off_t aio_offset2;
196 } copy_range;
197 struct {
198 PreallocMode prealloc;
199 Error **errp;
200 } truncate;
202 } RawPosixAIOData;
204 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
205 static int cdrom_reopen(BlockDriverState *bs);
206 #endif
208 #if defined(__NetBSD__)
209 static int raw_normalize_devicepath(const char **filename, Error **errp)
211 static char namebuf[PATH_MAX];
212 const char *dp, *fname;
213 struct stat sb;
215 fname = *filename;
216 dp = strrchr(fname, '/');
217 if (lstat(fname, &sb) < 0) {
218 error_setg_errno(errp, errno, "%s: stat failed", fname);
219 return -errno;
222 if (!S_ISBLK(sb.st_mode)) {
223 return 0;
226 if (dp == NULL) {
227 snprintf(namebuf, PATH_MAX, "r%s", fname);
228 } else {
229 snprintf(namebuf, PATH_MAX, "%.*s/r%s",
230 (int)(dp - fname), fname, dp + 1);
232 *filename = namebuf;
233 warn_report("%s is a block device, using %s", fname, *filename);
235 return 0;
237 #else
238 static int raw_normalize_devicepath(const char **filename, Error **errp)
240 return 0;
242 #endif
245 * Get logical block size via ioctl. On success store it in @sector_size_p.
247 static int probe_logical_blocksize(int fd, unsigned int *sector_size_p)
249 unsigned int sector_size;
250 bool success = false;
251 int i;
253 errno = ENOTSUP;
254 static const unsigned long ioctl_list[] = {
255 #ifdef BLKSSZGET
256 BLKSSZGET,
257 #endif
258 #ifdef DKIOCGETBLOCKSIZE
259 DKIOCGETBLOCKSIZE,
260 #endif
261 #ifdef DIOCGSECTORSIZE
262 DIOCGSECTORSIZE,
263 #endif
266 /* Try a few ioctls to get the right size */
267 for (i = 0; i < (int)ARRAY_SIZE(ioctl_list); i++) {
268 if (ioctl(fd, ioctl_list[i], &sector_size) >= 0) {
269 *sector_size_p = sector_size;
270 success = true;
274 return success ? 0 : -errno;
278 * Get physical block size of @fd.
279 * On success, store it in @blk_size and return 0.
280 * On failure, return -errno.
282 static int probe_physical_blocksize(int fd, unsigned int *blk_size)
284 #ifdef BLKPBSZGET
285 if (ioctl(fd, BLKPBSZGET, blk_size) < 0) {
286 return -errno;
288 return 0;
289 #else
290 return -ENOTSUP;
291 #endif
294 /* Check if read is allowed with given memory buffer and length.
296 * This function is used to check O_DIRECT memory buffer and request alignment.
298 static bool raw_is_io_aligned(int fd, void *buf, size_t len)
300 ssize_t ret = pread(fd, buf, len, 0);
302 if (ret >= 0) {
303 return true;
306 #ifdef __linux__
307 /* The Linux kernel returns EINVAL for misaligned O_DIRECT reads. Ignore
308 * other errors (e.g. real I/O error), which could happen on a failed
309 * drive, since we only care about probing alignment.
311 if (errno != EINVAL) {
312 return true;
314 #endif
316 return false;
319 static void raw_probe_alignment(BlockDriverState *bs, int fd, Error **errp)
321 BDRVRawState *s = bs->opaque;
322 char *buf;
323 size_t max_align = MAX(MAX_BLOCKSIZE, getpagesize());
325 /* For SCSI generic devices the alignment is not really used.
326 With buffered I/O, we don't have any restrictions. */
327 if (bdrv_is_sg(bs) || !s->needs_alignment) {
328 bs->bl.request_alignment = 1;
329 s->buf_align = 1;
330 return;
333 bs->bl.request_alignment = 0;
334 s->buf_align = 0;
335 /* Let's try to use the logical blocksize for the alignment. */
336 if (probe_logical_blocksize(fd, &bs->bl.request_alignment) < 0) {
337 bs->bl.request_alignment = 0;
339 #ifdef CONFIG_XFS
340 if (s->is_xfs) {
341 struct dioattr da;
342 if (xfsctl(NULL, fd, XFS_IOC_DIOINFO, &da) >= 0) {
343 bs->bl.request_alignment = da.d_miniosz;
344 /* The kernel returns wrong information for d_mem */
345 /* s->buf_align = da.d_mem; */
348 #endif
350 /* If we could not get the sizes so far, we can only guess them */
351 if (!s->buf_align) {
352 size_t align;
353 buf = qemu_memalign(max_align, 2 * max_align);
354 for (align = 512; align <= max_align; align <<= 1) {
355 if (raw_is_io_aligned(fd, buf + align, max_align)) {
356 s->buf_align = align;
357 break;
360 qemu_vfree(buf);
363 if (!bs->bl.request_alignment) {
364 size_t align;
365 buf = qemu_memalign(s->buf_align, max_align);
366 for (align = 512; align <= max_align; align <<= 1) {
367 if (raw_is_io_aligned(fd, buf, align)) {
368 bs->bl.request_alignment = align;
369 break;
372 qemu_vfree(buf);
375 if (!s->buf_align || !bs->bl.request_alignment) {
376 error_setg(errp, "Could not find working O_DIRECT alignment");
377 error_append_hint(errp, "Try cache.direct=off\n");
381 static void raw_parse_flags(int bdrv_flags, int *open_flags, bool has_writers)
383 bool read_write = false;
384 assert(open_flags != NULL);
386 *open_flags |= O_BINARY;
387 *open_flags &= ~O_ACCMODE;
389 if (bdrv_flags & BDRV_O_AUTO_RDONLY) {
390 read_write = has_writers;
391 } else if (bdrv_flags & BDRV_O_RDWR) {
392 read_write = true;
395 if (read_write) {
396 *open_flags |= O_RDWR;
397 } else {
398 *open_flags |= O_RDONLY;
401 /* Use O_DSYNC for write-through caching, no flags for write-back caching,
402 * and O_DIRECT for no caching. */
403 if ((bdrv_flags & BDRV_O_NOCACHE)) {
404 *open_flags |= O_DIRECT;
408 static void raw_parse_filename(const char *filename, QDict *options,
409 Error **errp)
411 bdrv_parse_filename_strip_prefix(filename, "file:", options);
414 static QemuOptsList raw_runtime_opts = {
415 .name = "raw",
416 .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
417 .desc = {
419 .name = "filename",
420 .type = QEMU_OPT_STRING,
421 .help = "File name of the image",
424 .name = "aio",
425 .type = QEMU_OPT_STRING,
426 .help = "host AIO implementation (threads, native)",
429 .name = "locking",
430 .type = QEMU_OPT_STRING,
431 .help = "file locking mode (on/off/auto, default: auto)",
434 .name = "pr-manager",
435 .type = QEMU_OPT_STRING,
436 .help = "id of persistent reservation manager object (default: none)",
438 #if defined(__linux__)
440 .name = "drop-cache",
441 .type = QEMU_OPT_BOOL,
442 .help = "invalidate page cache during live migration (default: on)",
444 #endif
446 .name = "x-check-cache-dropped",
447 .type = QEMU_OPT_BOOL,
448 .help = "check that page cache was dropped on live migration (default: off)"
450 { /* end of list */ }
454 static const char *const mutable_opts[] = { "x-check-cache-dropped", NULL };
456 static int raw_open_common(BlockDriverState *bs, QDict *options,
457 int bdrv_flags, int open_flags,
458 bool device, Error **errp)
460 BDRVRawState *s = bs->opaque;
461 QemuOpts *opts;
462 Error *local_err = NULL;
463 const char *filename = NULL;
464 const char *str;
465 BlockdevAioOptions aio, aio_default;
466 int fd, ret;
467 struct stat st;
468 OnOffAuto locking;
470 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
471 qemu_opts_absorb_qdict(opts, options, &local_err);
472 if (local_err) {
473 error_propagate(errp, local_err);
474 ret = -EINVAL;
475 goto fail;
478 filename = qemu_opt_get(opts, "filename");
480 ret = raw_normalize_devicepath(&filename, errp);
481 if (ret != 0) {
482 goto fail;
485 aio_default = (bdrv_flags & BDRV_O_NATIVE_AIO)
486 ? BLOCKDEV_AIO_OPTIONS_NATIVE
487 : BLOCKDEV_AIO_OPTIONS_THREADS;
488 aio = qapi_enum_parse(&BlockdevAioOptions_lookup,
489 qemu_opt_get(opts, "aio"),
490 aio_default, &local_err);
491 if (local_err) {
492 error_propagate(errp, local_err);
493 ret = -EINVAL;
494 goto fail;
496 s->use_linux_aio = (aio == BLOCKDEV_AIO_OPTIONS_NATIVE);
498 locking = qapi_enum_parse(&OnOffAuto_lookup,
499 qemu_opt_get(opts, "locking"),
500 ON_OFF_AUTO_AUTO, &local_err);
501 if (local_err) {
502 error_propagate(errp, local_err);
503 ret = -EINVAL;
504 goto fail;
506 switch (locking) {
507 case ON_OFF_AUTO_ON:
508 s->use_lock = true;
509 if (!qemu_has_ofd_lock()) {
510 warn_report("File lock requested but OFD locking syscall is "
511 "unavailable, falling back to POSIX file locks");
512 error_printf("Due to the implementation, locks can be lost "
513 "unexpectedly.\n");
515 break;
516 case ON_OFF_AUTO_OFF:
517 s->use_lock = false;
518 break;
519 case ON_OFF_AUTO_AUTO:
520 s->use_lock = qemu_has_ofd_lock();
521 break;
522 default:
523 abort();
526 str = qemu_opt_get(opts, "pr-manager");
527 if (str) {
528 s->pr_mgr = pr_manager_lookup(str, &local_err);
529 if (local_err) {
530 error_propagate(errp, local_err);
531 ret = -EINVAL;
532 goto fail;
536 s->drop_cache = qemu_opt_get_bool(opts, "drop-cache", true);
537 s->check_cache_dropped = qemu_opt_get_bool(opts, "x-check-cache-dropped",
538 false);
540 s->open_flags = open_flags;
541 raw_parse_flags(bdrv_flags, &s->open_flags, false);
543 s->fd = -1;
544 fd = qemu_open(filename, s->open_flags, 0644);
545 ret = fd < 0 ? -errno : 0;
547 if (ret < 0) {
548 error_setg_errno(errp, -ret, "Could not open '%s'", filename);
549 if (ret == -EROFS) {
550 ret = -EACCES;
552 goto fail;
554 s->fd = fd;
556 s->perm = 0;
557 s->shared_perm = BLK_PERM_ALL;
559 #ifdef CONFIG_LINUX_AIO
560 /* Currently Linux does AIO only for files opened with O_DIRECT */
561 if (s->use_linux_aio) {
562 if (!(s->open_flags & O_DIRECT)) {
563 error_setg(errp, "aio=native was specified, but it requires "
564 "cache.direct=on, which was not specified.");
565 ret = -EINVAL;
566 goto fail;
568 if (!aio_setup_linux_aio(bdrv_get_aio_context(bs), errp)) {
569 error_prepend(errp, "Unable to use native AIO: ");
570 goto fail;
573 #else
574 if (s->use_linux_aio) {
575 error_setg(errp, "aio=native was specified, but is not supported "
576 "in this build.");
577 ret = -EINVAL;
578 goto fail;
580 #endif /* !defined(CONFIG_LINUX_AIO) */
582 s->has_discard = true;
583 s->has_write_zeroes = true;
584 if ((bs->open_flags & BDRV_O_NOCACHE) != 0) {
585 s->needs_alignment = true;
588 if (fstat(s->fd, &st) < 0) {
589 ret = -errno;
590 error_setg_errno(errp, errno, "Could not stat file");
591 goto fail;
594 if (!device) {
595 if (S_ISBLK(st.st_mode)) {
596 warn_report("Opening a block device as a file using the '%s' "
597 "driver is deprecated", bs->drv->format_name);
598 } else if (S_ISCHR(st.st_mode)) {
599 warn_report("Opening a character device as a file using the '%s' "
600 "driver is deprecated", bs->drv->format_name);
601 } else if (!S_ISREG(st.st_mode)) {
602 error_setg(errp, "A regular file was expected by the '%s' driver, "
603 "but something else was given", bs->drv->format_name);
604 ret = -EINVAL;
605 goto fail;
606 } else {
607 s->discard_zeroes = true;
608 s->has_fallocate = true;
610 } else {
611 if (!(S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
612 error_setg(errp, "'%s' driver expects either "
613 "a character or block device", bs->drv->format_name);
614 ret = -EINVAL;
615 goto fail;
619 if (S_ISBLK(st.st_mode)) {
620 #ifdef BLKDISCARDZEROES
621 unsigned int arg;
622 if (ioctl(s->fd, BLKDISCARDZEROES, &arg) == 0 && arg) {
623 s->discard_zeroes = true;
625 #endif
626 #ifdef __linux__
627 /* On Linux 3.10, BLKDISCARD leaves stale data in the page cache. Do
628 * not rely on the contents of discarded blocks unless using O_DIRECT.
629 * Same for BLKZEROOUT.
631 if (!(bs->open_flags & BDRV_O_NOCACHE)) {
632 s->discard_zeroes = false;
633 s->has_write_zeroes = false;
635 #endif
637 #ifdef __FreeBSD__
638 if (S_ISCHR(st.st_mode)) {
640 * The file is a char device (disk), which on FreeBSD isn't behind
641 * a pager, so force all requests to be aligned. This is needed
642 * so QEMU makes sure all IO operations on the device are aligned
643 * to sector size, or else FreeBSD will reject them with EINVAL.
645 s->needs_alignment = true;
647 #endif
649 #ifdef CONFIG_XFS
650 if (platform_test_xfs_fd(s->fd)) {
651 s->is_xfs = true;
653 #endif
655 bs->supported_zero_flags = BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK;
656 ret = 0;
657 fail:
658 if (filename && (bdrv_flags & BDRV_O_TEMPORARY)) {
659 unlink(filename);
661 qemu_opts_del(opts);
662 return ret;
665 static int raw_open(BlockDriverState *bs, QDict *options, int flags,
666 Error **errp)
668 BDRVRawState *s = bs->opaque;
670 s->type = FTYPE_FILE;
671 return raw_open_common(bs, options, flags, 0, false, errp);
674 typedef enum {
675 RAW_PL_PREPARE,
676 RAW_PL_COMMIT,
677 RAW_PL_ABORT,
678 } RawPermLockOp;
680 #define PERM_FOREACH(i) \
681 for ((i) = 0; (1ULL << (i)) <= BLK_PERM_ALL; i++)
683 /* Lock bytes indicated by @perm_lock_bits and @shared_perm_lock_bits in the
684 * file; if @unlock == true, also unlock the unneeded bytes.
685 * @shared_perm_lock_bits is the mask of all permissions that are NOT shared.
687 static int raw_apply_lock_bytes(BDRVRawState *s, int fd,
688 uint64_t perm_lock_bits,
689 uint64_t shared_perm_lock_bits,
690 bool unlock, Error **errp)
692 int ret;
693 int i;
694 uint64_t locked_perm, locked_shared_perm;
696 if (s) {
697 locked_perm = s->locked_perm;
698 locked_shared_perm = s->locked_shared_perm;
699 } else {
701 * We don't have the previous bits, just lock/unlock for each of the
702 * requested bits.
704 if (unlock) {
705 locked_perm = BLK_PERM_ALL;
706 locked_shared_perm = BLK_PERM_ALL;
707 } else {
708 locked_perm = 0;
709 locked_shared_perm = 0;
713 PERM_FOREACH(i) {
714 int off = RAW_LOCK_PERM_BASE + i;
715 uint64_t bit = (1ULL << i);
716 if ((perm_lock_bits & bit) && !(locked_perm & bit)) {
717 ret = qemu_lock_fd(fd, off, 1, false);
718 if (ret) {
719 error_setg(errp, "Failed to lock byte %d", off);
720 return ret;
721 } else if (s) {
722 s->locked_perm |= bit;
724 } else if (unlock && (locked_perm & bit) && !(perm_lock_bits & bit)) {
725 ret = qemu_unlock_fd(fd, off, 1);
726 if (ret) {
727 error_setg(errp, "Failed to unlock byte %d", off);
728 return ret;
729 } else if (s) {
730 s->locked_perm &= ~bit;
734 PERM_FOREACH(i) {
735 int off = RAW_LOCK_SHARED_BASE + i;
736 uint64_t bit = (1ULL << i);
737 if ((shared_perm_lock_bits & bit) && !(locked_shared_perm & bit)) {
738 ret = qemu_lock_fd(fd, off, 1, false);
739 if (ret) {
740 error_setg(errp, "Failed to lock byte %d", off);
741 return ret;
742 } else if (s) {
743 s->locked_shared_perm |= bit;
745 } else if (unlock && (locked_shared_perm & bit) &&
746 !(shared_perm_lock_bits & bit)) {
747 ret = qemu_unlock_fd(fd, off, 1);
748 if (ret) {
749 error_setg(errp, "Failed to unlock byte %d", off);
750 return ret;
751 } else if (s) {
752 s->locked_shared_perm &= ~bit;
756 return 0;
759 /* Check "unshared" bytes implied by @perm and ~@shared_perm in the file. */
760 static int raw_check_lock_bytes(int fd, uint64_t perm, uint64_t shared_perm,
761 Error **errp)
763 int ret;
764 int i;
766 PERM_FOREACH(i) {
767 int off = RAW_LOCK_SHARED_BASE + i;
768 uint64_t p = 1ULL << i;
769 if (perm & p) {
770 ret = qemu_lock_fd_test(fd, off, 1, true);
771 if (ret) {
772 char *perm_name = bdrv_perm_names(p);
773 error_setg(errp,
774 "Failed to get \"%s\" lock",
775 perm_name);
776 g_free(perm_name);
777 return ret;
781 PERM_FOREACH(i) {
782 int off = RAW_LOCK_PERM_BASE + i;
783 uint64_t p = 1ULL << i;
784 if (!(shared_perm & p)) {
785 ret = qemu_lock_fd_test(fd, off, 1, true);
786 if (ret) {
787 char *perm_name = bdrv_perm_names(p);
788 error_setg(errp,
789 "Failed to get shared \"%s\" lock",
790 perm_name);
791 g_free(perm_name);
792 return ret;
796 return 0;
799 static int raw_handle_perm_lock(BlockDriverState *bs,
800 RawPermLockOp op,
801 uint64_t new_perm, uint64_t new_shared,
802 Error **errp)
804 BDRVRawState *s = bs->opaque;
805 int ret = 0;
806 Error *local_err = NULL;
808 if (!s->use_lock) {
809 return 0;
812 if (bdrv_get_flags(bs) & BDRV_O_INACTIVE) {
813 return 0;
816 switch (op) {
817 case RAW_PL_PREPARE:
818 ret = raw_apply_lock_bytes(s, s->fd, s->perm | new_perm,
819 ~s->shared_perm | ~new_shared,
820 false, errp);
821 if (!ret) {
822 ret = raw_check_lock_bytes(s->fd, new_perm, new_shared, errp);
823 if (!ret) {
824 return 0;
826 error_append_hint(errp,
827 "Is another process using the image [%s]?\n",
828 bs->filename);
830 op = RAW_PL_ABORT;
831 /* fall through to unlock bytes. */
832 case RAW_PL_ABORT:
833 raw_apply_lock_bytes(s, s->fd, s->perm, ~s->shared_perm,
834 true, &local_err);
835 if (local_err) {
836 /* Theoretically the above call only unlocks bytes and it cannot
837 * fail. Something weird happened, report it.
839 warn_report_err(local_err);
841 break;
842 case RAW_PL_COMMIT:
843 raw_apply_lock_bytes(s, s->fd, new_perm, ~new_shared,
844 true, &local_err);
845 if (local_err) {
846 /* Theoretically the above call only unlocks bytes and it cannot
847 * fail. Something weird happened, report it.
849 warn_report_err(local_err);
851 break;
853 return ret;
856 static int raw_reconfigure_getfd(BlockDriverState *bs, int flags,
857 int *open_flags, uint64_t perm, bool force_dup,
858 Error **errp)
860 BDRVRawState *s = bs->opaque;
861 int fd = -1;
862 int ret;
863 bool has_writers = perm &
864 (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED | BLK_PERM_RESIZE);
865 int fcntl_flags = O_APPEND | O_NONBLOCK;
866 #ifdef O_NOATIME
867 fcntl_flags |= O_NOATIME;
868 #endif
870 *open_flags = 0;
871 if (s->type == FTYPE_CD) {
872 *open_flags |= O_NONBLOCK;
875 raw_parse_flags(flags, open_flags, has_writers);
877 #ifdef O_ASYNC
878 /* Not all operating systems have O_ASYNC, and those that don't
879 * will not let us track the state into rs->open_flags (typically
880 * you achieve the same effect with an ioctl, for example I_SETSIG
881 * on Solaris). But we do not use O_ASYNC, so that's fine.
883 assert((s->open_flags & O_ASYNC) == 0);
884 #endif
886 if (!force_dup && *open_flags == s->open_flags) {
887 /* We're lucky, the existing fd is fine */
888 return s->fd;
891 if ((*open_flags & ~fcntl_flags) == (s->open_flags & ~fcntl_flags)) {
892 /* dup the original fd */
893 fd = qemu_dup(s->fd);
894 if (fd >= 0) {
895 ret = fcntl_setfl(fd, *open_flags);
896 if (ret) {
897 qemu_close(fd);
898 fd = -1;
903 /* If we cannot use fcntl, or fcntl failed, fall back to qemu_open() */
904 if (fd == -1) {
905 const char *normalized_filename = bs->filename;
906 ret = raw_normalize_devicepath(&normalized_filename, errp);
907 if (ret >= 0) {
908 assert(!(*open_flags & O_CREAT));
909 fd = qemu_open(normalized_filename, *open_flags);
910 if (fd == -1) {
911 error_setg_errno(errp, errno, "Could not reopen file");
912 return -1;
917 return fd;
920 static int raw_reopen_prepare(BDRVReopenState *state,
921 BlockReopenQueue *queue, Error **errp)
923 BDRVRawState *s;
924 BDRVRawReopenState *rs;
925 QemuOpts *opts;
926 int ret;
927 Error *local_err = NULL;
929 assert(state != NULL);
930 assert(state->bs != NULL);
932 s = state->bs->opaque;
934 state->opaque = g_new0(BDRVRawReopenState, 1);
935 rs = state->opaque;
937 /* Handle options changes */
938 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
939 qemu_opts_absorb_qdict(opts, state->options, &local_err);
940 if (local_err) {
941 error_propagate(errp, local_err);
942 ret = -EINVAL;
943 goto out;
946 rs->drop_cache = qemu_opt_get_bool_del(opts, "drop-cache", true);
947 rs->check_cache_dropped =
948 qemu_opt_get_bool_del(opts, "x-check-cache-dropped", false);
950 /* This driver's reopen function doesn't currently allow changing
951 * other options, so let's put them back in the original QDict and
952 * bdrv_reopen_prepare() will detect changes and complain. */
953 qemu_opts_to_qdict(opts, state->options);
955 rs->fd = raw_reconfigure_getfd(state->bs, state->flags, &rs->open_flags,
956 state->perm, true, &local_err);
957 if (local_err) {
958 error_propagate(errp, local_err);
959 ret = -1;
960 goto out;
963 /* Fail already reopen_prepare() if we can't get a working O_DIRECT
964 * alignment with the new fd. */
965 if (rs->fd != -1) {
966 raw_probe_alignment(state->bs, rs->fd, &local_err);
967 if (local_err) {
968 error_propagate(errp, local_err);
969 ret = -EINVAL;
970 goto out_fd;
974 s->reopen_state = state;
975 ret = 0;
976 out_fd:
977 if (ret < 0) {
978 qemu_close(rs->fd);
979 rs->fd = -1;
981 out:
982 qemu_opts_del(opts);
983 return ret;
986 static void raw_reopen_commit(BDRVReopenState *state)
988 BDRVRawReopenState *rs = state->opaque;
989 BDRVRawState *s = state->bs->opaque;
991 s->drop_cache = rs->drop_cache;
992 s->check_cache_dropped = rs->check_cache_dropped;
993 s->open_flags = rs->open_flags;
995 qemu_close(s->fd);
996 s->fd = rs->fd;
998 g_free(state->opaque);
999 state->opaque = NULL;
1001 assert(s->reopen_state == state);
1002 s->reopen_state = NULL;
1006 static void raw_reopen_abort(BDRVReopenState *state)
1008 BDRVRawReopenState *rs = state->opaque;
1009 BDRVRawState *s = state->bs->opaque;
1011 /* nothing to do if NULL, we didn't get far enough */
1012 if (rs == NULL) {
1013 return;
1016 if (rs->fd >= 0) {
1017 qemu_close(rs->fd);
1018 rs->fd = -1;
1020 g_free(state->opaque);
1021 state->opaque = NULL;
1023 assert(s->reopen_state == state);
1024 s->reopen_state = NULL;
1027 static int hdev_get_max_transfer_length(BlockDriverState *bs, int fd)
1029 #ifdef BLKSECTGET
1030 int max_bytes = 0;
1031 short max_sectors = 0;
1032 if (bs->sg && ioctl(fd, BLKSECTGET, &max_bytes) == 0) {
1033 return max_bytes;
1034 } else if (!bs->sg && ioctl(fd, BLKSECTGET, &max_sectors) == 0) {
1035 return max_sectors << BDRV_SECTOR_BITS;
1036 } else {
1037 return -errno;
1039 #else
1040 return -ENOSYS;
1041 #endif
1044 static int hdev_get_max_segments(const struct stat *st)
1046 #ifdef CONFIG_LINUX
1047 char buf[32];
1048 const char *end;
1049 char *sysfspath;
1050 int ret;
1051 int fd = -1;
1052 long max_segments;
1054 sysfspath = g_strdup_printf("/sys/dev/block/%u:%u/queue/max_segments",
1055 major(st->st_rdev), minor(st->st_rdev));
1056 fd = open(sysfspath, O_RDONLY);
1057 if (fd == -1) {
1058 ret = -errno;
1059 goto out;
1061 do {
1062 ret = read(fd, buf, sizeof(buf) - 1);
1063 } while (ret == -1 && errno == EINTR);
1064 if (ret < 0) {
1065 ret = -errno;
1066 goto out;
1067 } else if (ret == 0) {
1068 ret = -EIO;
1069 goto out;
1071 buf[ret] = 0;
1072 /* The file is ended with '\n', pass 'end' to accept that. */
1073 ret = qemu_strtol(buf, &end, 10, &max_segments);
1074 if (ret == 0 && end && *end == '\n') {
1075 ret = max_segments;
1078 out:
1079 if (fd != -1) {
1080 close(fd);
1082 g_free(sysfspath);
1083 return ret;
1084 #else
1085 return -ENOTSUP;
1086 #endif
1089 static void raw_refresh_limits(BlockDriverState *bs, Error **errp)
1091 BDRVRawState *s = bs->opaque;
1092 struct stat st;
1094 if (!fstat(s->fd, &st)) {
1095 if (S_ISBLK(st.st_mode) || S_ISCHR(st.st_mode)) {
1096 int ret = hdev_get_max_transfer_length(bs, s->fd);
1097 if (ret > 0 && ret <= BDRV_REQUEST_MAX_BYTES) {
1098 bs->bl.max_transfer = pow2floor(ret);
1100 ret = hdev_get_max_segments(&st);
1101 if (ret > 0) {
1102 bs->bl.max_transfer = MIN(bs->bl.max_transfer,
1103 ret * getpagesize());
1108 raw_probe_alignment(bs, s->fd, errp);
1109 bs->bl.min_mem_alignment = s->buf_align;
1110 bs->bl.opt_mem_alignment = MAX(s->buf_align, getpagesize());
1113 static int check_for_dasd(int fd)
1115 #ifdef BIODASDINFO2
1116 struct dasd_information2_t info = {0};
1118 return ioctl(fd, BIODASDINFO2, &info);
1119 #else
1120 return -1;
1121 #endif
1125 * Try to get @bs's logical and physical block size.
1126 * On success, store them in @bsz and return zero.
1127 * On failure, return negative errno.
1129 static int hdev_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz)
1131 BDRVRawState *s = bs->opaque;
1132 int ret;
1134 /* If DASD, get blocksizes */
1135 if (check_for_dasd(s->fd) < 0) {
1136 return -ENOTSUP;
1138 ret = probe_logical_blocksize(s->fd, &bsz->log);
1139 if (ret < 0) {
1140 return ret;
1142 return probe_physical_blocksize(s->fd, &bsz->phys);
1146 * Try to get @bs's geometry: cyls, heads, sectors.
1147 * On success, store them in @geo and return 0.
1148 * On failure return -errno.
1149 * (Allows block driver to assign default geometry values that guest sees)
1151 #ifdef __linux__
1152 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1154 BDRVRawState *s = bs->opaque;
1155 struct hd_geometry ioctl_geo = {0};
1157 /* If DASD, get its geometry */
1158 if (check_for_dasd(s->fd) < 0) {
1159 return -ENOTSUP;
1161 if (ioctl(s->fd, HDIO_GETGEO, &ioctl_geo) < 0) {
1162 return -errno;
1164 /* HDIO_GETGEO may return success even though geo contains zeros
1165 (e.g. certain multipath setups) */
1166 if (!ioctl_geo.heads || !ioctl_geo.sectors || !ioctl_geo.cylinders) {
1167 return -ENOTSUP;
1169 /* Do not return a geometry for partition */
1170 if (ioctl_geo.start != 0) {
1171 return -ENOTSUP;
1173 geo->heads = ioctl_geo.heads;
1174 geo->sectors = ioctl_geo.sectors;
1175 geo->cylinders = ioctl_geo.cylinders;
1177 return 0;
1179 #else /* __linux__ */
1180 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1182 return -ENOTSUP;
1184 #endif
1186 #if defined(__linux__)
1187 static int handle_aiocb_ioctl(void *opaque)
1189 RawPosixAIOData *aiocb = opaque;
1190 int ret;
1192 ret = ioctl(aiocb->aio_fildes, aiocb->ioctl.cmd, aiocb->ioctl.buf);
1193 if (ret == -1) {
1194 return -errno;
1197 return 0;
1199 #endif /* linux */
1201 static int handle_aiocb_flush(void *opaque)
1203 RawPosixAIOData *aiocb = opaque;
1204 BDRVRawState *s = aiocb->bs->opaque;
1205 int ret;
1207 if (s->page_cache_inconsistent) {
1208 return -EIO;
1211 ret = qemu_fdatasync(aiocb->aio_fildes);
1212 if (ret == -1) {
1213 /* There is no clear definition of the semantics of a failing fsync(),
1214 * so we may have to assume the worst. The sad truth is that this
1215 * assumption is correct for Linux. Some pages are now probably marked
1216 * clean in the page cache even though they are inconsistent with the
1217 * on-disk contents. The next fdatasync() call would succeed, but no
1218 * further writeback attempt will be made. We can't get back to a state
1219 * in which we know what is on disk (we would have to rewrite
1220 * everything that was touched since the last fdatasync() at least), so
1221 * make bdrv_flush() fail permanently. Given that the behaviour isn't
1222 * really defined, I have little hope that other OSes are doing better.
1224 * Obviously, this doesn't affect O_DIRECT, which bypasses the page
1225 * cache. */
1226 if ((s->open_flags & O_DIRECT) == 0) {
1227 s->page_cache_inconsistent = true;
1229 return -errno;
1231 return 0;
1234 #ifdef CONFIG_PREADV
1236 static bool preadv_present = true;
1238 static ssize_t
1239 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1241 return preadv(fd, iov, nr_iov, offset);
1244 static ssize_t
1245 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1247 return pwritev(fd, iov, nr_iov, offset);
1250 #else
1252 static bool preadv_present = false;
1254 static ssize_t
1255 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1257 return -ENOSYS;
1260 static ssize_t
1261 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1263 return -ENOSYS;
1266 #endif
1268 static ssize_t handle_aiocb_rw_vector(RawPosixAIOData *aiocb)
1270 ssize_t len;
1272 do {
1273 if (aiocb->aio_type & QEMU_AIO_WRITE)
1274 len = qemu_pwritev(aiocb->aio_fildes,
1275 aiocb->io.iov,
1276 aiocb->io.niov,
1277 aiocb->aio_offset);
1278 else
1279 len = qemu_preadv(aiocb->aio_fildes,
1280 aiocb->io.iov,
1281 aiocb->io.niov,
1282 aiocb->aio_offset);
1283 } while (len == -1 && errno == EINTR);
1285 if (len == -1) {
1286 return -errno;
1288 return len;
1292 * Read/writes the data to/from a given linear buffer.
1294 * Returns the number of bytes handles or -errno in case of an error. Short
1295 * reads are only returned if the end of the file is reached.
1297 static ssize_t handle_aiocb_rw_linear(RawPosixAIOData *aiocb, char *buf)
1299 ssize_t offset = 0;
1300 ssize_t len;
1302 while (offset < aiocb->aio_nbytes) {
1303 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1304 len = pwrite(aiocb->aio_fildes,
1305 (const char *)buf + offset,
1306 aiocb->aio_nbytes - offset,
1307 aiocb->aio_offset + offset);
1308 } else {
1309 len = pread(aiocb->aio_fildes,
1310 buf + offset,
1311 aiocb->aio_nbytes - offset,
1312 aiocb->aio_offset + offset);
1314 if (len == -1 && errno == EINTR) {
1315 continue;
1316 } else if (len == -1 && errno == EINVAL &&
1317 (aiocb->bs->open_flags & BDRV_O_NOCACHE) &&
1318 !(aiocb->aio_type & QEMU_AIO_WRITE) &&
1319 offset > 0) {
1320 /* O_DIRECT pread() may fail with EINVAL when offset is unaligned
1321 * after a short read. Assume that O_DIRECT short reads only occur
1322 * at EOF. Therefore this is a short read, not an I/O error.
1324 break;
1325 } else if (len == -1) {
1326 offset = -errno;
1327 break;
1328 } else if (len == 0) {
1329 break;
1331 offset += len;
1334 return offset;
1337 static int handle_aiocb_rw(void *opaque)
1339 RawPosixAIOData *aiocb = opaque;
1340 ssize_t nbytes;
1341 char *buf;
1343 if (!(aiocb->aio_type & QEMU_AIO_MISALIGNED)) {
1345 * If there is just a single buffer, and it is properly aligned
1346 * we can just use plain pread/pwrite without any problems.
1348 if (aiocb->io.niov == 1) {
1349 nbytes = handle_aiocb_rw_linear(aiocb, aiocb->io.iov->iov_base);
1350 goto out;
1353 * We have more than one iovec, and all are properly aligned.
1355 * Try preadv/pwritev first and fall back to linearizing the
1356 * buffer if it's not supported.
1358 if (preadv_present) {
1359 nbytes = handle_aiocb_rw_vector(aiocb);
1360 if (nbytes == aiocb->aio_nbytes ||
1361 (nbytes < 0 && nbytes != -ENOSYS)) {
1362 goto out;
1364 preadv_present = false;
1368 * XXX(hch): short read/write. no easy way to handle the reminder
1369 * using these interfaces. For now retry using plain
1370 * pread/pwrite?
1375 * Ok, we have to do it the hard way, copy all segments into
1376 * a single aligned buffer.
1378 buf = qemu_try_blockalign(aiocb->bs, aiocb->aio_nbytes);
1379 if (buf == NULL) {
1380 nbytes = -ENOMEM;
1381 goto out;
1384 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1385 char *p = buf;
1386 int i;
1388 for (i = 0; i < aiocb->io.niov; ++i) {
1389 memcpy(p, aiocb->io.iov[i].iov_base, aiocb->io.iov[i].iov_len);
1390 p += aiocb->io.iov[i].iov_len;
1392 assert(p - buf == aiocb->aio_nbytes);
1395 nbytes = handle_aiocb_rw_linear(aiocb, buf);
1396 if (!(aiocb->aio_type & QEMU_AIO_WRITE)) {
1397 char *p = buf;
1398 size_t count = aiocb->aio_nbytes, copy;
1399 int i;
1401 for (i = 0; i < aiocb->io.niov && count; ++i) {
1402 copy = count;
1403 if (copy > aiocb->io.iov[i].iov_len) {
1404 copy = aiocb->io.iov[i].iov_len;
1406 memcpy(aiocb->io.iov[i].iov_base, p, copy);
1407 assert(count >= copy);
1408 p += copy;
1409 count -= copy;
1411 assert(count == 0);
1413 qemu_vfree(buf);
1415 out:
1416 if (nbytes == aiocb->aio_nbytes) {
1417 return 0;
1418 } else if (nbytes >= 0 && nbytes < aiocb->aio_nbytes) {
1419 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1420 return -EINVAL;
1421 } else {
1422 iov_memset(aiocb->io.iov, aiocb->io.niov, nbytes,
1423 0, aiocb->aio_nbytes - nbytes);
1424 return 0;
1426 } else {
1427 assert(nbytes < 0);
1428 return nbytes;
1432 #ifdef CONFIG_XFS
1433 static int xfs_write_zeroes(BDRVRawState *s, int64_t offset, uint64_t bytes)
1435 struct xfs_flock64 fl;
1436 int err;
1438 memset(&fl, 0, sizeof(fl));
1439 fl.l_whence = SEEK_SET;
1440 fl.l_start = offset;
1441 fl.l_len = bytes;
1443 if (xfsctl(NULL, s->fd, XFS_IOC_ZERO_RANGE, &fl) < 0) {
1444 err = errno;
1445 trace_file_xfs_write_zeroes(strerror(errno));
1446 return -err;
1449 return 0;
1452 static int xfs_discard(BDRVRawState *s, int64_t offset, uint64_t bytes)
1454 struct xfs_flock64 fl;
1455 int err;
1457 memset(&fl, 0, sizeof(fl));
1458 fl.l_whence = SEEK_SET;
1459 fl.l_start = offset;
1460 fl.l_len = bytes;
1462 if (xfsctl(NULL, s->fd, XFS_IOC_UNRESVSP64, &fl) < 0) {
1463 err = errno;
1464 trace_file_xfs_discard(strerror(errno));
1465 return -err;
1468 return 0;
1470 #endif
1472 static int translate_err(int err)
1474 if (err == -ENODEV || err == -ENOSYS || err == -EOPNOTSUPP ||
1475 err == -ENOTTY) {
1476 err = -ENOTSUP;
1478 return err;
1481 #ifdef CONFIG_FALLOCATE
1482 static int do_fallocate(int fd, int mode, off_t offset, off_t len)
1484 do {
1485 if (fallocate(fd, mode, offset, len) == 0) {
1486 return 0;
1488 } while (errno == EINTR);
1489 return translate_err(-errno);
1491 #endif
1493 static ssize_t handle_aiocb_write_zeroes_block(RawPosixAIOData *aiocb)
1495 int ret = -ENOTSUP;
1496 BDRVRawState *s = aiocb->bs->opaque;
1498 if (!s->has_write_zeroes) {
1499 return -ENOTSUP;
1502 #ifdef BLKZEROOUT
1503 /* The BLKZEROOUT implementation in the kernel doesn't set
1504 * BLKDEV_ZERO_NOFALLBACK, so we can't call this if we have to avoid slow
1505 * fallbacks. */
1506 if (!(aiocb->aio_type & QEMU_AIO_NO_FALLBACK)) {
1507 do {
1508 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1509 if (ioctl(aiocb->aio_fildes, BLKZEROOUT, range) == 0) {
1510 return 0;
1512 } while (errno == EINTR);
1514 ret = translate_err(-errno);
1516 #endif
1518 if (ret == -ENOTSUP) {
1519 s->has_write_zeroes = false;
1521 return ret;
1524 static int handle_aiocb_write_zeroes(void *opaque)
1526 RawPosixAIOData *aiocb = opaque;
1527 #if defined(CONFIG_FALLOCATE) || defined(CONFIG_XFS)
1528 BDRVRawState *s = aiocb->bs->opaque;
1529 #endif
1530 #ifdef CONFIG_FALLOCATE
1531 int64_t len;
1532 #endif
1534 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1535 return handle_aiocb_write_zeroes_block(aiocb);
1538 #ifdef CONFIG_XFS
1539 if (s->is_xfs) {
1540 return xfs_write_zeroes(s, aiocb->aio_offset, aiocb->aio_nbytes);
1542 #endif
1544 #ifdef CONFIG_FALLOCATE_ZERO_RANGE
1545 if (s->has_write_zeroes) {
1546 int ret = do_fallocate(s->fd, FALLOC_FL_ZERO_RANGE,
1547 aiocb->aio_offset, aiocb->aio_nbytes);
1548 if (ret == 0 || ret != -ENOTSUP) {
1549 return ret;
1551 s->has_write_zeroes = false;
1553 #endif
1555 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1556 if (s->has_discard && s->has_fallocate) {
1557 int ret = do_fallocate(s->fd,
1558 FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1559 aiocb->aio_offset, aiocb->aio_nbytes);
1560 if (ret == 0) {
1561 ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1562 if (ret == 0 || ret != -ENOTSUP) {
1563 return ret;
1565 s->has_fallocate = false;
1566 } else if (ret != -ENOTSUP) {
1567 return ret;
1568 } else {
1569 s->has_discard = false;
1572 #endif
1574 #ifdef CONFIG_FALLOCATE
1575 /* Last resort: we are trying to extend the file with zeroed data. This
1576 * can be done via fallocate(fd, 0) */
1577 len = bdrv_getlength(aiocb->bs);
1578 if (s->has_fallocate && len >= 0 && aiocb->aio_offset >= len) {
1579 int ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1580 if (ret == 0 || ret != -ENOTSUP) {
1581 return ret;
1583 s->has_fallocate = false;
1585 #endif
1587 return -ENOTSUP;
1590 static int handle_aiocb_write_zeroes_unmap(void *opaque)
1592 RawPosixAIOData *aiocb = opaque;
1593 BDRVRawState *s G_GNUC_UNUSED = aiocb->bs->opaque;
1594 int ret;
1596 /* First try to write zeros and unmap at the same time */
1598 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1599 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1600 aiocb->aio_offset, aiocb->aio_nbytes);
1601 if (ret != -ENOTSUP) {
1602 return ret;
1604 #endif
1606 #ifdef CONFIG_XFS
1607 if (s->is_xfs) {
1608 /* xfs_discard() guarantees that the discarded area reads as all-zero
1609 * afterwards, so we can use it here. */
1610 return xfs_discard(s, aiocb->aio_offset, aiocb->aio_nbytes);
1612 #endif
1614 /* If we couldn't manage to unmap while guaranteed that the area reads as
1615 * all-zero afterwards, just write zeroes without unmapping */
1616 ret = handle_aiocb_write_zeroes(aiocb);
1617 return ret;
1620 #ifndef HAVE_COPY_FILE_RANGE
1621 static off_t copy_file_range(int in_fd, off_t *in_off, int out_fd,
1622 off_t *out_off, size_t len, unsigned int flags)
1624 #ifdef __NR_copy_file_range
1625 return syscall(__NR_copy_file_range, in_fd, in_off, out_fd,
1626 out_off, len, flags);
1627 #else
1628 errno = ENOSYS;
1629 return -1;
1630 #endif
1632 #endif
1634 static int handle_aiocb_copy_range(void *opaque)
1636 RawPosixAIOData *aiocb = opaque;
1637 uint64_t bytes = aiocb->aio_nbytes;
1638 off_t in_off = aiocb->aio_offset;
1639 off_t out_off = aiocb->copy_range.aio_offset2;
1641 while (bytes) {
1642 ssize_t ret = copy_file_range(aiocb->aio_fildes, &in_off,
1643 aiocb->copy_range.aio_fd2, &out_off,
1644 bytes, 0);
1645 trace_file_copy_file_range(aiocb->bs, aiocb->aio_fildes, in_off,
1646 aiocb->copy_range.aio_fd2, out_off, bytes,
1647 0, ret);
1648 if (ret == 0) {
1649 /* No progress (e.g. when beyond EOF), let the caller fall back to
1650 * buffer I/O. */
1651 return -ENOSPC;
1653 if (ret < 0) {
1654 switch (errno) {
1655 case ENOSYS:
1656 return -ENOTSUP;
1657 case EINTR:
1658 continue;
1659 default:
1660 return -errno;
1663 bytes -= ret;
1665 return 0;
1668 static int handle_aiocb_discard(void *opaque)
1670 RawPosixAIOData *aiocb = opaque;
1671 int ret = -EOPNOTSUPP;
1672 BDRVRawState *s = aiocb->bs->opaque;
1674 if (!s->has_discard) {
1675 return -ENOTSUP;
1678 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1679 #ifdef BLKDISCARD
1680 do {
1681 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1682 if (ioctl(aiocb->aio_fildes, BLKDISCARD, range) == 0) {
1683 return 0;
1685 } while (errno == EINTR);
1687 ret = -errno;
1688 #endif
1689 } else {
1690 #ifdef CONFIG_XFS
1691 if (s->is_xfs) {
1692 return xfs_discard(s, aiocb->aio_offset, aiocb->aio_nbytes);
1694 #endif
1696 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1697 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1698 aiocb->aio_offset, aiocb->aio_nbytes);
1699 #endif
1702 ret = translate_err(ret);
1703 if (ret == -ENOTSUP) {
1704 s->has_discard = false;
1706 return ret;
1709 static int handle_aiocb_truncate(void *opaque)
1711 RawPosixAIOData *aiocb = opaque;
1712 int result = 0;
1713 int64_t current_length = 0;
1714 char *buf = NULL;
1715 struct stat st;
1716 int fd = aiocb->aio_fildes;
1717 int64_t offset = aiocb->aio_offset;
1718 PreallocMode prealloc = aiocb->truncate.prealloc;
1719 Error **errp = aiocb->truncate.errp;
1721 if (fstat(fd, &st) < 0) {
1722 result = -errno;
1723 error_setg_errno(errp, -result, "Could not stat file");
1724 return result;
1727 current_length = st.st_size;
1728 if (current_length > offset && prealloc != PREALLOC_MODE_OFF) {
1729 error_setg(errp, "Cannot use preallocation for shrinking files");
1730 return -ENOTSUP;
1733 switch (prealloc) {
1734 #ifdef CONFIG_POSIX_FALLOCATE
1735 case PREALLOC_MODE_FALLOC:
1737 * Truncating before posix_fallocate() makes it about twice slower on
1738 * file systems that do not support fallocate(), trying to check if a
1739 * block is allocated before allocating it, so don't do that here.
1741 if (offset != current_length) {
1742 result = -posix_fallocate(fd, current_length,
1743 offset - current_length);
1744 if (result != 0) {
1745 /* posix_fallocate() doesn't set errno. */
1746 error_setg_errno(errp, -result,
1747 "Could not preallocate new data");
1749 } else {
1750 result = 0;
1752 goto out;
1753 #endif
1754 case PREALLOC_MODE_FULL:
1756 int64_t num = 0, left = offset - current_length;
1757 off_t seek_result;
1760 * Knowing the final size from the beginning could allow the file
1761 * system driver to do less allocations and possibly avoid
1762 * fragmentation of the file.
1764 if (ftruncate(fd, offset) != 0) {
1765 result = -errno;
1766 error_setg_errno(errp, -result, "Could not resize file");
1767 goto out;
1770 buf = g_malloc0(65536);
1772 seek_result = lseek(fd, current_length, SEEK_SET);
1773 if (seek_result < 0) {
1774 result = -errno;
1775 error_setg_errno(errp, -result,
1776 "Failed to seek to the old end of file");
1777 goto out;
1780 while (left > 0) {
1781 num = MIN(left, 65536);
1782 result = write(fd, buf, num);
1783 if (result < 0) {
1784 if (errno == EINTR) {
1785 continue;
1787 result = -errno;
1788 error_setg_errno(errp, -result,
1789 "Could not write zeros for preallocation");
1790 goto out;
1792 left -= result;
1794 if (result >= 0) {
1795 result = fsync(fd);
1796 if (result < 0) {
1797 result = -errno;
1798 error_setg_errno(errp, -result,
1799 "Could not flush file to disk");
1800 goto out;
1803 goto out;
1805 case PREALLOC_MODE_OFF:
1806 if (ftruncate(fd, offset) != 0) {
1807 result = -errno;
1808 error_setg_errno(errp, -result, "Could not resize file");
1810 return result;
1811 default:
1812 result = -ENOTSUP;
1813 error_setg(errp, "Unsupported preallocation mode: %s",
1814 PreallocMode_str(prealloc));
1815 return result;
1818 out:
1819 if (result < 0) {
1820 if (ftruncate(fd, current_length) < 0) {
1821 error_report("Failed to restore old file length: %s",
1822 strerror(errno));
1826 g_free(buf);
1827 return result;
1830 static int coroutine_fn raw_thread_pool_submit(BlockDriverState *bs,
1831 ThreadPoolFunc func, void *arg)
1833 /* @bs can be NULL, bdrv_get_aio_context() returns the main context then */
1834 ThreadPool *pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
1835 return thread_pool_submit_co(pool, func, arg);
1838 static int coroutine_fn raw_co_prw(BlockDriverState *bs, uint64_t offset,
1839 uint64_t bytes, QEMUIOVector *qiov, int type)
1841 BDRVRawState *s = bs->opaque;
1842 RawPosixAIOData acb;
1844 if (fd_open(bs) < 0)
1845 return -EIO;
1848 * Check if the underlying device requires requests to be aligned,
1849 * and if the request we are trying to submit is aligned or not.
1850 * If this is the case tell the low-level driver that it needs
1851 * to copy the buffer.
1853 if (s->needs_alignment) {
1854 if (!bdrv_qiov_is_aligned(bs, qiov)) {
1855 type |= QEMU_AIO_MISALIGNED;
1856 #ifdef CONFIG_LINUX_AIO
1857 } else if (s->use_linux_aio) {
1858 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1859 assert(qiov->size == bytes);
1860 return laio_co_submit(bs, aio, s->fd, offset, qiov, type);
1861 #endif
1865 acb = (RawPosixAIOData) {
1866 .bs = bs,
1867 .aio_fildes = s->fd,
1868 .aio_type = type,
1869 .aio_offset = offset,
1870 .aio_nbytes = bytes,
1871 .io = {
1872 .iov = qiov->iov,
1873 .niov = qiov->niov,
1877 assert(qiov->size == bytes);
1878 return raw_thread_pool_submit(bs, handle_aiocb_rw, &acb);
1881 static int coroutine_fn raw_co_preadv(BlockDriverState *bs, uint64_t offset,
1882 uint64_t bytes, QEMUIOVector *qiov,
1883 int flags)
1885 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_READ);
1888 static int coroutine_fn raw_co_pwritev(BlockDriverState *bs, uint64_t offset,
1889 uint64_t bytes, QEMUIOVector *qiov,
1890 int flags)
1892 assert(flags == 0);
1893 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_WRITE);
1896 static void raw_aio_plug(BlockDriverState *bs)
1898 #ifdef CONFIG_LINUX_AIO
1899 BDRVRawState *s = bs->opaque;
1900 if (s->use_linux_aio) {
1901 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1902 laio_io_plug(bs, aio);
1904 #endif
1907 static void raw_aio_unplug(BlockDriverState *bs)
1909 #ifdef CONFIG_LINUX_AIO
1910 BDRVRawState *s = bs->opaque;
1911 if (s->use_linux_aio) {
1912 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1913 laio_io_unplug(bs, aio);
1915 #endif
1918 static int raw_co_flush_to_disk(BlockDriverState *bs)
1920 BDRVRawState *s = bs->opaque;
1921 RawPosixAIOData acb;
1922 int ret;
1924 ret = fd_open(bs);
1925 if (ret < 0) {
1926 return ret;
1929 acb = (RawPosixAIOData) {
1930 .bs = bs,
1931 .aio_fildes = s->fd,
1932 .aio_type = QEMU_AIO_FLUSH,
1935 return raw_thread_pool_submit(bs, handle_aiocb_flush, &acb);
1938 static void raw_aio_attach_aio_context(BlockDriverState *bs,
1939 AioContext *new_context)
1941 #ifdef CONFIG_LINUX_AIO
1942 BDRVRawState *s = bs->opaque;
1943 if (s->use_linux_aio) {
1944 Error *local_err;
1945 if (!aio_setup_linux_aio(new_context, &local_err)) {
1946 error_reportf_err(local_err, "Unable to use native AIO, "
1947 "falling back to thread pool: ");
1948 s->use_linux_aio = false;
1951 #endif
1954 static void raw_close(BlockDriverState *bs)
1956 BDRVRawState *s = bs->opaque;
1958 if (s->fd >= 0) {
1959 qemu_close(s->fd);
1960 s->fd = -1;
1965 * Truncates the given regular file @fd to @offset and, when growing, fills the
1966 * new space according to @prealloc.
1968 * Returns: 0 on success, -errno on failure.
1970 static int coroutine_fn
1971 raw_regular_truncate(BlockDriverState *bs, int fd, int64_t offset,
1972 PreallocMode prealloc, Error **errp)
1974 RawPosixAIOData acb;
1976 acb = (RawPosixAIOData) {
1977 .bs = bs,
1978 .aio_fildes = fd,
1979 .aio_type = QEMU_AIO_TRUNCATE,
1980 .aio_offset = offset,
1981 .truncate = {
1982 .prealloc = prealloc,
1983 .errp = errp,
1987 return raw_thread_pool_submit(bs, handle_aiocb_truncate, &acb);
1990 static int coroutine_fn raw_co_truncate(BlockDriverState *bs, int64_t offset,
1991 PreallocMode prealloc, Error **errp)
1993 BDRVRawState *s = bs->opaque;
1994 struct stat st;
1995 int ret;
1997 if (fstat(s->fd, &st)) {
1998 ret = -errno;
1999 error_setg_errno(errp, -ret, "Failed to fstat() the file");
2000 return ret;
2003 if (S_ISREG(st.st_mode)) {
2004 return raw_regular_truncate(bs, s->fd, offset, prealloc, errp);
2007 if (prealloc != PREALLOC_MODE_OFF) {
2008 error_setg(errp, "Preallocation mode '%s' unsupported for this "
2009 "non-regular file", PreallocMode_str(prealloc));
2010 return -ENOTSUP;
2013 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2014 if (offset > raw_getlength(bs)) {
2015 error_setg(errp, "Cannot grow device files");
2016 return -EINVAL;
2018 } else {
2019 error_setg(errp, "Resizing this file is not supported");
2020 return -ENOTSUP;
2023 return 0;
2026 #ifdef __OpenBSD__
2027 static int64_t raw_getlength(BlockDriverState *bs)
2029 BDRVRawState *s = bs->opaque;
2030 int fd = s->fd;
2031 struct stat st;
2033 if (fstat(fd, &st))
2034 return -errno;
2035 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2036 struct disklabel dl;
2038 if (ioctl(fd, DIOCGDINFO, &dl))
2039 return -errno;
2040 return (uint64_t)dl.d_secsize *
2041 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2042 } else
2043 return st.st_size;
2045 #elif defined(__NetBSD__)
2046 static int64_t raw_getlength(BlockDriverState *bs)
2048 BDRVRawState *s = bs->opaque;
2049 int fd = s->fd;
2050 struct stat st;
2052 if (fstat(fd, &st))
2053 return -errno;
2054 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2055 struct dkwedge_info dkw;
2057 if (ioctl(fd, DIOCGWEDGEINFO, &dkw) != -1) {
2058 return dkw.dkw_size * 512;
2059 } else {
2060 struct disklabel dl;
2062 if (ioctl(fd, DIOCGDINFO, &dl))
2063 return -errno;
2064 return (uint64_t)dl.d_secsize *
2065 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2067 } else
2068 return st.st_size;
2070 #elif defined(__sun__)
2071 static int64_t raw_getlength(BlockDriverState *bs)
2073 BDRVRawState *s = bs->opaque;
2074 struct dk_minfo minfo;
2075 int ret;
2076 int64_t size;
2078 ret = fd_open(bs);
2079 if (ret < 0) {
2080 return ret;
2084 * Use the DKIOCGMEDIAINFO ioctl to read the size.
2086 ret = ioctl(s->fd, DKIOCGMEDIAINFO, &minfo);
2087 if (ret != -1) {
2088 return minfo.dki_lbsize * minfo.dki_capacity;
2092 * There are reports that lseek on some devices fails, but
2093 * irc discussion said that contingency on contingency was overkill.
2095 size = lseek(s->fd, 0, SEEK_END);
2096 if (size < 0) {
2097 return -errno;
2099 return size;
2101 #elif defined(CONFIG_BSD)
2102 static int64_t raw_getlength(BlockDriverState *bs)
2104 BDRVRawState *s = bs->opaque;
2105 int fd = s->fd;
2106 int64_t size;
2107 struct stat sb;
2108 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2109 int reopened = 0;
2110 #endif
2111 int ret;
2113 ret = fd_open(bs);
2114 if (ret < 0)
2115 return ret;
2117 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2118 again:
2119 #endif
2120 if (!fstat(fd, &sb) && (S_IFCHR & sb.st_mode)) {
2121 #ifdef DIOCGMEDIASIZE
2122 if (ioctl(fd, DIOCGMEDIASIZE, (off_t *)&size))
2123 #elif defined(DIOCGPART)
2125 struct partinfo pi;
2126 if (ioctl(fd, DIOCGPART, &pi) == 0)
2127 size = pi.media_size;
2128 else
2129 size = 0;
2131 if (size == 0)
2132 #endif
2133 #if defined(__APPLE__) && defined(__MACH__)
2135 uint64_t sectors = 0;
2136 uint32_t sector_size = 0;
2138 if (ioctl(fd, DKIOCGETBLOCKCOUNT, &sectors) == 0
2139 && ioctl(fd, DKIOCGETBLOCKSIZE, &sector_size) == 0) {
2140 size = sectors * sector_size;
2141 } else {
2142 size = lseek(fd, 0LL, SEEK_END);
2143 if (size < 0) {
2144 return -errno;
2148 #else
2149 size = lseek(fd, 0LL, SEEK_END);
2150 if (size < 0) {
2151 return -errno;
2153 #endif
2154 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
2155 switch(s->type) {
2156 case FTYPE_CD:
2157 /* XXX FreeBSD acd returns UINT_MAX sectors for an empty drive */
2158 if (size == 2048LL * (unsigned)-1)
2159 size = 0;
2160 /* XXX no disc? maybe we need to reopen... */
2161 if (size <= 0 && !reopened && cdrom_reopen(bs) >= 0) {
2162 reopened = 1;
2163 goto again;
2166 #endif
2167 } else {
2168 size = lseek(fd, 0, SEEK_END);
2169 if (size < 0) {
2170 return -errno;
2173 return size;
2175 #else
2176 static int64_t raw_getlength(BlockDriverState *bs)
2178 BDRVRawState *s = bs->opaque;
2179 int ret;
2180 int64_t size;
2182 ret = fd_open(bs);
2183 if (ret < 0) {
2184 return ret;
2187 size = lseek(s->fd, 0, SEEK_END);
2188 if (size < 0) {
2189 return -errno;
2191 return size;
2193 #endif
2195 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
2197 struct stat st;
2198 BDRVRawState *s = bs->opaque;
2200 if (fstat(s->fd, &st) < 0) {
2201 return -errno;
2203 return (int64_t)st.st_blocks * 512;
2206 static int coroutine_fn
2207 raw_co_create(BlockdevCreateOptions *options, Error **errp)
2209 BlockdevCreateOptionsFile *file_opts;
2210 Error *local_err = NULL;
2211 int fd;
2212 uint64_t perm, shared;
2213 int result = 0;
2215 /* Validate options and set default values */
2216 assert(options->driver == BLOCKDEV_DRIVER_FILE);
2217 file_opts = &options->u.file;
2219 if (!file_opts->has_nocow) {
2220 file_opts->nocow = false;
2222 if (!file_opts->has_preallocation) {
2223 file_opts->preallocation = PREALLOC_MODE_OFF;
2226 /* Create file */
2227 fd = qemu_open(file_opts->filename, O_RDWR | O_CREAT | O_BINARY, 0644);
2228 if (fd < 0) {
2229 result = -errno;
2230 error_setg_errno(errp, -result, "Could not create file");
2231 goto out;
2234 /* Take permissions: We want to discard everything, so we need
2235 * BLK_PERM_WRITE; and truncation to the desired size requires
2236 * BLK_PERM_RESIZE.
2237 * On the other hand, we cannot share the RESIZE permission
2238 * because we promise that after this function, the file has the
2239 * size given in the options. If someone else were to resize it
2240 * concurrently, we could not guarantee that.
2241 * Note that after this function, we can no longer guarantee that
2242 * the file is not touched by a third party, so it may be resized
2243 * then. */
2244 perm = BLK_PERM_WRITE | BLK_PERM_RESIZE;
2245 shared = BLK_PERM_ALL & ~BLK_PERM_RESIZE;
2247 /* Step one: Take locks */
2248 result = raw_apply_lock_bytes(NULL, fd, perm, ~shared, false, errp);
2249 if (result < 0) {
2250 goto out_close;
2253 /* Step two: Check that nobody else has taken conflicting locks */
2254 result = raw_check_lock_bytes(fd, perm, shared, errp);
2255 if (result < 0) {
2256 error_append_hint(errp,
2257 "Is another process using the image [%s]?\n",
2258 file_opts->filename);
2259 goto out_unlock;
2262 /* Clear the file by truncating it to 0 */
2263 result = raw_regular_truncate(NULL, fd, 0, PREALLOC_MODE_OFF, errp);
2264 if (result < 0) {
2265 goto out_unlock;
2268 if (file_opts->nocow) {
2269 #ifdef __linux__
2270 /* Set NOCOW flag to solve performance issue on fs like btrfs.
2271 * This is an optimisation. The FS_IOC_SETFLAGS ioctl return value
2272 * will be ignored since any failure of this operation should not
2273 * block the left work.
2275 int attr;
2276 if (ioctl(fd, FS_IOC_GETFLAGS, &attr) == 0) {
2277 attr |= FS_NOCOW_FL;
2278 ioctl(fd, FS_IOC_SETFLAGS, &attr);
2280 #endif
2283 /* Resize and potentially preallocate the file to the desired
2284 * final size */
2285 result = raw_regular_truncate(NULL, fd, file_opts->size,
2286 file_opts->preallocation, errp);
2287 if (result < 0) {
2288 goto out_unlock;
2291 out_unlock:
2292 raw_apply_lock_bytes(NULL, fd, 0, 0, true, &local_err);
2293 if (local_err) {
2294 /* The above call should not fail, and if it does, that does
2295 * not mean the whole creation operation has failed. So
2296 * report it the user for their convenience, but do not report
2297 * it to the caller. */
2298 warn_report_err(local_err);
2301 out_close:
2302 if (qemu_close(fd) != 0 && result == 0) {
2303 result = -errno;
2304 error_setg_errno(errp, -result, "Could not close the new file");
2306 out:
2307 return result;
2310 static int coroutine_fn raw_co_create_opts(const char *filename, QemuOpts *opts,
2311 Error **errp)
2313 BlockdevCreateOptions options;
2314 int64_t total_size = 0;
2315 bool nocow = false;
2316 PreallocMode prealloc;
2317 char *buf = NULL;
2318 Error *local_err = NULL;
2320 /* Skip file: protocol prefix */
2321 strstart(filename, "file:", &filename);
2323 /* Read out options */
2324 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2325 BDRV_SECTOR_SIZE);
2326 nocow = qemu_opt_get_bool(opts, BLOCK_OPT_NOCOW, false);
2327 buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
2328 prealloc = qapi_enum_parse(&PreallocMode_lookup, buf,
2329 PREALLOC_MODE_OFF, &local_err);
2330 g_free(buf);
2331 if (local_err) {
2332 error_propagate(errp, local_err);
2333 return -EINVAL;
2336 options = (BlockdevCreateOptions) {
2337 .driver = BLOCKDEV_DRIVER_FILE,
2338 .u.file = {
2339 .filename = (char *) filename,
2340 .size = total_size,
2341 .has_preallocation = true,
2342 .preallocation = prealloc,
2343 .has_nocow = true,
2344 .nocow = nocow,
2347 return raw_co_create(&options, errp);
2351 * Find allocation range in @bs around offset @start.
2352 * May change underlying file descriptor's file offset.
2353 * If @start is not in a hole, store @start in @data, and the
2354 * beginning of the next hole in @hole, and return 0.
2355 * If @start is in a non-trailing hole, store @start in @hole and the
2356 * beginning of the next non-hole in @data, and return 0.
2357 * If @start is in a trailing hole or beyond EOF, return -ENXIO.
2358 * If we can't find out, return a negative errno other than -ENXIO.
2360 static int find_allocation(BlockDriverState *bs, off_t start,
2361 off_t *data, off_t *hole)
2363 #if defined SEEK_HOLE && defined SEEK_DATA
2364 BDRVRawState *s = bs->opaque;
2365 off_t offs;
2368 * SEEK_DATA cases:
2369 * D1. offs == start: start is in data
2370 * D2. offs > start: start is in a hole, next data at offs
2371 * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
2372 * or start is beyond EOF
2373 * If the latter happens, the file has been truncated behind
2374 * our back since we opened it. All bets are off then.
2375 * Treating like a trailing hole is simplest.
2376 * D4. offs < 0, errno != ENXIO: we learned nothing
2378 offs = lseek(s->fd, start, SEEK_DATA);
2379 if (offs < 0) {
2380 return -errno; /* D3 or D4 */
2383 if (offs < start) {
2384 /* This is not a valid return by lseek(). We are safe to just return
2385 * -EIO in this case, and we'll treat it like D4. */
2386 return -EIO;
2389 if (offs > start) {
2390 /* D2: in hole, next data at offs */
2391 *hole = start;
2392 *data = offs;
2393 return 0;
2396 /* D1: in data, end not yet known */
2399 * SEEK_HOLE cases:
2400 * H1. offs == start: start is in a hole
2401 * If this happens here, a hole has been dug behind our back
2402 * since the previous lseek().
2403 * H2. offs > start: either start is in data, next hole at offs,
2404 * or start is in trailing hole, EOF at offs
2405 * Linux treats trailing holes like any other hole: offs ==
2406 * start. Solaris seeks to EOF instead: offs > start (blech).
2407 * If that happens here, a hole has been dug behind our back
2408 * since the previous lseek().
2409 * H3. offs < 0, errno = ENXIO: start is beyond EOF
2410 * If this happens, the file has been truncated behind our
2411 * back since we opened it. Treat it like a trailing hole.
2412 * H4. offs < 0, errno != ENXIO: we learned nothing
2413 * Pretend we know nothing at all, i.e. "forget" about D1.
2415 offs = lseek(s->fd, start, SEEK_HOLE);
2416 if (offs < 0) {
2417 return -errno; /* D1 and (H3 or H4) */
2420 if (offs < start) {
2421 /* This is not a valid return by lseek(). We are safe to just return
2422 * -EIO in this case, and we'll treat it like H4. */
2423 return -EIO;
2426 if (offs > start) {
2428 * D1 and H2: either in data, next hole at offs, or it was in
2429 * data but is now in a trailing hole. In the latter case,
2430 * all bets are off. Treating it as if it there was data all
2431 * the way to EOF is safe, so simply do that.
2433 *data = start;
2434 *hole = offs;
2435 return 0;
2438 /* D1 and H1 */
2439 return -EBUSY;
2440 #else
2441 return -ENOTSUP;
2442 #endif
2446 * Returns the allocation status of the specified offset.
2448 * The block layer guarantees 'offset' and 'bytes' are within bounds.
2450 * 'pnum' is set to the number of bytes (including and immediately following
2451 * the specified offset) that are known to be in the same
2452 * allocated/unallocated state.
2454 * 'bytes' is the max value 'pnum' should be set to.
2456 static int coroutine_fn raw_co_block_status(BlockDriverState *bs,
2457 bool want_zero,
2458 int64_t offset,
2459 int64_t bytes, int64_t *pnum,
2460 int64_t *map,
2461 BlockDriverState **file)
2463 off_t data = 0, hole = 0;
2464 int ret;
2466 ret = fd_open(bs);
2467 if (ret < 0) {
2468 return ret;
2471 if (!want_zero) {
2472 *pnum = bytes;
2473 *map = offset;
2474 *file = bs;
2475 return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
2478 ret = find_allocation(bs, offset, &data, &hole);
2479 if (ret == -ENXIO) {
2480 /* Trailing hole */
2481 *pnum = bytes;
2482 ret = BDRV_BLOCK_ZERO;
2483 } else if (ret < 0) {
2484 /* No info available, so pretend there are no holes */
2485 *pnum = bytes;
2486 ret = BDRV_BLOCK_DATA;
2487 } else if (data == offset) {
2488 /* On a data extent, compute bytes to the end of the extent,
2489 * possibly including a partial sector at EOF. */
2490 *pnum = MIN(bytes, hole - offset);
2491 ret = BDRV_BLOCK_DATA;
2492 } else {
2493 /* On a hole, compute bytes to the beginning of the next extent. */
2494 assert(hole == offset);
2495 *pnum = MIN(bytes, data - offset);
2496 ret = BDRV_BLOCK_ZERO;
2498 *map = offset;
2499 *file = bs;
2500 return ret | BDRV_BLOCK_OFFSET_VALID;
2503 #if defined(__linux__)
2504 /* Verify that the file is not in the page cache */
2505 static void check_cache_dropped(BlockDriverState *bs, Error **errp)
2507 const size_t window_size = 128 * 1024 * 1024;
2508 BDRVRawState *s = bs->opaque;
2509 void *window = NULL;
2510 size_t length = 0;
2511 unsigned char *vec;
2512 size_t page_size;
2513 off_t offset;
2514 off_t end;
2516 /* mincore(2) page status information requires 1 byte per page */
2517 page_size = sysconf(_SC_PAGESIZE);
2518 vec = g_malloc(DIV_ROUND_UP(window_size, page_size));
2520 end = raw_getlength(bs);
2522 for (offset = 0; offset < end; offset += window_size) {
2523 void *new_window;
2524 size_t new_length;
2525 size_t vec_end;
2526 size_t i;
2527 int ret;
2529 /* Unmap previous window if size has changed */
2530 new_length = MIN(end - offset, window_size);
2531 if (new_length != length) {
2532 munmap(window, length);
2533 window = NULL;
2534 length = 0;
2537 new_window = mmap(window, new_length, PROT_NONE, MAP_PRIVATE,
2538 s->fd, offset);
2539 if (new_window == MAP_FAILED) {
2540 error_setg_errno(errp, errno, "mmap failed");
2541 break;
2544 window = new_window;
2545 length = new_length;
2547 ret = mincore(window, length, vec);
2548 if (ret < 0) {
2549 error_setg_errno(errp, errno, "mincore failed");
2550 break;
2553 vec_end = DIV_ROUND_UP(length, page_size);
2554 for (i = 0; i < vec_end; i++) {
2555 if (vec[i] & 0x1) {
2556 error_setg(errp, "page cache still in use!");
2557 break;
2562 if (window) {
2563 munmap(window, length);
2566 g_free(vec);
2568 #endif /* __linux__ */
2570 static void coroutine_fn raw_co_invalidate_cache(BlockDriverState *bs,
2571 Error **errp)
2573 BDRVRawState *s = bs->opaque;
2574 int ret;
2576 ret = fd_open(bs);
2577 if (ret < 0) {
2578 error_setg_errno(errp, -ret, "The file descriptor is not open");
2579 return;
2582 if (!s->drop_cache) {
2583 return;
2586 if (s->open_flags & O_DIRECT) {
2587 return; /* No host kernel page cache */
2590 #if defined(__linux__)
2591 /* This sets the scene for the next syscall... */
2592 ret = bdrv_co_flush(bs);
2593 if (ret < 0) {
2594 error_setg_errno(errp, -ret, "flush failed");
2595 return;
2598 /* Linux does not invalidate pages that are dirty, locked, or mmapped by a
2599 * process. These limitations are okay because we just fsynced the file,
2600 * we don't use mmap, and the file should not be in use by other processes.
2602 ret = posix_fadvise(s->fd, 0, 0, POSIX_FADV_DONTNEED);
2603 if (ret != 0) { /* the return value is a positive errno */
2604 error_setg_errno(errp, ret, "fadvise failed");
2605 return;
2608 if (s->check_cache_dropped) {
2609 check_cache_dropped(bs, errp);
2611 #else /* __linux__ */
2612 /* Do nothing. Live migration to a remote host with cache.direct=off is
2613 * unsupported on other host operating systems. Cache consistency issues
2614 * may occur but no error is reported here, partly because that's the
2615 * historical behavior and partly because it's hard to differentiate valid
2616 * configurations that should not cause errors.
2618 #endif /* !__linux__ */
2621 static coroutine_fn int
2622 raw_do_pdiscard(BlockDriverState *bs, int64_t offset, int bytes, bool blkdev)
2624 BDRVRawState *s = bs->opaque;
2625 RawPosixAIOData acb;
2627 acb = (RawPosixAIOData) {
2628 .bs = bs,
2629 .aio_fildes = s->fd,
2630 .aio_type = QEMU_AIO_DISCARD,
2631 .aio_offset = offset,
2632 .aio_nbytes = bytes,
2635 if (blkdev) {
2636 acb.aio_type |= QEMU_AIO_BLKDEV;
2639 return raw_thread_pool_submit(bs, handle_aiocb_discard, &acb);
2642 static coroutine_fn int
2643 raw_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
2645 return raw_do_pdiscard(bs, offset, bytes, false);
2648 static int coroutine_fn
2649 raw_do_pwrite_zeroes(BlockDriverState *bs, int64_t offset, int bytes,
2650 BdrvRequestFlags flags, bool blkdev)
2652 BDRVRawState *s = bs->opaque;
2653 RawPosixAIOData acb;
2654 ThreadPoolFunc *handler;
2656 acb = (RawPosixAIOData) {
2657 .bs = bs,
2658 .aio_fildes = s->fd,
2659 .aio_type = QEMU_AIO_WRITE_ZEROES,
2660 .aio_offset = offset,
2661 .aio_nbytes = bytes,
2664 if (blkdev) {
2665 acb.aio_type |= QEMU_AIO_BLKDEV;
2667 if (flags & BDRV_REQ_NO_FALLBACK) {
2668 acb.aio_type |= QEMU_AIO_NO_FALLBACK;
2671 if (flags & BDRV_REQ_MAY_UNMAP) {
2672 acb.aio_type |= QEMU_AIO_DISCARD;
2673 handler = handle_aiocb_write_zeroes_unmap;
2674 } else {
2675 handler = handle_aiocb_write_zeroes;
2678 return raw_thread_pool_submit(bs, handler, &acb);
2681 static int coroutine_fn raw_co_pwrite_zeroes(
2682 BlockDriverState *bs, int64_t offset,
2683 int bytes, BdrvRequestFlags flags)
2685 return raw_do_pwrite_zeroes(bs, offset, bytes, flags, false);
2688 static int raw_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2690 BDRVRawState *s = bs->opaque;
2692 bdi->unallocated_blocks_are_zero = s->discard_zeroes;
2693 return 0;
2696 static QemuOptsList raw_create_opts = {
2697 .name = "raw-create-opts",
2698 .head = QTAILQ_HEAD_INITIALIZER(raw_create_opts.head),
2699 .desc = {
2701 .name = BLOCK_OPT_SIZE,
2702 .type = QEMU_OPT_SIZE,
2703 .help = "Virtual disk size"
2706 .name = BLOCK_OPT_NOCOW,
2707 .type = QEMU_OPT_BOOL,
2708 .help = "Turn off copy-on-write (valid only on btrfs)"
2711 .name = BLOCK_OPT_PREALLOC,
2712 .type = QEMU_OPT_STRING,
2713 .help = "Preallocation mode (allowed values: off, falloc, full)"
2715 { /* end of list */ }
2719 static int raw_check_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared,
2720 Error **errp)
2722 BDRVRawState *s = bs->opaque;
2723 BDRVRawReopenState *rs = NULL;
2724 int open_flags;
2725 int ret;
2727 if (s->perm_change_fd) {
2729 * In the context of reopen, this function may be called several times
2730 * (directly and recursively while change permissions of the parent).
2731 * This is even true for children that don't inherit from the original
2732 * reopen node, so s->reopen_state is not set.
2734 * Ignore all but the first call.
2736 return 0;
2739 if (s->reopen_state) {
2740 /* We already have a new file descriptor to set permissions for */
2741 assert(s->reopen_state->perm == perm);
2742 assert(s->reopen_state->shared_perm == shared);
2743 rs = s->reopen_state->opaque;
2744 s->perm_change_fd = rs->fd;
2745 } else {
2746 /* We may need a new fd if auto-read-only switches the mode */
2747 ret = raw_reconfigure_getfd(bs, bs->open_flags, &open_flags, perm,
2748 false, errp);
2749 if (ret < 0) {
2750 return ret;
2751 } else if (ret != s->fd) {
2752 s->perm_change_fd = ret;
2756 /* Prepare permissions on old fd to avoid conflicts between old and new,
2757 * but keep everything locked that new will need. */
2758 ret = raw_handle_perm_lock(bs, RAW_PL_PREPARE, perm, shared, errp);
2759 if (ret < 0) {
2760 goto fail;
2763 /* Copy locks to the new fd */
2764 if (s->perm_change_fd) {
2765 ret = raw_apply_lock_bytes(NULL, s->perm_change_fd, perm, ~shared,
2766 false, errp);
2767 if (ret < 0) {
2768 raw_handle_perm_lock(bs, RAW_PL_ABORT, 0, 0, NULL);
2769 goto fail;
2772 return 0;
2774 fail:
2775 if (s->perm_change_fd && !s->reopen_state) {
2776 qemu_close(s->perm_change_fd);
2778 s->perm_change_fd = 0;
2779 return ret;
2782 static void raw_set_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared)
2784 BDRVRawState *s = bs->opaque;
2786 /* For reopen, we have already switched to the new fd (.bdrv_set_perm is
2787 * called after .bdrv_reopen_commit) */
2788 if (s->perm_change_fd && s->fd != s->perm_change_fd) {
2789 qemu_close(s->fd);
2790 s->fd = s->perm_change_fd;
2792 s->perm_change_fd = 0;
2794 raw_handle_perm_lock(bs, RAW_PL_COMMIT, perm, shared, NULL);
2795 s->perm = perm;
2796 s->shared_perm = shared;
2799 static void raw_abort_perm_update(BlockDriverState *bs)
2801 BDRVRawState *s = bs->opaque;
2803 /* For reopen, .bdrv_reopen_abort is called afterwards and will close
2804 * the file descriptor. */
2805 if (s->perm_change_fd && !s->reopen_state) {
2806 qemu_close(s->perm_change_fd);
2808 s->perm_change_fd = 0;
2810 raw_handle_perm_lock(bs, RAW_PL_ABORT, 0, 0, NULL);
2813 static int coroutine_fn raw_co_copy_range_from(
2814 BlockDriverState *bs, BdrvChild *src, uint64_t src_offset,
2815 BdrvChild *dst, uint64_t dst_offset, uint64_t bytes,
2816 BdrvRequestFlags read_flags, BdrvRequestFlags write_flags)
2818 return bdrv_co_copy_range_to(src, src_offset, dst, dst_offset, bytes,
2819 read_flags, write_flags);
2822 static int coroutine_fn raw_co_copy_range_to(BlockDriverState *bs,
2823 BdrvChild *src,
2824 uint64_t src_offset,
2825 BdrvChild *dst,
2826 uint64_t dst_offset,
2827 uint64_t bytes,
2828 BdrvRequestFlags read_flags,
2829 BdrvRequestFlags write_flags)
2831 RawPosixAIOData acb;
2832 BDRVRawState *s = bs->opaque;
2833 BDRVRawState *src_s;
2835 assert(dst->bs == bs);
2836 if (src->bs->drv->bdrv_co_copy_range_to != raw_co_copy_range_to) {
2837 return -ENOTSUP;
2840 src_s = src->bs->opaque;
2841 if (fd_open(src->bs) < 0 || fd_open(dst->bs) < 0) {
2842 return -EIO;
2845 acb = (RawPosixAIOData) {
2846 .bs = bs,
2847 .aio_type = QEMU_AIO_COPY_RANGE,
2848 .aio_fildes = src_s->fd,
2849 .aio_offset = src_offset,
2850 .aio_nbytes = bytes,
2851 .copy_range = {
2852 .aio_fd2 = s->fd,
2853 .aio_offset2 = dst_offset,
2857 return raw_thread_pool_submit(bs, handle_aiocb_copy_range, &acb);
2860 BlockDriver bdrv_file = {
2861 .format_name = "file",
2862 .protocol_name = "file",
2863 .instance_size = sizeof(BDRVRawState),
2864 .bdrv_needs_filename = true,
2865 .bdrv_probe = NULL, /* no probe for protocols */
2866 .bdrv_parse_filename = raw_parse_filename,
2867 .bdrv_file_open = raw_open,
2868 .bdrv_reopen_prepare = raw_reopen_prepare,
2869 .bdrv_reopen_commit = raw_reopen_commit,
2870 .bdrv_reopen_abort = raw_reopen_abort,
2871 .bdrv_close = raw_close,
2872 .bdrv_co_create = raw_co_create,
2873 .bdrv_co_create_opts = raw_co_create_opts,
2874 .bdrv_has_zero_init = bdrv_has_zero_init_1,
2875 .bdrv_co_block_status = raw_co_block_status,
2876 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
2877 .bdrv_co_pwrite_zeroes = raw_co_pwrite_zeroes,
2879 .bdrv_co_preadv = raw_co_preadv,
2880 .bdrv_co_pwritev = raw_co_pwritev,
2881 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
2882 .bdrv_co_pdiscard = raw_co_pdiscard,
2883 .bdrv_co_copy_range_from = raw_co_copy_range_from,
2884 .bdrv_co_copy_range_to = raw_co_copy_range_to,
2885 .bdrv_refresh_limits = raw_refresh_limits,
2886 .bdrv_io_plug = raw_aio_plug,
2887 .bdrv_io_unplug = raw_aio_unplug,
2888 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
2890 .bdrv_co_truncate = raw_co_truncate,
2891 .bdrv_getlength = raw_getlength,
2892 .bdrv_get_info = raw_get_info,
2893 .bdrv_get_allocated_file_size
2894 = raw_get_allocated_file_size,
2895 .bdrv_check_perm = raw_check_perm,
2896 .bdrv_set_perm = raw_set_perm,
2897 .bdrv_abort_perm_update = raw_abort_perm_update,
2898 .create_opts = &raw_create_opts,
2899 .mutable_opts = mutable_opts,
2902 /***********************************************/
2903 /* host device */
2905 #if defined(__APPLE__) && defined(__MACH__)
2906 static kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
2907 CFIndex maxPathSize, int flags);
2908 static char *FindEjectableOpticalMedia(io_iterator_t *mediaIterator)
2910 kern_return_t kernResult = KERN_FAILURE;
2911 mach_port_t masterPort;
2912 CFMutableDictionaryRef classesToMatch;
2913 const char *matching_array[] = {kIODVDMediaClass, kIOCDMediaClass};
2914 char *mediaType = NULL;
2916 kernResult = IOMasterPort( MACH_PORT_NULL, &masterPort );
2917 if ( KERN_SUCCESS != kernResult ) {
2918 printf( "IOMasterPort returned %d\n", kernResult );
2921 int index;
2922 for (index = 0; index < ARRAY_SIZE(matching_array); index++) {
2923 classesToMatch = IOServiceMatching(matching_array[index]);
2924 if (classesToMatch == NULL) {
2925 error_report("IOServiceMatching returned NULL for %s",
2926 matching_array[index]);
2927 continue;
2929 CFDictionarySetValue(classesToMatch, CFSTR(kIOMediaEjectableKey),
2930 kCFBooleanTrue);
2931 kernResult = IOServiceGetMatchingServices(masterPort, classesToMatch,
2932 mediaIterator);
2933 if (kernResult != KERN_SUCCESS) {
2934 error_report("Note: IOServiceGetMatchingServices returned %d",
2935 kernResult);
2936 continue;
2939 /* If a match was found, leave the loop */
2940 if (*mediaIterator != 0) {
2941 trace_file_FindEjectableOpticalMedia(matching_array[index]);
2942 mediaType = g_strdup(matching_array[index]);
2943 break;
2946 return mediaType;
2949 kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
2950 CFIndex maxPathSize, int flags)
2952 io_object_t nextMedia;
2953 kern_return_t kernResult = KERN_FAILURE;
2954 *bsdPath = '\0';
2955 nextMedia = IOIteratorNext( mediaIterator );
2956 if ( nextMedia )
2958 CFTypeRef bsdPathAsCFString;
2959 bsdPathAsCFString = IORegistryEntryCreateCFProperty( nextMedia, CFSTR( kIOBSDNameKey ), kCFAllocatorDefault, 0 );
2960 if ( bsdPathAsCFString ) {
2961 size_t devPathLength;
2962 strcpy( bsdPath, _PATH_DEV );
2963 if (flags & BDRV_O_NOCACHE) {
2964 strcat(bsdPath, "r");
2966 devPathLength = strlen( bsdPath );
2967 if ( CFStringGetCString( bsdPathAsCFString, bsdPath + devPathLength, maxPathSize - devPathLength, kCFStringEncodingASCII ) ) {
2968 kernResult = KERN_SUCCESS;
2970 CFRelease( bsdPathAsCFString );
2972 IOObjectRelease( nextMedia );
2975 return kernResult;
2978 /* Sets up a real cdrom for use in QEMU */
2979 static bool setup_cdrom(char *bsd_path, Error **errp)
2981 int index, num_of_test_partitions = 2, fd;
2982 char test_partition[MAXPATHLEN];
2983 bool partition_found = false;
2985 /* look for a working partition */
2986 for (index = 0; index < num_of_test_partitions; index++) {
2987 snprintf(test_partition, sizeof(test_partition), "%ss%d", bsd_path,
2988 index);
2989 fd = qemu_open(test_partition, O_RDONLY | O_BINARY | O_LARGEFILE);
2990 if (fd >= 0) {
2991 partition_found = true;
2992 qemu_close(fd);
2993 break;
2997 /* if a working partition on the device was not found */
2998 if (partition_found == false) {
2999 error_setg(errp, "Failed to find a working partition on disc");
3000 } else {
3001 trace_file_setup_cdrom(test_partition);
3002 pstrcpy(bsd_path, MAXPATHLEN, test_partition);
3004 return partition_found;
3007 /* Prints directions on mounting and unmounting a device */
3008 static void print_unmounting_directions(const char *file_name)
3010 error_report("If device %s is mounted on the desktop, unmount"
3011 " it first before using it in QEMU", file_name);
3012 error_report("Command to unmount device: diskutil unmountDisk %s",
3013 file_name);
3014 error_report("Command to mount device: diskutil mountDisk %s", file_name);
3017 #endif /* defined(__APPLE__) && defined(__MACH__) */
3019 static int hdev_probe_device(const char *filename)
3021 struct stat st;
3023 /* allow a dedicated CD-ROM driver to match with a higher priority */
3024 if (strstart(filename, "/dev/cdrom", NULL))
3025 return 50;
3027 if (stat(filename, &st) >= 0 &&
3028 (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
3029 return 100;
3032 return 0;
3035 static int check_hdev_writable(BDRVRawState *s)
3037 #if defined(BLKROGET)
3038 /* Linux block devices can be configured "read-only" using blockdev(8).
3039 * This is independent of device node permissions and therefore open(2)
3040 * with O_RDWR succeeds. Actual writes fail with EPERM.
3042 * bdrv_open() is supposed to fail if the disk is read-only. Explicitly
3043 * check for read-only block devices so that Linux block devices behave
3044 * properly.
3046 struct stat st;
3047 int readonly = 0;
3049 if (fstat(s->fd, &st)) {
3050 return -errno;
3053 if (!S_ISBLK(st.st_mode)) {
3054 return 0;
3057 if (ioctl(s->fd, BLKROGET, &readonly) < 0) {
3058 return -errno;
3061 if (readonly) {
3062 return -EACCES;
3064 #endif /* defined(BLKROGET) */
3065 return 0;
3068 static void hdev_parse_filename(const char *filename, QDict *options,
3069 Error **errp)
3071 bdrv_parse_filename_strip_prefix(filename, "host_device:", options);
3074 static bool hdev_is_sg(BlockDriverState *bs)
3077 #if defined(__linux__)
3079 BDRVRawState *s = bs->opaque;
3080 struct stat st;
3081 struct sg_scsi_id scsiid;
3082 int sg_version;
3083 int ret;
3085 if (stat(bs->filename, &st) < 0 || !S_ISCHR(st.st_mode)) {
3086 return false;
3089 ret = ioctl(s->fd, SG_GET_VERSION_NUM, &sg_version);
3090 if (ret < 0) {
3091 return false;
3094 ret = ioctl(s->fd, SG_GET_SCSI_ID, &scsiid);
3095 if (ret >= 0) {
3096 trace_file_hdev_is_sg(scsiid.scsi_type, sg_version);
3097 return true;
3100 #endif
3102 return false;
3105 static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
3106 Error **errp)
3108 BDRVRawState *s = bs->opaque;
3109 Error *local_err = NULL;
3110 int ret;
3112 #if defined(__APPLE__) && defined(__MACH__)
3114 * Caution: while qdict_get_str() is fine, getting non-string types
3115 * would require more care. When @options come from -blockdev or
3116 * blockdev_add, its members are typed according to the QAPI
3117 * schema, but when they come from -drive, they're all QString.
3119 const char *filename = qdict_get_str(options, "filename");
3120 char bsd_path[MAXPATHLEN] = "";
3121 bool error_occurred = false;
3123 /* If using a real cdrom */
3124 if (strcmp(filename, "/dev/cdrom") == 0) {
3125 char *mediaType = NULL;
3126 kern_return_t ret_val;
3127 io_iterator_t mediaIterator = 0;
3129 mediaType = FindEjectableOpticalMedia(&mediaIterator);
3130 if (mediaType == NULL) {
3131 error_setg(errp, "Please make sure your CD/DVD is in the optical"
3132 " drive");
3133 error_occurred = true;
3134 goto hdev_open_Mac_error;
3137 ret_val = GetBSDPath(mediaIterator, bsd_path, sizeof(bsd_path), flags);
3138 if (ret_val != KERN_SUCCESS) {
3139 error_setg(errp, "Could not get BSD path for optical drive");
3140 error_occurred = true;
3141 goto hdev_open_Mac_error;
3144 /* If a real optical drive was not found */
3145 if (bsd_path[0] == '\0') {
3146 error_setg(errp, "Failed to obtain bsd path for optical drive");
3147 error_occurred = true;
3148 goto hdev_open_Mac_error;
3151 /* If using a cdrom disc and finding a partition on the disc failed */
3152 if (strncmp(mediaType, kIOCDMediaClass, 9) == 0 &&
3153 setup_cdrom(bsd_path, errp) == false) {
3154 print_unmounting_directions(bsd_path);
3155 error_occurred = true;
3156 goto hdev_open_Mac_error;
3159 qdict_put_str(options, "filename", bsd_path);
3161 hdev_open_Mac_error:
3162 g_free(mediaType);
3163 if (mediaIterator) {
3164 IOObjectRelease(mediaIterator);
3166 if (error_occurred) {
3167 return -ENOENT;
3170 #endif /* defined(__APPLE__) && defined(__MACH__) */
3172 s->type = FTYPE_FILE;
3174 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3175 if (ret < 0) {
3176 error_propagate(errp, local_err);
3177 #if defined(__APPLE__) && defined(__MACH__)
3178 if (*bsd_path) {
3179 filename = bsd_path;
3181 /* if a physical device experienced an error while being opened */
3182 if (strncmp(filename, "/dev/", 5) == 0) {
3183 print_unmounting_directions(filename);
3185 #endif /* defined(__APPLE__) && defined(__MACH__) */
3186 return ret;
3189 /* Since this does ioctl the device must be already opened */
3190 bs->sg = hdev_is_sg(bs);
3192 if (flags & BDRV_O_RDWR) {
3193 ret = check_hdev_writable(s);
3194 if (ret < 0) {
3195 raw_close(bs);
3196 error_setg_errno(errp, -ret, "The device is not writable");
3197 return ret;
3201 return ret;
3204 #if defined(__linux__)
3205 static int coroutine_fn
3206 hdev_co_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
3208 BDRVRawState *s = bs->opaque;
3209 RawPosixAIOData acb;
3210 int ret;
3212 ret = fd_open(bs);
3213 if (ret < 0) {
3214 return ret;
3217 if (req == SG_IO && s->pr_mgr) {
3218 struct sg_io_hdr *io_hdr = buf;
3219 if (io_hdr->cmdp[0] == PERSISTENT_RESERVE_OUT ||
3220 io_hdr->cmdp[0] == PERSISTENT_RESERVE_IN) {
3221 return pr_manager_execute(s->pr_mgr, bdrv_get_aio_context(bs),
3222 s->fd, io_hdr);
3226 acb = (RawPosixAIOData) {
3227 .bs = bs,
3228 .aio_type = QEMU_AIO_IOCTL,
3229 .aio_fildes = s->fd,
3230 .aio_offset = 0,
3231 .ioctl = {
3232 .buf = buf,
3233 .cmd = req,
3237 return raw_thread_pool_submit(bs, handle_aiocb_ioctl, &acb);
3239 #endif /* linux */
3241 static int fd_open(BlockDriverState *bs)
3243 BDRVRawState *s = bs->opaque;
3245 /* this is just to ensure s->fd is sane (its called by io ops) */
3246 if (s->fd >= 0)
3247 return 0;
3248 return -EIO;
3251 static coroutine_fn int
3252 hdev_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
3254 int ret;
3256 ret = fd_open(bs);
3257 if (ret < 0) {
3258 return ret;
3260 return raw_do_pdiscard(bs, offset, bytes, true);
3263 static coroutine_fn int hdev_co_pwrite_zeroes(BlockDriverState *bs,
3264 int64_t offset, int bytes, BdrvRequestFlags flags)
3266 int rc;
3268 rc = fd_open(bs);
3269 if (rc < 0) {
3270 return rc;
3273 return raw_do_pwrite_zeroes(bs, offset, bytes, flags, true);
3276 static int coroutine_fn hdev_co_create_opts(const char *filename, QemuOpts *opts,
3277 Error **errp)
3279 int fd;
3280 int ret = 0;
3281 struct stat stat_buf;
3282 int64_t total_size = 0;
3283 bool has_prefix;
3285 /* This function is used by both protocol block drivers and therefore either
3286 * of these prefixes may be given.
3287 * The return value has to be stored somewhere, otherwise this is an error
3288 * due to -Werror=unused-value. */
3289 has_prefix =
3290 strstart(filename, "host_device:", &filename) ||
3291 strstart(filename, "host_cdrom:" , &filename);
3293 (void)has_prefix;
3295 ret = raw_normalize_devicepath(&filename, errp);
3296 if (ret < 0) {
3297 return ret;
3300 /* Read out options */
3301 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
3302 BDRV_SECTOR_SIZE);
3304 fd = qemu_open(filename, O_WRONLY | O_BINARY);
3305 if (fd < 0) {
3306 ret = -errno;
3307 error_setg_errno(errp, -ret, "Could not open device");
3308 return ret;
3311 if (fstat(fd, &stat_buf) < 0) {
3312 ret = -errno;
3313 error_setg_errno(errp, -ret, "Could not stat device");
3314 } else if (!S_ISBLK(stat_buf.st_mode) && !S_ISCHR(stat_buf.st_mode)) {
3315 error_setg(errp,
3316 "The given file is neither a block nor a character device");
3317 ret = -ENODEV;
3318 } else if (lseek(fd, 0, SEEK_END) < total_size) {
3319 error_setg(errp, "Device is too small");
3320 ret = -ENOSPC;
3323 if (!ret && total_size) {
3324 uint8_t buf[BDRV_SECTOR_SIZE] = { 0 };
3325 int64_t zero_size = MIN(BDRV_SECTOR_SIZE, total_size);
3326 if (lseek(fd, 0, SEEK_SET) == -1) {
3327 ret = -errno;
3328 } else {
3329 ret = qemu_write_full(fd, buf, zero_size);
3330 ret = ret == zero_size ? 0 : -errno;
3333 qemu_close(fd);
3334 return ret;
3337 static BlockDriver bdrv_host_device = {
3338 .format_name = "host_device",
3339 .protocol_name = "host_device",
3340 .instance_size = sizeof(BDRVRawState),
3341 .bdrv_needs_filename = true,
3342 .bdrv_probe_device = hdev_probe_device,
3343 .bdrv_parse_filename = hdev_parse_filename,
3344 .bdrv_file_open = hdev_open,
3345 .bdrv_close = raw_close,
3346 .bdrv_reopen_prepare = raw_reopen_prepare,
3347 .bdrv_reopen_commit = raw_reopen_commit,
3348 .bdrv_reopen_abort = raw_reopen_abort,
3349 .bdrv_co_create_opts = hdev_co_create_opts,
3350 .create_opts = &raw_create_opts,
3351 .mutable_opts = mutable_opts,
3352 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3353 .bdrv_co_pwrite_zeroes = hdev_co_pwrite_zeroes,
3355 .bdrv_co_preadv = raw_co_preadv,
3356 .bdrv_co_pwritev = raw_co_pwritev,
3357 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3358 .bdrv_co_pdiscard = hdev_co_pdiscard,
3359 .bdrv_co_copy_range_from = raw_co_copy_range_from,
3360 .bdrv_co_copy_range_to = raw_co_copy_range_to,
3361 .bdrv_refresh_limits = raw_refresh_limits,
3362 .bdrv_io_plug = raw_aio_plug,
3363 .bdrv_io_unplug = raw_aio_unplug,
3364 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3366 .bdrv_co_truncate = raw_co_truncate,
3367 .bdrv_getlength = raw_getlength,
3368 .bdrv_get_info = raw_get_info,
3369 .bdrv_get_allocated_file_size
3370 = raw_get_allocated_file_size,
3371 .bdrv_check_perm = raw_check_perm,
3372 .bdrv_set_perm = raw_set_perm,
3373 .bdrv_abort_perm_update = raw_abort_perm_update,
3374 .bdrv_probe_blocksizes = hdev_probe_blocksizes,
3375 .bdrv_probe_geometry = hdev_probe_geometry,
3377 /* generic scsi device */
3378 #ifdef __linux__
3379 .bdrv_co_ioctl = hdev_co_ioctl,
3380 #endif
3383 #if defined(__linux__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3384 static void cdrom_parse_filename(const char *filename, QDict *options,
3385 Error **errp)
3387 bdrv_parse_filename_strip_prefix(filename, "host_cdrom:", options);
3389 #endif
3391 #ifdef __linux__
3392 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3393 Error **errp)
3395 BDRVRawState *s = bs->opaque;
3397 s->type = FTYPE_CD;
3399 /* open will not fail even if no CD is inserted, so add O_NONBLOCK */
3400 return raw_open_common(bs, options, flags, O_NONBLOCK, true, errp);
3403 static int cdrom_probe_device(const char *filename)
3405 int fd, ret;
3406 int prio = 0;
3407 struct stat st;
3409 fd = qemu_open(filename, O_RDONLY | O_NONBLOCK);
3410 if (fd < 0) {
3411 goto out;
3413 ret = fstat(fd, &st);
3414 if (ret == -1 || !S_ISBLK(st.st_mode)) {
3415 goto outc;
3418 /* Attempt to detect via a CDROM specific ioctl */
3419 ret = ioctl(fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3420 if (ret >= 0)
3421 prio = 100;
3423 outc:
3424 qemu_close(fd);
3425 out:
3426 return prio;
3429 static bool cdrom_is_inserted(BlockDriverState *bs)
3431 BDRVRawState *s = bs->opaque;
3432 int ret;
3434 ret = ioctl(s->fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3435 return ret == CDS_DISC_OK;
3438 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3440 BDRVRawState *s = bs->opaque;
3442 if (eject_flag) {
3443 if (ioctl(s->fd, CDROMEJECT, NULL) < 0)
3444 perror("CDROMEJECT");
3445 } else {
3446 if (ioctl(s->fd, CDROMCLOSETRAY, NULL) < 0)
3447 perror("CDROMEJECT");
3451 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3453 BDRVRawState *s = bs->opaque;
3455 if (ioctl(s->fd, CDROM_LOCKDOOR, locked) < 0) {
3457 * Note: an error can happen if the distribution automatically
3458 * mounts the CD-ROM
3460 /* perror("CDROM_LOCKDOOR"); */
3464 static BlockDriver bdrv_host_cdrom = {
3465 .format_name = "host_cdrom",
3466 .protocol_name = "host_cdrom",
3467 .instance_size = sizeof(BDRVRawState),
3468 .bdrv_needs_filename = true,
3469 .bdrv_probe_device = cdrom_probe_device,
3470 .bdrv_parse_filename = cdrom_parse_filename,
3471 .bdrv_file_open = cdrom_open,
3472 .bdrv_close = raw_close,
3473 .bdrv_reopen_prepare = raw_reopen_prepare,
3474 .bdrv_reopen_commit = raw_reopen_commit,
3475 .bdrv_reopen_abort = raw_reopen_abort,
3476 .bdrv_co_create_opts = hdev_co_create_opts,
3477 .create_opts = &raw_create_opts,
3478 .mutable_opts = mutable_opts,
3479 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3482 .bdrv_co_preadv = raw_co_preadv,
3483 .bdrv_co_pwritev = raw_co_pwritev,
3484 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3485 .bdrv_refresh_limits = raw_refresh_limits,
3486 .bdrv_io_plug = raw_aio_plug,
3487 .bdrv_io_unplug = raw_aio_unplug,
3488 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3490 .bdrv_co_truncate = raw_co_truncate,
3491 .bdrv_getlength = raw_getlength,
3492 .has_variable_length = true,
3493 .bdrv_get_allocated_file_size
3494 = raw_get_allocated_file_size,
3496 /* removable device support */
3497 .bdrv_is_inserted = cdrom_is_inserted,
3498 .bdrv_eject = cdrom_eject,
3499 .bdrv_lock_medium = cdrom_lock_medium,
3501 /* generic scsi device */
3502 .bdrv_co_ioctl = hdev_co_ioctl,
3504 #endif /* __linux__ */
3506 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
3507 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3508 Error **errp)
3510 BDRVRawState *s = bs->opaque;
3511 Error *local_err = NULL;
3512 int ret;
3514 s->type = FTYPE_CD;
3516 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3517 if (ret) {
3518 error_propagate(errp, local_err);
3519 return ret;
3522 /* make sure the door isn't locked at this time */
3523 ioctl(s->fd, CDIOCALLOW);
3524 return 0;
3527 static int cdrom_probe_device(const char *filename)
3529 if (strstart(filename, "/dev/cd", NULL) ||
3530 strstart(filename, "/dev/acd", NULL))
3531 return 100;
3532 return 0;
3535 static int cdrom_reopen(BlockDriverState *bs)
3537 BDRVRawState *s = bs->opaque;
3538 int fd;
3541 * Force reread of possibly changed/newly loaded disc,
3542 * FreeBSD seems to not notice sometimes...
3544 if (s->fd >= 0)
3545 qemu_close(s->fd);
3546 fd = qemu_open(bs->filename, s->open_flags, 0644);
3547 if (fd < 0) {
3548 s->fd = -1;
3549 return -EIO;
3551 s->fd = fd;
3553 /* make sure the door isn't locked at this time */
3554 ioctl(s->fd, CDIOCALLOW);
3555 return 0;
3558 static bool cdrom_is_inserted(BlockDriverState *bs)
3560 return raw_getlength(bs) > 0;
3563 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3565 BDRVRawState *s = bs->opaque;
3567 if (s->fd < 0)
3568 return;
3570 (void) ioctl(s->fd, CDIOCALLOW);
3572 if (eject_flag) {
3573 if (ioctl(s->fd, CDIOCEJECT) < 0)
3574 perror("CDIOCEJECT");
3575 } else {
3576 if (ioctl(s->fd, CDIOCCLOSE) < 0)
3577 perror("CDIOCCLOSE");
3580 cdrom_reopen(bs);
3583 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3585 BDRVRawState *s = bs->opaque;
3587 if (s->fd < 0)
3588 return;
3589 if (ioctl(s->fd, (locked ? CDIOCPREVENT : CDIOCALLOW)) < 0) {
3591 * Note: an error can happen if the distribution automatically
3592 * mounts the CD-ROM
3594 /* perror("CDROM_LOCKDOOR"); */
3598 static BlockDriver bdrv_host_cdrom = {
3599 .format_name = "host_cdrom",
3600 .protocol_name = "host_cdrom",
3601 .instance_size = sizeof(BDRVRawState),
3602 .bdrv_needs_filename = true,
3603 .bdrv_probe_device = cdrom_probe_device,
3604 .bdrv_parse_filename = cdrom_parse_filename,
3605 .bdrv_file_open = cdrom_open,
3606 .bdrv_close = raw_close,
3607 .bdrv_reopen_prepare = raw_reopen_prepare,
3608 .bdrv_reopen_commit = raw_reopen_commit,
3609 .bdrv_reopen_abort = raw_reopen_abort,
3610 .bdrv_co_create_opts = hdev_co_create_opts,
3611 .create_opts = &raw_create_opts,
3612 .mutable_opts = mutable_opts,
3614 .bdrv_co_preadv = raw_co_preadv,
3615 .bdrv_co_pwritev = raw_co_pwritev,
3616 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3617 .bdrv_refresh_limits = raw_refresh_limits,
3618 .bdrv_io_plug = raw_aio_plug,
3619 .bdrv_io_unplug = raw_aio_unplug,
3620 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3622 .bdrv_co_truncate = raw_co_truncate,
3623 .bdrv_getlength = raw_getlength,
3624 .has_variable_length = true,
3625 .bdrv_get_allocated_file_size
3626 = raw_get_allocated_file_size,
3628 /* removable device support */
3629 .bdrv_is_inserted = cdrom_is_inserted,
3630 .bdrv_eject = cdrom_eject,
3631 .bdrv_lock_medium = cdrom_lock_medium,
3633 #endif /* __FreeBSD__ */
3635 static void bdrv_file_init(void)
3638 * Register all the drivers. Note that order is important, the driver
3639 * registered last will get probed first.
3641 bdrv_register(&bdrv_file);
3642 bdrv_register(&bdrv_host_device);
3643 #ifdef __linux__
3644 bdrv_register(&bdrv_host_cdrom);
3645 #endif
3646 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3647 bdrv_register(&bdrv_host_cdrom);
3648 #endif
3651 block_init(bdrv_file_init);