Merge remote-tracking branch 'remotes/awilliam/tags/vfio-update-20191010.0' into...
[qemu/ar7.git] / block / file-posix.c
blob695fcf740df7fa6e08448dd7f58342e5b9bfabe4
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 "qemu-common.h"
27 #include "qapi/error.h"
28 #include "qemu/cutils.h"
29 #include "qemu/error-report.h"
30 #include "block/block_int.h"
31 #include "qemu/module.h"
32 #include "qemu/option.h"
33 #include "trace.h"
34 #include "block/thread-pool.h"
35 #include "qemu/iov.h"
36 #include "block/raw-aio.h"
37 #include "qapi/qmp/qdict.h"
38 #include "qapi/qmp/qstring.h"
40 #include "scsi/pr-manager.h"
41 #include "scsi/constants.h"
43 #if defined(__APPLE__) && (__MACH__)
44 #include <paths.h>
45 #include <sys/param.h>
46 #include <IOKit/IOKitLib.h>
47 #include <IOKit/IOBSD.h>
48 #include <IOKit/storage/IOMediaBSDClient.h>
49 #include <IOKit/storage/IOMedia.h>
50 #include <IOKit/storage/IOCDMedia.h>
51 //#include <IOKit/storage/IOCDTypes.h>
52 #include <IOKit/storage/IODVDMedia.h>
53 #include <CoreFoundation/CoreFoundation.h>
54 #endif
56 #ifdef __sun__
57 #define _POSIX_PTHREAD_SEMANTICS 1
58 #include <sys/dkio.h>
59 #endif
60 #ifdef __linux__
61 #include <sys/ioctl.h>
62 #include <sys/param.h>
63 #include <sys/syscall.h>
64 #include <linux/cdrom.h>
65 #include <linux/fd.h>
66 #include <linux/fs.h>
67 #include <linux/hdreg.h>
68 #include <scsi/sg.h>
69 #ifdef __s390__
70 #include <asm/dasd.h>
71 #endif
72 #ifndef FS_NOCOW_FL
73 #define FS_NOCOW_FL 0x00800000 /* Do not cow file */
74 #endif
75 #endif
76 #if defined(CONFIG_FALLOCATE_PUNCH_HOLE) || defined(CONFIG_FALLOCATE_ZERO_RANGE)
77 #include <linux/falloc.h>
78 #endif
79 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
80 #include <sys/disk.h>
81 #include <sys/cdio.h>
82 #endif
84 #ifdef __OpenBSD__
85 #include <sys/ioctl.h>
86 #include <sys/disklabel.h>
87 #include <sys/dkio.h>
88 #endif
90 #ifdef __NetBSD__
91 #include <sys/ioctl.h>
92 #include <sys/disklabel.h>
93 #include <sys/dkio.h>
94 #include <sys/disk.h>
95 #endif
97 #ifdef __DragonFly__
98 #include <sys/ioctl.h>
99 #include <sys/diskslice.h>
100 #endif
102 #ifdef CONFIG_XFS
103 #include <xfs/xfs.h>
104 #endif
106 #include "trace.h"
108 /* OS X does not have O_DSYNC */
109 #ifndef O_DSYNC
110 #ifdef O_SYNC
111 #define O_DSYNC O_SYNC
112 #elif defined(O_FSYNC)
113 #define O_DSYNC O_FSYNC
114 #endif
115 #endif
117 /* Approximate O_DIRECT with O_DSYNC if O_DIRECT isn't available */
118 #ifndef O_DIRECT
119 #define O_DIRECT O_DSYNC
120 #endif
122 #define FTYPE_FILE 0
123 #define FTYPE_CD 1
125 #define MAX_BLOCKSIZE 4096
127 /* Posix file locking bytes. Libvirt takes byte 0, we start from higher bytes,
128 * leaving a few more bytes for its future use. */
129 #define RAW_LOCK_PERM_BASE 100
130 #define RAW_LOCK_SHARED_BASE 200
132 typedef struct BDRVRawState {
133 int fd;
134 bool use_lock;
135 int type;
136 int open_flags;
137 size_t buf_align;
139 /* The current permissions. */
140 uint64_t perm;
141 uint64_t shared_perm;
143 /* The perms bits whose corresponding bytes are already locked in
144 * s->fd. */
145 uint64_t locked_perm;
146 uint64_t locked_shared_perm;
148 int perm_change_fd;
149 int perm_change_flags;
150 BDRVReopenState *reopen_state;
152 #ifdef CONFIG_XFS
153 bool is_xfs:1;
154 #endif
155 bool has_discard:1;
156 bool has_write_zeroes:1;
157 bool discard_zeroes:1;
158 bool use_linux_aio:1;
159 bool page_cache_inconsistent:1;
160 bool has_fallocate;
161 bool needs_alignment;
162 bool drop_cache;
163 bool check_cache_dropped;
164 struct {
165 uint64_t discard_nb_ok;
166 uint64_t discard_nb_failed;
167 uint64_t discard_bytes_ok;
168 } stats;
170 PRManager *pr_mgr;
171 } BDRVRawState;
173 typedef struct BDRVRawReopenState {
174 int fd;
175 int open_flags;
176 bool drop_cache;
177 bool check_cache_dropped;
178 } BDRVRawReopenState;
180 static int fd_open(BlockDriverState *bs);
181 static int64_t raw_getlength(BlockDriverState *bs);
183 typedef struct RawPosixAIOData {
184 BlockDriverState *bs;
185 int aio_type;
186 int aio_fildes;
188 off_t aio_offset;
189 uint64_t aio_nbytes;
191 union {
192 struct {
193 struct iovec *iov;
194 int niov;
195 } io;
196 struct {
197 uint64_t cmd;
198 void *buf;
199 } ioctl;
200 struct {
201 int aio_fd2;
202 off_t aio_offset2;
203 } copy_range;
204 struct {
205 PreallocMode prealloc;
206 Error **errp;
207 } truncate;
209 } RawPosixAIOData;
211 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
212 static int cdrom_reopen(BlockDriverState *bs);
213 #endif
215 #if defined(__NetBSD__)
216 static int raw_normalize_devicepath(const char **filename, Error **errp)
218 static char namebuf[PATH_MAX];
219 const char *dp, *fname;
220 struct stat sb;
222 fname = *filename;
223 dp = strrchr(fname, '/');
224 if (lstat(fname, &sb) < 0) {
225 error_setg_file_open(errp, errno, fname);
226 return -errno;
229 if (!S_ISBLK(sb.st_mode)) {
230 return 0;
233 if (dp == NULL) {
234 snprintf(namebuf, PATH_MAX, "r%s", fname);
235 } else {
236 snprintf(namebuf, PATH_MAX, "%.*s/r%s",
237 (int)(dp - fname), fname, dp + 1);
239 *filename = namebuf;
240 warn_report("%s is a block device, using %s", fname, *filename);
242 return 0;
244 #else
245 static int raw_normalize_devicepath(const char **filename, Error **errp)
247 return 0;
249 #endif
252 * Get logical block size via ioctl. On success store it in @sector_size_p.
254 static int probe_logical_blocksize(int fd, unsigned int *sector_size_p)
256 unsigned int sector_size;
257 bool success = false;
258 int i;
260 errno = ENOTSUP;
261 static const unsigned long ioctl_list[] = {
262 #ifdef BLKSSZGET
263 BLKSSZGET,
264 #endif
265 #ifdef DKIOCGETBLOCKSIZE
266 DKIOCGETBLOCKSIZE,
267 #endif
268 #ifdef DIOCGSECTORSIZE
269 DIOCGSECTORSIZE,
270 #endif
273 /* Try a few ioctls to get the right size */
274 for (i = 0; i < (int)ARRAY_SIZE(ioctl_list); i++) {
275 if (ioctl(fd, ioctl_list[i], &sector_size) >= 0) {
276 *sector_size_p = sector_size;
277 success = true;
281 return success ? 0 : -errno;
285 * Get physical block size of @fd.
286 * On success, store it in @blk_size and return 0.
287 * On failure, return -errno.
289 static int probe_physical_blocksize(int fd, unsigned int *blk_size)
291 #ifdef BLKPBSZGET
292 if (ioctl(fd, BLKPBSZGET, blk_size) < 0) {
293 return -errno;
295 return 0;
296 #else
297 return -ENOTSUP;
298 #endif
301 /* Check if read is allowed with given memory buffer and length.
303 * This function is used to check O_DIRECT memory buffer and request alignment.
305 static bool raw_is_io_aligned(int fd, void *buf, size_t len)
307 ssize_t ret = pread(fd, buf, len, 0);
309 if (ret >= 0) {
310 return true;
313 #ifdef __linux__
314 /* The Linux kernel returns EINVAL for misaligned O_DIRECT reads. Ignore
315 * other errors (e.g. real I/O error), which could happen on a failed
316 * drive, since we only care about probing alignment.
318 if (errno != EINVAL) {
319 return true;
321 #endif
323 return false;
326 static void raw_probe_alignment(BlockDriverState *bs, int fd, Error **errp)
328 BDRVRawState *s = bs->opaque;
329 char *buf;
330 size_t max_align = MAX(MAX_BLOCKSIZE, getpagesize());
331 size_t alignments[] = {1, 512, 1024, 2048, 4096};
333 /* For SCSI generic devices the alignment is not really used.
334 With buffered I/O, we don't have any restrictions. */
335 if (bdrv_is_sg(bs) || !s->needs_alignment) {
336 bs->bl.request_alignment = 1;
337 s->buf_align = 1;
338 return;
341 bs->bl.request_alignment = 0;
342 s->buf_align = 0;
343 /* Let's try to use the logical blocksize for the alignment. */
344 if (probe_logical_blocksize(fd, &bs->bl.request_alignment) < 0) {
345 bs->bl.request_alignment = 0;
347 #ifdef CONFIG_XFS
348 if (s->is_xfs) {
349 struct dioattr da;
350 if (xfsctl(NULL, fd, XFS_IOC_DIOINFO, &da) >= 0) {
351 bs->bl.request_alignment = da.d_miniosz;
352 /* The kernel returns wrong information for d_mem */
353 /* s->buf_align = da.d_mem; */
356 #endif
359 * If we could not get the sizes so far, we can only guess them. First try
360 * to detect request alignment, since it is more likely to succeed. Then
361 * try to detect buf_align, which cannot be detected in some cases (e.g.
362 * Gluster). If buf_align cannot be detected, we fallback to the value of
363 * request_alignment.
366 if (!bs->bl.request_alignment) {
367 int i;
368 size_t align;
369 buf = qemu_memalign(max_align, max_align);
370 for (i = 0; i < ARRAY_SIZE(alignments); i++) {
371 align = alignments[i];
372 if (raw_is_io_aligned(fd, buf, align)) {
373 /* Fallback to safe value. */
374 bs->bl.request_alignment = (align != 1) ? align : max_align;
375 break;
378 qemu_vfree(buf);
381 if (!s->buf_align) {
382 int i;
383 size_t align;
384 buf = qemu_memalign(max_align, 2 * max_align);
385 for (i = 0; i < ARRAY_SIZE(alignments); i++) {
386 align = alignments[i];
387 if (raw_is_io_aligned(fd, buf + align, max_align)) {
388 /* Fallback to request_alignment. */
389 s->buf_align = (align != 1) ? align : bs->bl.request_alignment;
390 break;
393 qemu_vfree(buf);
396 if (!s->buf_align || !bs->bl.request_alignment) {
397 error_setg(errp, "Could not find working O_DIRECT alignment");
398 error_append_hint(errp, "Try cache.direct=off\n");
402 static void raw_parse_flags(int bdrv_flags, int *open_flags, bool has_writers)
404 bool read_write = false;
405 assert(open_flags != NULL);
407 *open_flags |= O_BINARY;
408 *open_flags &= ~O_ACCMODE;
410 if (bdrv_flags & BDRV_O_AUTO_RDONLY) {
411 read_write = has_writers;
412 } else if (bdrv_flags & BDRV_O_RDWR) {
413 read_write = true;
416 if (read_write) {
417 *open_flags |= O_RDWR;
418 } else {
419 *open_flags |= O_RDONLY;
422 /* Use O_DSYNC for write-through caching, no flags for write-back caching,
423 * and O_DIRECT for no caching. */
424 if ((bdrv_flags & BDRV_O_NOCACHE)) {
425 *open_flags |= O_DIRECT;
429 static void raw_parse_filename(const char *filename, QDict *options,
430 Error **errp)
432 bdrv_parse_filename_strip_prefix(filename, "file:", options);
435 static QemuOptsList raw_runtime_opts = {
436 .name = "raw",
437 .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
438 .desc = {
440 .name = "filename",
441 .type = QEMU_OPT_STRING,
442 .help = "File name of the image",
445 .name = "aio",
446 .type = QEMU_OPT_STRING,
447 .help = "host AIO implementation (threads, native)",
450 .name = "locking",
451 .type = QEMU_OPT_STRING,
452 .help = "file locking mode (on/off/auto, default: auto)",
455 .name = "pr-manager",
456 .type = QEMU_OPT_STRING,
457 .help = "id of persistent reservation manager object (default: none)",
459 #if defined(__linux__)
461 .name = "drop-cache",
462 .type = QEMU_OPT_BOOL,
463 .help = "invalidate page cache during live migration (default: on)",
465 #endif
467 .name = "x-check-cache-dropped",
468 .type = QEMU_OPT_BOOL,
469 .help = "check that page cache was dropped on live migration (default: off)"
471 { /* end of list */ }
475 static const char *const mutable_opts[] = { "x-check-cache-dropped", NULL };
477 static int raw_open_common(BlockDriverState *bs, QDict *options,
478 int bdrv_flags, int open_flags,
479 bool device, Error **errp)
481 BDRVRawState *s = bs->opaque;
482 QemuOpts *opts;
483 Error *local_err = NULL;
484 const char *filename = NULL;
485 const char *str;
486 BlockdevAioOptions aio, aio_default;
487 int fd, ret;
488 struct stat st;
489 OnOffAuto locking;
491 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
492 qemu_opts_absorb_qdict(opts, options, &local_err);
493 if (local_err) {
494 error_propagate(errp, local_err);
495 ret = -EINVAL;
496 goto fail;
499 filename = qemu_opt_get(opts, "filename");
501 ret = raw_normalize_devicepath(&filename, errp);
502 if (ret != 0) {
503 goto fail;
506 aio_default = (bdrv_flags & BDRV_O_NATIVE_AIO)
507 ? BLOCKDEV_AIO_OPTIONS_NATIVE
508 : BLOCKDEV_AIO_OPTIONS_THREADS;
509 aio = qapi_enum_parse(&BlockdevAioOptions_lookup,
510 qemu_opt_get(opts, "aio"),
511 aio_default, &local_err);
512 if (local_err) {
513 error_propagate(errp, local_err);
514 ret = -EINVAL;
515 goto fail;
517 s->use_linux_aio = (aio == BLOCKDEV_AIO_OPTIONS_NATIVE);
519 locking = qapi_enum_parse(&OnOffAuto_lookup,
520 qemu_opt_get(opts, "locking"),
521 ON_OFF_AUTO_AUTO, &local_err);
522 if (local_err) {
523 error_propagate(errp, local_err);
524 ret = -EINVAL;
525 goto fail;
527 switch (locking) {
528 case ON_OFF_AUTO_ON:
529 s->use_lock = true;
530 if (!qemu_has_ofd_lock()) {
531 warn_report("File lock requested but OFD locking syscall is "
532 "unavailable, falling back to POSIX file locks");
533 error_printf("Due to the implementation, locks can be lost "
534 "unexpectedly.\n");
536 break;
537 case ON_OFF_AUTO_OFF:
538 s->use_lock = false;
539 break;
540 case ON_OFF_AUTO_AUTO:
541 s->use_lock = qemu_has_ofd_lock();
542 break;
543 default:
544 abort();
547 str = qemu_opt_get(opts, "pr-manager");
548 if (str) {
549 s->pr_mgr = pr_manager_lookup(str, &local_err);
550 if (local_err) {
551 error_propagate(errp, local_err);
552 ret = -EINVAL;
553 goto fail;
557 s->drop_cache = qemu_opt_get_bool(opts, "drop-cache", true);
558 s->check_cache_dropped = qemu_opt_get_bool(opts, "x-check-cache-dropped",
559 false);
561 s->open_flags = open_flags;
562 raw_parse_flags(bdrv_flags, &s->open_flags, false);
564 s->fd = -1;
565 fd = qemu_open(filename, s->open_flags, 0644);
566 ret = fd < 0 ? -errno : 0;
568 if (ret < 0) {
569 error_setg_file_open(errp, -ret, filename);
570 if (ret == -EROFS) {
571 ret = -EACCES;
573 goto fail;
575 s->fd = fd;
577 s->perm = 0;
578 s->shared_perm = BLK_PERM_ALL;
580 #ifdef CONFIG_LINUX_AIO
581 /* Currently Linux does AIO only for files opened with O_DIRECT */
582 if (s->use_linux_aio) {
583 if (!(s->open_flags & O_DIRECT)) {
584 error_setg(errp, "aio=native was specified, but it requires "
585 "cache.direct=on, which was not specified.");
586 ret = -EINVAL;
587 goto fail;
589 if (!aio_setup_linux_aio(bdrv_get_aio_context(bs), errp)) {
590 error_prepend(errp, "Unable to use native AIO: ");
591 goto fail;
594 #else
595 if (s->use_linux_aio) {
596 error_setg(errp, "aio=native was specified, but is not supported "
597 "in this build.");
598 ret = -EINVAL;
599 goto fail;
601 #endif /* !defined(CONFIG_LINUX_AIO) */
603 s->has_discard = true;
604 s->has_write_zeroes = true;
605 if ((bs->open_flags & BDRV_O_NOCACHE) != 0) {
606 s->needs_alignment = true;
609 if (fstat(s->fd, &st) < 0) {
610 ret = -errno;
611 error_setg_errno(errp, errno, "Could not stat file");
612 goto fail;
615 if (!device) {
616 if (S_ISBLK(st.st_mode)) {
617 warn_report("Opening a block device as a file using the '%s' "
618 "driver is deprecated", bs->drv->format_name);
619 } else if (S_ISCHR(st.st_mode)) {
620 warn_report("Opening a character device as a file using the '%s' "
621 "driver is deprecated", bs->drv->format_name);
622 } else if (!S_ISREG(st.st_mode)) {
623 error_setg(errp, "A regular file was expected by the '%s' driver, "
624 "but something else was given", bs->drv->format_name);
625 ret = -EINVAL;
626 goto fail;
627 } else {
628 s->discard_zeroes = true;
629 s->has_fallocate = true;
631 } else {
632 if (!(S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
633 error_setg(errp, "'%s' driver expects either "
634 "a character or block device", bs->drv->format_name);
635 ret = -EINVAL;
636 goto fail;
640 if (S_ISBLK(st.st_mode)) {
641 #ifdef BLKDISCARDZEROES
642 unsigned int arg;
643 if (ioctl(s->fd, BLKDISCARDZEROES, &arg) == 0 && arg) {
644 s->discard_zeroes = true;
646 #endif
647 #ifdef __linux__
648 /* On Linux 3.10, BLKDISCARD leaves stale data in the page cache. Do
649 * not rely on the contents of discarded blocks unless using O_DIRECT.
650 * Same for BLKZEROOUT.
652 if (!(bs->open_flags & BDRV_O_NOCACHE)) {
653 s->discard_zeroes = false;
654 s->has_write_zeroes = false;
656 #endif
658 #ifdef __FreeBSD__
659 if (S_ISCHR(st.st_mode)) {
661 * The file is a char device (disk), which on FreeBSD isn't behind
662 * a pager, so force all requests to be aligned. This is needed
663 * so QEMU makes sure all IO operations on the device are aligned
664 * to sector size, or else FreeBSD will reject them with EINVAL.
666 s->needs_alignment = true;
668 #endif
670 #ifdef CONFIG_XFS
671 if (platform_test_xfs_fd(s->fd)) {
672 s->is_xfs = true;
674 #endif
676 bs->supported_zero_flags = BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK;
677 ret = 0;
678 fail:
679 if (filename && (bdrv_flags & BDRV_O_TEMPORARY)) {
680 unlink(filename);
682 qemu_opts_del(opts);
683 return ret;
686 static int raw_open(BlockDriverState *bs, QDict *options, int flags,
687 Error **errp)
689 BDRVRawState *s = bs->opaque;
691 s->type = FTYPE_FILE;
692 return raw_open_common(bs, options, flags, 0, false, errp);
695 typedef enum {
696 RAW_PL_PREPARE,
697 RAW_PL_COMMIT,
698 RAW_PL_ABORT,
699 } RawPermLockOp;
701 #define PERM_FOREACH(i) \
702 for ((i) = 0; (1ULL << (i)) <= BLK_PERM_ALL; i++)
704 /* Lock bytes indicated by @perm_lock_bits and @shared_perm_lock_bits in the
705 * file; if @unlock == true, also unlock the unneeded bytes.
706 * @shared_perm_lock_bits is the mask of all permissions that are NOT shared.
708 static int raw_apply_lock_bytes(BDRVRawState *s, int fd,
709 uint64_t perm_lock_bits,
710 uint64_t shared_perm_lock_bits,
711 bool unlock, Error **errp)
713 int ret;
714 int i;
715 uint64_t locked_perm, locked_shared_perm;
717 if (s) {
718 locked_perm = s->locked_perm;
719 locked_shared_perm = s->locked_shared_perm;
720 } else {
722 * We don't have the previous bits, just lock/unlock for each of the
723 * requested bits.
725 if (unlock) {
726 locked_perm = BLK_PERM_ALL;
727 locked_shared_perm = BLK_PERM_ALL;
728 } else {
729 locked_perm = 0;
730 locked_shared_perm = 0;
734 PERM_FOREACH(i) {
735 int off = RAW_LOCK_PERM_BASE + i;
736 uint64_t bit = (1ULL << i);
737 if ((perm_lock_bits & bit) && !(locked_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_perm |= bit;
745 } else if (unlock && (locked_perm & bit) && !(perm_lock_bits & bit)) {
746 ret = qemu_unlock_fd(fd, off, 1);
747 if (ret) {
748 error_setg(errp, "Failed to unlock byte %d", off);
749 return ret;
750 } else if (s) {
751 s->locked_perm &= ~bit;
755 PERM_FOREACH(i) {
756 int off = RAW_LOCK_SHARED_BASE + i;
757 uint64_t bit = (1ULL << i);
758 if ((shared_perm_lock_bits & bit) && !(locked_shared_perm & bit)) {
759 ret = qemu_lock_fd(fd, off, 1, false);
760 if (ret) {
761 error_setg(errp, "Failed to lock byte %d", off);
762 return ret;
763 } else if (s) {
764 s->locked_shared_perm |= bit;
766 } else if (unlock && (locked_shared_perm & bit) &&
767 !(shared_perm_lock_bits & bit)) {
768 ret = qemu_unlock_fd(fd, off, 1);
769 if (ret) {
770 error_setg(errp, "Failed to unlock byte %d", off);
771 return ret;
772 } else if (s) {
773 s->locked_shared_perm &= ~bit;
777 return 0;
780 /* Check "unshared" bytes implied by @perm and ~@shared_perm in the file. */
781 static int raw_check_lock_bytes(int fd, uint64_t perm, uint64_t shared_perm,
782 Error **errp)
784 int ret;
785 int i;
787 PERM_FOREACH(i) {
788 int off = RAW_LOCK_SHARED_BASE + i;
789 uint64_t p = 1ULL << i;
790 if (perm & p) {
791 ret = qemu_lock_fd_test(fd, off, 1, true);
792 if (ret) {
793 char *perm_name = bdrv_perm_names(p);
794 error_setg(errp,
795 "Failed to get \"%s\" lock",
796 perm_name);
797 g_free(perm_name);
798 return ret;
802 PERM_FOREACH(i) {
803 int off = RAW_LOCK_PERM_BASE + i;
804 uint64_t p = 1ULL << i;
805 if (!(shared_perm & p)) {
806 ret = qemu_lock_fd_test(fd, off, 1, true);
807 if (ret) {
808 char *perm_name = bdrv_perm_names(p);
809 error_setg(errp,
810 "Failed to get shared \"%s\" lock",
811 perm_name);
812 g_free(perm_name);
813 return ret;
817 return 0;
820 static int raw_handle_perm_lock(BlockDriverState *bs,
821 RawPermLockOp op,
822 uint64_t new_perm, uint64_t new_shared,
823 Error **errp)
825 BDRVRawState *s = bs->opaque;
826 int ret = 0;
827 Error *local_err = NULL;
829 if (!s->use_lock) {
830 return 0;
833 if (bdrv_get_flags(bs) & BDRV_O_INACTIVE) {
834 return 0;
837 switch (op) {
838 case RAW_PL_PREPARE:
839 if ((s->perm | new_perm) == s->perm &&
840 (s->shared_perm & new_shared) == s->shared_perm)
843 * We are going to unlock bytes, it should not fail. If it fail due
844 * to some fs-dependent permission-unrelated reasons (which occurs
845 * sometimes on NFS and leads to abort in bdrv_replace_child) we
846 * can't prevent such errors by any check here. And we ignore them
847 * anyway in ABORT and COMMIT.
849 return 0;
851 ret = raw_apply_lock_bytes(s, s->fd, s->perm | new_perm,
852 ~s->shared_perm | ~new_shared,
853 false, errp);
854 if (!ret) {
855 ret = raw_check_lock_bytes(s->fd, new_perm, new_shared, errp);
856 if (!ret) {
857 return 0;
859 error_append_hint(errp,
860 "Is another process using the image [%s]?\n",
861 bs->filename);
863 op = RAW_PL_ABORT;
864 /* fall through to unlock bytes. */
865 case RAW_PL_ABORT:
866 raw_apply_lock_bytes(s, s->fd, s->perm, ~s->shared_perm,
867 true, &local_err);
868 if (local_err) {
869 /* Theoretically the above call only unlocks bytes and it cannot
870 * fail. Something weird happened, report it.
872 warn_report_err(local_err);
874 break;
875 case RAW_PL_COMMIT:
876 raw_apply_lock_bytes(s, s->fd, new_perm, ~new_shared,
877 true, &local_err);
878 if (local_err) {
879 /* Theoretically the above call only unlocks bytes and it cannot
880 * fail. Something weird happened, report it.
882 warn_report_err(local_err);
884 break;
886 return ret;
889 static int raw_reconfigure_getfd(BlockDriverState *bs, int flags,
890 int *open_flags, uint64_t perm, bool force_dup,
891 Error **errp)
893 BDRVRawState *s = bs->opaque;
894 int fd = -1;
895 int ret;
896 bool has_writers = perm &
897 (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED | BLK_PERM_RESIZE);
898 int fcntl_flags = O_APPEND | O_NONBLOCK;
899 #ifdef O_NOATIME
900 fcntl_flags |= O_NOATIME;
901 #endif
903 *open_flags = 0;
904 if (s->type == FTYPE_CD) {
905 *open_flags |= O_NONBLOCK;
908 raw_parse_flags(flags, open_flags, has_writers);
910 #ifdef O_ASYNC
911 /* Not all operating systems have O_ASYNC, and those that don't
912 * will not let us track the state into rs->open_flags (typically
913 * you achieve the same effect with an ioctl, for example I_SETSIG
914 * on Solaris). But we do not use O_ASYNC, so that's fine.
916 assert((s->open_flags & O_ASYNC) == 0);
917 #endif
919 if (!force_dup && *open_flags == s->open_flags) {
920 /* We're lucky, the existing fd is fine */
921 return s->fd;
924 if ((*open_flags & ~fcntl_flags) == (s->open_flags & ~fcntl_flags)) {
925 /* dup the original fd */
926 fd = qemu_dup(s->fd);
927 if (fd >= 0) {
928 ret = fcntl_setfl(fd, *open_flags);
929 if (ret) {
930 qemu_close(fd);
931 fd = -1;
936 /* If we cannot use fcntl, or fcntl failed, fall back to qemu_open() */
937 if (fd == -1) {
938 const char *normalized_filename = bs->filename;
939 ret = raw_normalize_devicepath(&normalized_filename, errp);
940 if (ret >= 0) {
941 assert(!(*open_flags & O_CREAT));
942 fd = qemu_open(normalized_filename, *open_flags);
943 if (fd == -1) {
944 error_setg_errno(errp, errno, "Could not reopen file");
945 return -1;
950 return fd;
953 static int raw_reopen_prepare(BDRVReopenState *state,
954 BlockReopenQueue *queue, Error **errp)
956 BDRVRawState *s;
957 BDRVRawReopenState *rs;
958 QemuOpts *opts;
959 int ret;
960 Error *local_err = NULL;
962 assert(state != NULL);
963 assert(state->bs != NULL);
965 s = state->bs->opaque;
967 state->opaque = g_new0(BDRVRawReopenState, 1);
968 rs = state->opaque;
970 /* Handle options changes */
971 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
972 qemu_opts_absorb_qdict(opts, state->options, &local_err);
973 if (local_err) {
974 error_propagate(errp, local_err);
975 ret = -EINVAL;
976 goto out;
979 rs->drop_cache = qemu_opt_get_bool_del(opts, "drop-cache", true);
980 rs->check_cache_dropped =
981 qemu_opt_get_bool_del(opts, "x-check-cache-dropped", false);
983 /* This driver's reopen function doesn't currently allow changing
984 * other options, so let's put them back in the original QDict and
985 * bdrv_reopen_prepare() will detect changes and complain. */
986 qemu_opts_to_qdict(opts, state->options);
988 rs->fd = raw_reconfigure_getfd(state->bs, state->flags, &rs->open_flags,
989 state->perm, true, &local_err);
990 if (local_err) {
991 error_propagate(errp, local_err);
992 ret = -1;
993 goto out;
996 /* Fail already reopen_prepare() if we can't get a working O_DIRECT
997 * alignment with the new fd. */
998 if (rs->fd != -1) {
999 raw_probe_alignment(state->bs, rs->fd, &local_err);
1000 if (local_err) {
1001 error_propagate(errp, local_err);
1002 ret = -EINVAL;
1003 goto out_fd;
1007 s->reopen_state = state;
1008 ret = 0;
1009 out_fd:
1010 if (ret < 0) {
1011 qemu_close(rs->fd);
1012 rs->fd = -1;
1014 out:
1015 qemu_opts_del(opts);
1016 return ret;
1019 static void raw_reopen_commit(BDRVReopenState *state)
1021 BDRVRawReopenState *rs = state->opaque;
1022 BDRVRawState *s = state->bs->opaque;
1024 s->drop_cache = rs->drop_cache;
1025 s->check_cache_dropped = rs->check_cache_dropped;
1026 s->open_flags = rs->open_flags;
1028 qemu_close(s->fd);
1029 s->fd = rs->fd;
1031 g_free(state->opaque);
1032 state->opaque = NULL;
1034 assert(s->reopen_state == state);
1035 s->reopen_state = NULL;
1039 static void raw_reopen_abort(BDRVReopenState *state)
1041 BDRVRawReopenState *rs = state->opaque;
1042 BDRVRawState *s = state->bs->opaque;
1044 /* nothing to do if NULL, we didn't get far enough */
1045 if (rs == NULL) {
1046 return;
1049 if (rs->fd >= 0) {
1050 qemu_close(rs->fd);
1051 rs->fd = -1;
1053 g_free(state->opaque);
1054 state->opaque = NULL;
1056 assert(s->reopen_state == state);
1057 s->reopen_state = NULL;
1060 static int sg_get_max_transfer_length(int fd)
1062 #ifdef BLKSECTGET
1063 int max_bytes = 0;
1065 if (ioctl(fd, BLKSECTGET, &max_bytes) == 0) {
1066 return max_bytes;
1067 } else {
1068 return -errno;
1070 #else
1071 return -ENOSYS;
1072 #endif
1075 static int sg_get_max_segments(int fd)
1077 #ifdef CONFIG_LINUX
1078 char buf[32];
1079 const char *end;
1080 char *sysfspath = NULL;
1081 int ret;
1082 int sysfd = -1;
1083 long max_segments;
1084 struct stat st;
1086 if (fstat(fd, &st)) {
1087 ret = -errno;
1088 goto out;
1091 sysfspath = g_strdup_printf("/sys/dev/block/%u:%u/queue/max_segments",
1092 major(st.st_rdev), minor(st.st_rdev));
1093 sysfd = open(sysfspath, O_RDONLY);
1094 if (sysfd == -1) {
1095 ret = -errno;
1096 goto out;
1098 do {
1099 ret = read(sysfd, buf, sizeof(buf) - 1);
1100 } while (ret == -1 && errno == EINTR);
1101 if (ret < 0) {
1102 ret = -errno;
1103 goto out;
1104 } else if (ret == 0) {
1105 ret = -EIO;
1106 goto out;
1108 buf[ret] = 0;
1109 /* The file is ended with '\n', pass 'end' to accept that. */
1110 ret = qemu_strtol(buf, &end, 10, &max_segments);
1111 if (ret == 0 && end && *end == '\n') {
1112 ret = max_segments;
1115 out:
1116 if (sysfd != -1) {
1117 close(sysfd);
1119 g_free(sysfspath);
1120 return ret;
1121 #else
1122 return -ENOTSUP;
1123 #endif
1126 static void raw_refresh_limits(BlockDriverState *bs, Error **errp)
1128 BDRVRawState *s = bs->opaque;
1130 if (bs->sg) {
1131 int ret = sg_get_max_transfer_length(s->fd);
1133 if (ret > 0 && ret <= BDRV_REQUEST_MAX_BYTES) {
1134 bs->bl.max_transfer = pow2floor(ret);
1137 ret = sg_get_max_segments(s->fd);
1138 if (ret > 0) {
1139 bs->bl.max_transfer = MIN(bs->bl.max_transfer, ret * getpagesize());
1143 raw_probe_alignment(bs, s->fd, errp);
1144 bs->bl.min_mem_alignment = s->buf_align;
1145 bs->bl.opt_mem_alignment = MAX(s->buf_align, getpagesize());
1148 static int check_for_dasd(int fd)
1150 #ifdef BIODASDINFO2
1151 struct dasd_information2_t info = {0};
1153 return ioctl(fd, BIODASDINFO2, &info);
1154 #else
1155 return -1;
1156 #endif
1160 * Try to get @bs's logical and physical block size.
1161 * On success, store them in @bsz and return zero.
1162 * On failure, return negative errno.
1164 static int hdev_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz)
1166 BDRVRawState *s = bs->opaque;
1167 int ret;
1169 /* If DASD, get blocksizes */
1170 if (check_for_dasd(s->fd) < 0) {
1171 return -ENOTSUP;
1173 ret = probe_logical_blocksize(s->fd, &bsz->log);
1174 if (ret < 0) {
1175 return ret;
1177 return probe_physical_blocksize(s->fd, &bsz->phys);
1181 * Try to get @bs's geometry: cyls, heads, sectors.
1182 * On success, store them in @geo and return 0.
1183 * On failure return -errno.
1184 * (Allows block driver to assign default geometry values that guest sees)
1186 #ifdef __linux__
1187 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1189 BDRVRawState *s = bs->opaque;
1190 struct hd_geometry ioctl_geo = {0};
1192 /* If DASD, get its geometry */
1193 if (check_for_dasd(s->fd) < 0) {
1194 return -ENOTSUP;
1196 if (ioctl(s->fd, HDIO_GETGEO, &ioctl_geo) < 0) {
1197 return -errno;
1199 /* HDIO_GETGEO may return success even though geo contains zeros
1200 (e.g. certain multipath setups) */
1201 if (!ioctl_geo.heads || !ioctl_geo.sectors || !ioctl_geo.cylinders) {
1202 return -ENOTSUP;
1204 /* Do not return a geometry for partition */
1205 if (ioctl_geo.start != 0) {
1206 return -ENOTSUP;
1208 geo->heads = ioctl_geo.heads;
1209 geo->sectors = ioctl_geo.sectors;
1210 geo->cylinders = ioctl_geo.cylinders;
1212 return 0;
1214 #else /* __linux__ */
1215 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1217 return -ENOTSUP;
1219 #endif
1221 #if defined(__linux__)
1222 static int handle_aiocb_ioctl(void *opaque)
1224 RawPosixAIOData *aiocb = opaque;
1225 int ret;
1227 ret = ioctl(aiocb->aio_fildes, aiocb->ioctl.cmd, aiocb->ioctl.buf);
1228 if (ret == -1) {
1229 return -errno;
1232 return 0;
1234 #endif /* linux */
1236 static int handle_aiocb_flush(void *opaque)
1238 RawPosixAIOData *aiocb = opaque;
1239 BDRVRawState *s = aiocb->bs->opaque;
1240 int ret;
1242 if (s->page_cache_inconsistent) {
1243 return -EIO;
1246 ret = qemu_fdatasync(aiocb->aio_fildes);
1247 if (ret == -1) {
1248 /* There is no clear definition of the semantics of a failing fsync(),
1249 * so we may have to assume the worst. The sad truth is that this
1250 * assumption is correct for Linux. Some pages are now probably marked
1251 * clean in the page cache even though they are inconsistent with the
1252 * on-disk contents. The next fdatasync() call would succeed, but no
1253 * further writeback attempt will be made. We can't get back to a state
1254 * in which we know what is on disk (we would have to rewrite
1255 * everything that was touched since the last fdatasync() at least), so
1256 * make bdrv_flush() fail permanently. Given that the behaviour isn't
1257 * really defined, I have little hope that other OSes are doing better.
1259 * Obviously, this doesn't affect O_DIRECT, which bypasses the page
1260 * cache. */
1261 if ((s->open_flags & O_DIRECT) == 0) {
1262 s->page_cache_inconsistent = true;
1264 return -errno;
1266 return 0;
1269 #ifdef CONFIG_PREADV
1271 static bool preadv_present = true;
1273 static ssize_t
1274 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1276 return preadv(fd, iov, nr_iov, offset);
1279 static ssize_t
1280 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1282 return pwritev(fd, iov, nr_iov, offset);
1285 #else
1287 static bool preadv_present = false;
1289 static ssize_t
1290 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1292 return -ENOSYS;
1295 static ssize_t
1296 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1298 return -ENOSYS;
1301 #endif
1303 static ssize_t handle_aiocb_rw_vector(RawPosixAIOData *aiocb)
1305 ssize_t len;
1307 do {
1308 if (aiocb->aio_type & QEMU_AIO_WRITE)
1309 len = qemu_pwritev(aiocb->aio_fildes,
1310 aiocb->io.iov,
1311 aiocb->io.niov,
1312 aiocb->aio_offset);
1313 else
1314 len = qemu_preadv(aiocb->aio_fildes,
1315 aiocb->io.iov,
1316 aiocb->io.niov,
1317 aiocb->aio_offset);
1318 } while (len == -1 && errno == EINTR);
1320 if (len == -1) {
1321 return -errno;
1323 return len;
1327 * Read/writes the data to/from a given linear buffer.
1329 * Returns the number of bytes handles or -errno in case of an error. Short
1330 * reads are only returned if the end of the file is reached.
1332 static ssize_t handle_aiocb_rw_linear(RawPosixAIOData *aiocb, char *buf)
1334 ssize_t offset = 0;
1335 ssize_t len;
1337 while (offset < aiocb->aio_nbytes) {
1338 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1339 len = pwrite(aiocb->aio_fildes,
1340 (const char *)buf + offset,
1341 aiocb->aio_nbytes - offset,
1342 aiocb->aio_offset + offset);
1343 } else {
1344 len = pread(aiocb->aio_fildes,
1345 buf + offset,
1346 aiocb->aio_nbytes - offset,
1347 aiocb->aio_offset + offset);
1349 if (len == -1 && errno == EINTR) {
1350 continue;
1351 } else if (len == -1 && errno == EINVAL &&
1352 (aiocb->bs->open_flags & BDRV_O_NOCACHE) &&
1353 !(aiocb->aio_type & QEMU_AIO_WRITE) &&
1354 offset > 0) {
1355 /* O_DIRECT pread() may fail with EINVAL when offset is unaligned
1356 * after a short read. Assume that O_DIRECT short reads only occur
1357 * at EOF. Therefore this is a short read, not an I/O error.
1359 break;
1360 } else if (len == -1) {
1361 offset = -errno;
1362 break;
1363 } else if (len == 0) {
1364 break;
1366 offset += len;
1369 return offset;
1372 static int handle_aiocb_rw(void *opaque)
1374 RawPosixAIOData *aiocb = opaque;
1375 ssize_t nbytes;
1376 char *buf;
1378 if (!(aiocb->aio_type & QEMU_AIO_MISALIGNED)) {
1380 * If there is just a single buffer, and it is properly aligned
1381 * we can just use plain pread/pwrite without any problems.
1383 if (aiocb->io.niov == 1) {
1384 nbytes = handle_aiocb_rw_linear(aiocb, aiocb->io.iov->iov_base);
1385 goto out;
1388 * We have more than one iovec, and all are properly aligned.
1390 * Try preadv/pwritev first and fall back to linearizing the
1391 * buffer if it's not supported.
1393 if (preadv_present) {
1394 nbytes = handle_aiocb_rw_vector(aiocb);
1395 if (nbytes == aiocb->aio_nbytes ||
1396 (nbytes < 0 && nbytes != -ENOSYS)) {
1397 goto out;
1399 preadv_present = false;
1403 * XXX(hch): short read/write. no easy way to handle the reminder
1404 * using these interfaces. For now retry using plain
1405 * pread/pwrite?
1410 * Ok, we have to do it the hard way, copy all segments into
1411 * a single aligned buffer.
1413 buf = qemu_try_blockalign(aiocb->bs, aiocb->aio_nbytes);
1414 if (buf == NULL) {
1415 nbytes = -ENOMEM;
1416 goto out;
1419 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1420 char *p = buf;
1421 int i;
1423 for (i = 0; i < aiocb->io.niov; ++i) {
1424 memcpy(p, aiocb->io.iov[i].iov_base, aiocb->io.iov[i].iov_len);
1425 p += aiocb->io.iov[i].iov_len;
1427 assert(p - buf == aiocb->aio_nbytes);
1430 nbytes = handle_aiocb_rw_linear(aiocb, buf);
1431 if (!(aiocb->aio_type & QEMU_AIO_WRITE)) {
1432 char *p = buf;
1433 size_t count = aiocb->aio_nbytes, copy;
1434 int i;
1436 for (i = 0; i < aiocb->io.niov && count; ++i) {
1437 copy = count;
1438 if (copy > aiocb->io.iov[i].iov_len) {
1439 copy = aiocb->io.iov[i].iov_len;
1441 memcpy(aiocb->io.iov[i].iov_base, p, copy);
1442 assert(count >= copy);
1443 p += copy;
1444 count -= copy;
1446 assert(count == 0);
1448 qemu_vfree(buf);
1450 out:
1451 if (nbytes == aiocb->aio_nbytes) {
1452 return 0;
1453 } else if (nbytes >= 0 && nbytes < aiocb->aio_nbytes) {
1454 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1455 return -EINVAL;
1456 } else {
1457 iov_memset(aiocb->io.iov, aiocb->io.niov, nbytes,
1458 0, aiocb->aio_nbytes - nbytes);
1459 return 0;
1461 } else {
1462 assert(nbytes < 0);
1463 return nbytes;
1467 static int translate_err(int err)
1469 if (err == -ENODEV || err == -ENOSYS || err == -EOPNOTSUPP ||
1470 err == -ENOTTY) {
1471 err = -ENOTSUP;
1473 return err;
1476 #ifdef CONFIG_FALLOCATE
1477 static int do_fallocate(int fd, int mode, off_t offset, off_t len)
1479 do {
1480 if (fallocate(fd, mode, offset, len) == 0) {
1481 return 0;
1483 } while (errno == EINTR);
1484 return translate_err(-errno);
1486 #endif
1488 static ssize_t handle_aiocb_write_zeroes_block(RawPosixAIOData *aiocb)
1490 int ret = -ENOTSUP;
1491 BDRVRawState *s = aiocb->bs->opaque;
1493 if (!s->has_write_zeroes) {
1494 return -ENOTSUP;
1497 #ifdef BLKZEROOUT
1498 /* The BLKZEROOUT implementation in the kernel doesn't set
1499 * BLKDEV_ZERO_NOFALLBACK, so we can't call this if we have to avoid slow
1500 * fallbacks. */
1501 if (!(aiocb->aio_type & QEMU_AIO_NO_FALLBACK)) {
1502 do {
1503 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1504 if (ioctl(aiocb->aio_fildes, BLKZEROOUT, range) == 0) {
1505 return 0;
1507 } while (errno == EINTR);
1509 ret = translate_err(-errno);
1510 if (ret == -ENOTSUP) {
1511 s->has_write_zeroes = false;
1514 #endif
1516 return ret;
1519 static int handle_aiocb_write_zeroes(void *opaque)
1521 RawPosixAIOData *aiocb = opaque;
1522 #ifdef CONFIG_FALLOCATE
1523 BDRVRawState *s = aiocb->bs->opaque;
1524 int64_t len;
1525 #endif
1527 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1528 return handle_aiocb_write_zeroes_block(aiocb);
1531 #ifdef CONFIG_FALLOCATE_ZERO_RANGE
1532 if (s->has_write_zeroes) {
1533 int ret = do_fallocate(s->fd, FALLOC_FL_ZERO_RANGE,
1534 aiocb->aio_offset, aiocb->aio_nbytes);
1535 if (ret == -EINVAL) {
1537 * Allow falling back to pwrite for file systems that
1538 * do not support fallocate() for an unaligned byte range.
1540 return -ENOTSUP;
1542 if (ret == 0 || ret != -ENOTSUP) {
1543 return ret;
1545 s->has_write_zeroes = false;
1547 #endif
1549 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1550 if (s->has_discard && s->has_fallocate) {
1551 int ret = do_fallocate(s->fd,
1552 FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1553 aiocb->aio_offset, aiocb->aio_nbytes);
1554 if (ret == 0) {
1555 ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1556 if (ret == 0 || ret != -ENOTSUP) {
1557 return ret;
1559 s->has_fallocate = false;
1560 } else if (ret != -ENOTSUP) {
1561 return ret;
1562 } else {
1563 s->has_discard = false;
1566 #endif
1568 #ifdef CONFIG_FALLOCATE
1569 /* Last resort: we are trying to extend the file with zeroed data. This
1570 * can be done via fallocate(fd, 0) */
1571 len = bdrv_getlength(aiocb->bs);
1572 if (s->has_fallocate && len >= 0 && aiocb->aio_offset >= len) {
1573 int ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1574 if (ret == 0 || ret != -ENOTSUP) {
1575 return ret;
1577 s->has_fallocate = false;
1579 #endif
1581 return -ENOTSUP;
1584 static int handle_aiocb_write_zeroes_unmap(void *opaque)
1586 RawPosixAIOData *aiocb = opaque;
1587 BDRVRawState *s G_GNUC_UNUSED = aiocb->bs->opaque;
1588 int ret;
1590 /* First try to write zeros and unmap at the same time */
1592 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1593 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1594 aiocb->aio_offset, aiocb->aio_nbytes);
1595 if (ret != -ENOTSUP) {
1596 return ret;
1598 #endif
1600 /* If we couldn't manage to unmap while guaranteed that the area reads as
1601 * all-zero afterwards, just write zeroes without unmapping */
1602 ret = handle_aiocb_write_zeroes(aiocb);
1603 return ret;
1606 #ifndef HAVE_COPY_FILE_RANGE
1607 static off_t copy_file_range(int in_fd, off_t *in_off, int out_fd,
1608 off_t *out_off, size_t len, unsigned int flags)
1610 #ifdef __NR_copy_file_range
1611 return syscall(__NR_copy_file_range, in_fd, in_off, out_fd,
1612 out_off, len, flags);
1613 #else
1614 errno = ENOSYS;
1615 return -1;
1616 #endif
1618 #endif
1620 static int handle_aiocb_copy_range(void *opaque)
1622 RawPosixAIOData *aiocb = opaque;
1623 uint64_t bytes = aiocb->aio_nbytes;
1624 off_t in_off = aiocb->aio_offset;
1625 off_t out_off = aiocb->copy_range.aio_offset2;
1627 while (bytes) {
1628 ssize_t ret = copy_file_range(aiocb->aio_fildes, &in_off,
1629 aiocb->copy_range.aio_fd2, &out_off,
1630 bytes, 0);
1631 trace_file_copy_file_range(aiocb->bs, aiocb->aio_fildes, in_off,
1632 aiocb->copy_range.aio_fd2, out_off, bytes,
1633 0, ret);
1634 if (ret == 0) {
1635 /* No progress (e.g. when beyond EOF), let the caller fall back to
1636 * buffer I/O. */
1637 return -ENOSPC;
1639 if (ret < 0) {
1640 switch (errno) {
1641 case ENOSYS:
1642 return -ENOTSUP;
1643 case EINTR:
1644 continue;
1645 default:
1646 return -errno;
1649 bytes -= ret;
1651 return 0;
1654 static int handle_aiocb_discard(void *opaque)
1656 RawPosixAIOData *aiocb = opaque;
1657 int ret = -EOPNOTSUPP;
1658 BDRVRawState *s = aiocb->bs->opaque;
1660 if (!s->has_discard) {
1661 return -ENOTSUP;
1664 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1665 #ifdef BLKDISCARD
1666 do {
1667 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1668 if (ioctl(aiocb->aio_fildes, BLKDISCARD, range) == 0) {
1669 return 0;
1671 } while (errno == EINTR);
1673 ret = -errno;
1674 #endif
1675 } else {
1676 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1677 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1678 aiocb->aio_offset, aiocb->aio_nbytes);
1679 #endif
1682 ret = translate_err(ret);
1683 if (ret == -ENOTSUP) {
1684 s->has_discard = false;
1686 return ret;
1690 * Help alignment probing by allocating the first block.
1692 * When reading with direct I/O from unallocated area on Gluster backed by XFS,
1693 * reading succeeds regardless of request length. In this case we fallback to
1694 * safe alignment which is not optimal. Allocating the first block avoids this
1695 * fallback.
1697 * fd may be opened with O_DIRECT, but we don't know the buffer alignment or
1698 * request alignment, so we use safe values.
1700 * Returns: 0 on success, -errno on failure. Since this is an optimization,
1701 * caller may ignore failures.
1703 static int allocate_first_block(int fd, size_t max_size)
1705 size_t write_size = (max_size < MAX_BLOCKSIZE)
1706 ? BDRV_SECTOR_SIZE
1707 : MAX_BLOCKSIZE;
1708 size_t max_align = MAX(MAX_BLOCKSIZE, getpagesize());
1709 void *buf;
1710 ssize_t n;
1711 int ret;
1713 buf = qemu_memalign(max_align, write_size);
1714 memset(buf, 0, write_size);
1716 do {
1717 n = pwrite(fd, buf, write_size, 0);
1718 } while (n == -1 && errno == EINTR);
1720 ret = (n == -1) ? -errno : 0;
1722 qemu_vfree(buf);
1723 return ret;
1726 static int handle_aiocb_truncate(void *opaque)
1728 RawPosixAIOData *aiocb = opaque;
1729 int result = 0;
1730 int64_t current_length = 0;
1731 char *buf = NULL;
1732 struct stat st;
1733 int fd = aiocb->aio_fildes;
1734 int64_t offset = aiocb->aio_offset;
1735 PreallocMode prealloc = aiocb->truncate.prealloc;
1736 Error **errp = aiocb->truncate.errp;
1738 if (fstat(fd, &st) < 0) {
1739 result = -errno;
1740 error_setg_errno(errp, -result, "Could not stat file");
1741 return result;
1744 current_length = st.st_size;
1745 if (current_length > offset && prealloc != PREALLOC_MODE_OFF) {
1746 error_setg(errp, "Cannot use preallocation for shrinking files");
1747 return -ENOTSUP;
1750 switch (prealloc) {
1751 #ifdef CONFIG_POSIX_FALLOCATE
1752 case PREALLOC_MODE_FALLOC:
1754 * Truncating before posix_fallocate() makes it about twice slower on
1755 * file systems that do not support fallocate(), trying to check if a
1756 * block is allocated before allocating it, so don't do that here.
1758 if (offset != current_length) {
1759 result = -posix_fallocate(fd, current_length,
1760 offset - current_length);
1761 if (result != 0) {
1762 /* posix_fallocate() doesn't set errno. */
1763 error_setg_errno(errp, -result,
1764 "Could not preallocate new data");
1765 } else if (current_length == 0) {
1767 * posix_fallocate() uses fallocate() if the filesystem
1768 * supports it, or fallback to manually writing zeroes. If
1769 * fallocate() was used, unaligned reads from the fallocated
1770 * area in raw_probe_alignment() will succeed, hence we need to
1771 * allocate the first block.
1773 * Optimize future alignment probing; ignore failures.
1775 allocate_first_block(fd, offset);
1777 } else {
1778 result = 0;
1780 goto out;
1781 #endif
1782 case PREALLOC_MODE_FULL:
1784 int64_t num = 0, left = offset - current_length;
1785 off_t seek_result;
1788 * Knowing the final size from the beginning could allow the file
1789 * system driver to do less allocations and possibly avoid
1790 * fragmentation of the file.
1792 if (ftruncate(fd, offset) != 0) {
1793 result = -errno;
1794 error_setg_errno(errp, -result, "Could not resize file");
1795 goto out;
1798 buf = g_malloc0(65536);
1800 seek_result = lseek(fd, current_length, SEEK_SET);
1801 if (seek_result < 0) {
1802 result = -errno;
1803 error_setg_errno(errp, -result,
1804 "Failed to seek to the old end of file");
1805 goto out;
1808 while (left > 0) {
1809 num = MIN(left, 65536);
1810 result = write(fd, buf, num);
1811 if (result < 0) {
1812 if (errno == EINTR) {
1813 continue;
1815 result = -errno;
1816 error_setg_errno(errp, -result,
1817 "Could not write zeros for preallocation");
1818 goto out;
1820 left -= result;
1822 if (result >= 0) {
1823 result = fsync(fd);
1824 if (result < 0) {
1825 result = -errno;
1826 error_setg_errno(errp, -result,
1827 "Could not flush file to disk");
1828 goto out;
1831 goto out;
1833 case PREALLOC_MODE_OFF:
1834 if (ftruncate(fd, offset) != 0) {
1835 result = -errno;
1836 error_setg_errno(errp, -result, "Could not resize file");
1837 } else if (current_length == 0 && offset > current_length) {
1838 /* Optimize future alignment probing; ignore failures. */
1839 allocate_first_block(fd, offset);
1841 return result;
1842 default:
1843 result = -ENOTSUP;
1844 error_setg(errp, "Unsupported preallocation mode: %s",
1845 PreallocMode_str(prealloc));
1846 return result;
1849 out:
1850 if (result < 0) {
1851 if (ftruncate(fd, current_length) < 0) {
1852 error_report("Failed to restore old file length: %s",
1853 strerror(errno));
1857 g_free(buf);
1858 return result;
1861 static int coroutine_fn raw_thread_pool_submit(BlockDriverState *bs,
1862 ThreadPoolFunc func, void *arg)
1864 /* @bs can be NULL, bdrv_get_aio_context() returns the main context then */
1865 ThreadPool *pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
1866 return thread_pool_submit_co(pool, func, arg);
1869 static int coroutine_fn raw_co_prw(BlockDriverState *bs, uint64_t offset,
1870 uint64_t bytes, QEMUIOVector *qiov, int type)
1872 BDRVRawState *s = bs->opaque;
1873 RawPosixAIOData acb;
1875 if (fd_open(bs) < 0)
1876 return -EIO;
1879 * Check if the underlying device requires requests to be aligned,
1880 * and if the request we are trying to submit is aligned or not.
1881 * If this is the case tell the low-level driver that it needs
1882 * to copy the buffer.
1884 if (s->needs_alignment) {
1885 if (!bdrv_qiov_is_aligned(bs, qiov)) {
1886 type |= QEMU_AIO_MISALIGNED;
1887 #ifdef CONFIG_LINUX_AIO
1888 } else if (s->use_linux_aio) {
1889 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1890 assert(qiov->size == bytes);
1891 return laio_co_submit(bs, aio, s->fd, offset, qiov, type);
1892 #endif
1896 acb = (RawPosixAIOData) {
1897 .bs = bs,
1898 .aio_fildes = s->fd,
1899 .aio_type = type,
1900 .aio_offset = offset,
1901 .aio_nbytes = bytes,
1902 .io = {
1903 .iov = qiov->iov,
1904 .niov = qiov->niov,
1908 assert(qiov->size == bytes);
1909 return raw_thread_pool_submit(bs, handle_aiocb_rw, &acb);
1912 static int coroutine_fn raw_co_preadv(BlockDriverState *bs, uint64_t offset,
1913 uint64_t bytes, QEMUIOVector *qiov,
1914 int flags)
1916 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_READ);
1919 static int coroutine_fn raw_co_pwritev(BlockDriverState *bs, uint64_t offset,
1920 uint64_t bytes, QEMUIOVector *qiov,
1921 int flags)
1923 assert(flags == 0);
1924 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_WRITE);
1927 static void raw_aio_plug(BlockDriverState *bs)
1929 #ifdef CONFIG_LINUX_AIO
1930 BDRVRawState *s = bs->opaque;
1931 if (s->use_linux_aio) {
1932 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1933 laio_io_plug(bs, aio);
1935 #endif
1938 static void raw_aio_unplug(BlockDriverState *bs)
1940 #ifdef CONFIG_LINUX_AIO
1941 BDRVRawState *s = bs->opaque;
1942 if (s->use_linux_aio) {
1943 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1944 laio_io_unplug(bs, aio);
1946 #endif
1949 static int raw_co_flush_to_disk(BlockDriverState *bs)
1951 BDRVRawState *s = bs->opaque;
1952 RawPosixAIOData acb;
1953 int ret;
1955 ret = fd_open(bs);
1956 if (ret < 0) {
1957 return ret;
1960 acb = (RawPosixAIOData) {
1961 .bs = bs,
1962 .aio_fildes = s->fd,
1963 .aio_type = QEMU_AIO_FLUSH,
1966 return raw_thread_pool_submit(bs, handle_aiocb_flush, &acb);
1969 static void raw_aio_attach_aio_context(BlockDriverState *bs,
1970 AioContext *new_context)
1972 #ifdef CONFIG_LINUX_AIO
1973 BDRVRawState *s = bs->opaque;
1974 if (s->use_linux_aio) {
1975 Error *local_err;
1976 if (!aio_setup_linux_aio(new_context, &local_err)) {
1977 error_reportf_err(local_err, "Unable to use native AIO, "
1978 "falling back to thread pool: ");
1979 s->use_linux_aio = false;
1982 #endif
1985 static void raw_close(BlockDriverState *bs)
1987 BDRVRawState *s = bs->opaque;
1989 if (s->fd >= 0) {
1990 qemu_close(s->fd);
1991 s->fd = -1;
1996 * Truncates the given regular file @fd to @offset and, when growing, fills the
1997 * new space according to @prealloc.
1999 * Returns: 0 on success, -errno on failure.
2001 static int coroutine_fn
2002 raw_regular_truncate(BlockDriverState *bs, int fd, int64_t offset,
2003 PreallocMode prealloc, Error **errp)
2005 RawPosixAIOData acb;
2007 acb = (RawPosixAIOData) {
2008 .bs = bs,
2009 .aio_fildes = fd,
2010 .aio_type = QEMU_AIO_TRUNCATE,
2011 .aio_offset = offset,
2012 .truncate = {
2013 .prealloc = prealloc,
2014 .errp = errp,
2018 return raw_thread_pool_submit(bs, handle_aiocb_truncate, &acb);
2021 static int coroutine_fn raw_co_truncate(BlockDriverState *bs, int64_t offset,
2022 PreallocMode prealloc, Error **errp)
2024 BDRVRawState *s = bs->opaque;
2025 struct stat st;
2026 int ret;
2028 if (fstat(s->fd, &st)) {
2029 ret = -errno;
2030 error_setg_errno(errp, -ret, "Failed to fstat() the file");
2031 return ret;
2034 if (S_ISREG(st.st_mode)) {
2035 return raw_regular_truncate(bs, s->fd, offset, prealloc, errp);
2038 if (prealloc != PREALLOC_MODE_OFF) {
2039 error_setg(errp, "Preallocation mode '%s' unsupported for this "
2040 "non-regular file", PreallocMode_str(prealloc));
2041 return -ENOTSUP;
2044 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2045 if (offset > raw_getlength(bs)) {
2046 error_setg(errp, "Cannot grow device files");
2047 return -EINVAL;
2049 } else {
2050 error_setg(errp, "Resizing this file is not supported");
2051 return -ENOTSUP;
2054 return 0;
2057 #ifdef __OpenBSD__
2058 static int64_t raw_getlength(BlockDriverState *bs)
2060 BDRVRawState *s = bs->opaque;
2061 int fd = s->fd;
2062 struct stat st;
2064 if (fstat(fd, &st))
2065 return -errno;
2066 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2067 struct disklabel dl;
2069 if (ioctl(fd, DIOCGDINFO, &dl))
2070 return -errno;
2071 return (uint64_t)dl.d_secsize *
2072 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2073 } else
2074 return st.st_size;
2076 #elif defined(__NetBSD__)
2077 static int64_t raw_getlength(BlockDriverState *bs)
2079 BDRVRawState *s = bs->opaque;
2080 int fd = s->fd;
2081 struct stat st;
2083 if (fstat(fd, &st))
2084 return -errno;
2085 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2086 struct dkwedge_info dkw;
2088 if (ioctl(fd, DIOCGWEDGEINFO, &dkw) != -1) {
2089 return dkw.dkw_size * 512;
2090 } else {
2091 struct disklabel dl;
2093 if (ioctl(fd, DIOCGDINFO, &dl))
2094 return -errno;
2095 return (uint64_t)dl.d_secsize *
2096 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2098 } else
2099 return st.st_size;
2101 #elif defined(__sun__)
2102 static int64_t raw_getlength(BlockDriverState *bs)
2104 BDRVRawState *s = bs->opaque;
2105 struct dk_minfo minfo;
2106 int ret;
2107 int64_t size;
2109 ret = fd_open(bs);
2110 if (ret < 0) {
2111 return ret;
2115 * Use the DKIOCGMEDIAINFO ioctl to read the size.
2117 ret = ioctl(s->fd, DKIOCGMEDIAINFO, &minfo);
2118 if (ret != -1) {
2119 return minfo.dki_lbsize * minfo.dki_capacity;
2123 * There are reports that lseek on some devices fails, but
2124 * irc discussion said that contingency on contingency was overkill.
2126 size = lseek(s->fd, 0, SEEK_END);
2127 if (size < 0) {
2128 return -errno;
2130 return size;
2132 #elif defined(CONFIG_BSD)
2133 static int64_t raw_getlength(BlockDriverState *bs)
2135 BDRVRawState *s = bs->opaque;
2136 int fd = s->fd;
2137 int64_t size;
2138 struct stat sb;
2139 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2140 int reopened = 0;
2141 #endif
2142 int ret;
2144 ret = fd_open(bs);
2145 if (ret < 0)
2146 return ret;
2148 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2149 again:
2150 #endif
2151 if (!fstat(fd, &sb) && (S_IFCHR & sb.st_mode)) {
2152 #ifdef DIOCGMEDIASIZE
2153 if (ioctl(fd, DIOCGMEDIASIZE, (off_t *)&size))
2154 #elif defined(DIOCGPART)
2156 struct partinfo pi;
2157 if (ioctl(fd, DIOCGPART, &pi) == 0)
2158 size = pi.media_size;
2159 else
2160 size = 0;
2162 if (size == 0)
2163 #endif
2164 #if defined(__APPLE__) && defined(__MACH__)
2166 uint64_t sectors = 0;
2167 uint32_t sector_size = 0;
2169 if (ioctl(fd, DKIOCGETBLOCKCOUNT, &sectors) == 0
2170 && ioctl(fd, DKIOCGETBLOCKSIZE, &sector_size) == 0) {
2171 size = sectors * sector_size;
2172 } else {
2173 size = lseek(fd, 0LL, SEEK_END);
2174 if (size < 0) {
2175 return -errno;
2179 #else
2180 size = lseek(fd, 0LL, SEEK_END);
2181 if (size < 0) {
2182 return -errno;
2184 #endif
2185 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
2186 switch(s->type) {
2187 case FTYPE_CD:
2188 /* XXX FreeBSD acd returns UINT_MAX sectors for an empty drive */
2189 if (size == 2048LL * (unsigned)-1)
2190 size = 0;
2191 /* XXX no disc? maybe we need to reopen... */
2192 if (size <= 0 && !reopened && cdrom_reopen(bs) >= 0) {
2193 reopened = 1;
2194 goto again;
2197 #endif
2198 } else {
2199 size = lseek(fd, 0, SEEK_END);
2200 if (size < 0) {
2201 return -errno;
2204 return size;
2206 #else
2207 static int64_t raw_getlength(BlockDriverState *bs)
2209 BDRVRawState *s = bs->opaque;
2210 int ret;
2211 int64_t size;
2213 ret = fd_open(bs);
2214 if (ret < 0) {
2215 return ret;
2218 size = lseek(s->fd, 0, SEEK_END);
2219 if (size < 0) {
2220 return -errno;
2222 return size;
2224 #endif
2226 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
2228 struct stat st;
2229 BDRVRawState *s = bs->opaque;
2231 if (fstat(s->fd, &st) < 0) {
2232 return -errno;
2234 return (int64_t)st.st_blocks * 512;
2237 static int coroutine_fn
2238 raw_co_create(BlockdevCreateOptions *options, Error **errp)
2240 BlockdevCreateOptionsFile *file_opts;
2241 Error *local_err = NULL;
2242 int fd;
2243 uint64_t perm, shared;
2244 int result = 0;
2246 /* Validate options and set default values */
2247 assert(options->driver == BLOCKDEV_DRIVER_FILE);
2248 file_opts = &options->u.file;
2250 if (!file_opts->has_nocow) {
2251 file_opts->nocow = false;
2253 if (!file_opts->has_preallocation) {
2254 file_opts->preallocation = PREALLOC_MODE_OFF;
2257 /* Create file */
2258 fd = qemu_open(file_opts->filename, O_RDWR | O_CREAT | O_BINARY, 0644);
2259 if (fd < 0) {
2260 result = -errno;
2261 error_setg_errno(errp, -result, "Could not create file");
2262 goto out;
2265 /* Take permissions: We want to discard everything, so we need
2266 * BLK_PERM_WRITE; and truncation to the desired size requires
2267 * BLK_PERM_RESIZE.
2268 * On the other hand, we cannot share the RESIZE permission
2269 * because we promise that after this function, the file has the
2270 * size given in the options. If someone else were to resize it
2271 * concurrently, we could not guarantee that.
2272 * Note that after this function, we can no longer guarantee that
2273 * the file is not touched by a third party, so it may be resized
2274 * then. */
2275 perm = BLK_PERM_WRITE | BLK_PERM_RESIZE;
2276 shared = BLK_PERM_ALL & ~BLK_PERM_RESIZE;
2278 /* Step one: Take locks */
2279 result = raw_apply_lock_bytes(NULL, fd, perm, ~shared, false, errp);
2280 if (result < 0) {
2281 goto out_close;
2284 /* Step two: Check that nobody else has taken conflicting locks */
2285 result = raw_check_lock_bytes(fd, perm, shared, errp);
2286 if (result < 0) {
2287 error_append_hint(errp,
2288 "Is another process using the image [%s]?\n",
2289 file_opts->filename);
2290 goto out_unlock;
2293 /* Clear the file by truncating it to 0 */
2294 result = raw_regular_truncate(NULL, fd, 0, PREALLOC_MODE_OFF, errp);
2295 if (result < 0) {
2296 goto out_unlock;
2299 if (file_opts->nocow) {
2300 #ifdef __linux__
2301 /* Set NOCOW flag to solve performance issue on fs like btrfs.
2302 * This is an optimisation. The FS_IOC_SETFLAGS ioctl return value
2303 * will be ignored since any failure of this operation should not
2304 * block the left work.
2306 int attr;
2307 if (ioctl(fd, FS_IOC_GETFLAGS, &attr) == 0) {
2308 attr |= FS_NOCOW_FL;
2309 ioctl(fd, FS_IOC_SETFLAGS, &attr);
2311 #endif
2314 /* Resize and potentially preallocate the file to the desired
2315 * final size */
2316 result = raw_regular_truncate(NULL, fd, file_opts->size,
2317 file_opts->preallocation, errp);
2318 if (result < 0) {
2319 goto out_unlock;
2322 out_unlock:
2323 raw_apply_lock_bytes(NULL, fd, 0, 0, true, &local_err);
2324 if (local_err) {
2325 /* The above call should not fail, and if it does, that does
2326 * not mean the whole creation operation has failed. So
2327 * report it the user for their convenience, but do not report
2328 * it to the caller. */
2329 warn_report_err(local_err);
2332 out_close:
2333 if (qemu_close(fd) != 0 && result == 0) {
2334 result = -errno;
2335 error_setg_errno(errp, -result, "Could not close the new file");
2337 out:
2338 return result;
2341 static int coroutine_fn raw_co_create_opts(const char *filename, QemuOpts *opts,
2342 Error **errp)
2344 BlockdevCreateOptions options;
2345 int64_t total_size = 0;
2346 bool nocow = false;
2347 PreallocMode prealloc;
2348 char *buf = NULL;
2349 Error *local_err = NULL;
2351 /* Skip file: protocol prefix */
2352 strstart(filename, "file:", &filename);
2354 /* Read out options */
2355 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2356 BDRV_SECTOR_SIZE);
2357 nocow = qemu_opt_get_bool(opts, BLOCK_OPT_NOCOW, false);
2358 buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
2359 prealloc = qapi_enum_parse(&PreallocMode_lookup, buf,
2360 PREALLOC_MODE_OFF, &local_err);
2361 g_free(buf);
2362 if (local_err) {
2363 error_propagate(errp, local_err);
2364 return -EINVAL;
2367 options = (BlockdevCreateOptions) {
2368 .driver = BLOCKDEV_DRIVER_FILE,
2369 .u.file = {
2370 .filename = (char *) filename,
2371 .size = total_size,
2372 .has_preallocation = true,
2373 .preallocation = prealloc,
2374 .has_nocow = true,
2375 .nocow = nocow,
2378 return raw_co_create(&options, errp);
2382 * Find allocation range in @bs around offset @start.
2383 * May change underlying file descriptor's file offset.
2384 * If @start is not in a hole, store @start in @data, and the
2385 * beginning of the next hole in @hole, and return 0.
2386 * If @start is in a non-trailing hole, store @start in @hole and the
2387 * beginning of the next non-hole in @data, and return 0.
2388 * If @start is in a trailing hole or beyond EOF, return -ENXIO.
2389 * If we can't find out, return a negative errno other than -ENXIO.
2391 static int find_allocation(BlockDriverState *bs, off_t start,
2392 off_t *data, off_t *hole)
2394 #if defined SEEK_HOLE && defined SEEK_DATA
2395 BDRVRawState *s = bs->opaque;
2396 off_t offs;
2399 * SEEK_DATA cases:
2400 * D1. offs == start: start is in data
2401 * D2. offs > start: start is in a hole, next data at offs
2402 * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
2403 * or start is beyond EOF
2404 * If the latter happens, the file has been truncated behind
2405 * our back since we opened it. All bets are off then.
2406 * Treating like a trailing hole is simplest.
2407 * D4. offs < 0, errno != ENXIO: we learned nothing
2409 offs = lseek(s->fd, start, SEEK_DATA);
2410 if (offs < 0) {
2411 return -errno; /* D3 or D4 */
2414 if (offs < start) {
2415 /* This is not a valid return by lseek(). We are safe to just return
2416 * -EIO in this case, and we'll treat it like D4. */
2417 return -EIO;
2420 if (offs > start) {
2421 /* D2: in hole, next data at offs */
2422 *hole = start;
2423 *data = offs;
2424 return 0;
2427 /* D1: in data, end not yet known */
2430 * SEEK_HOLE cases:
2431 * H1. offs == start: start is in a hole
2432 * If this happens here, a hole has been dug behind our back
2433 * since the previous lseek().
2434 * H2. offs > start: either start is in data, next hole at offs,
2435 * or start is in trailing hole, EOF at offs
2436 * Linux treats trailing holes like any other hole: offs ==
2437 * start. Solaris seeks to EOF instead: offs > start (blech).
2438 * If that happens here, a hole has been dug behind our back
2439 * since the previous lseek().
2440 * H3. offs < 0, errno = ENXIO: start is beyond EOF
2441 * If this happens, the file has been truncated behind our
2442 * back since we opened it. Treat it like a trailing hole.
2443 * H4. offs < 0, errno != ENXIO: we learned nothing
2444 * Pretend we know nothing at all, i.e. "forget" about D1.
2446 offs = lseek(s->fd, start, SEEK_HOLE);
2447 if (offs < 0) {
2448 return -errno; /* D1 and (H3 or H4) */
2451 if (offs < start) {
2452 /* This is not a valid return by lseek(). We are safe to just return
2453 * -EIO in this case, and we'll treat it like H4. */
2454 return -EIO;
2457 if (offs > start) {
2459 * D1 and H2: either in data, next hole at offs, or it was in
2460 * data but is now in a trailing hole. In the latter case,
2461 * all bets are off. Treating it as if it there was data all
2462 * the way to EOF is safe, so simply do that.
2464 *data = start;
2465 *hole = offs;
2466 return 0;
2469 /* D1 and H1 */
2470 return -EBUSY;
2471 #else
2472 return -ENOTSUP;
2473 #endif
2477 * Returns the allocation status of the specified offset.
2479 * The block layer guarantees 'offset' and 'bytes' are within bounds.
2481 * 'pnum' is set to the number of bytes (including and immediately following
2482 * the specified offset) that are known to be in the same
2483 * allocated/unallocated state.
2485 * 'bytes' is the max value 'pnum' should be set to.
2487 static int coroutine_fn raw_co_block_status(BlockDriverState *bs,
2488 bool want_zero,
2489 int64_t offset,
2490 int64_t bytes, int64_t *pnum,
2491 int64_t *map,
2492 BlockDriverState **file)
2494 off_t data = 0, hole = 0;
2495 int ret;
2497 assert(QEMU_IS_ALIGNED(offset | bytes, bs->bl.request_alignment));
2499 ret = fd_open(bs);
2500 if (ret < 0) {
2501 return ret;
2504 if (!want_zero) {
2505 *pnum = bytes;
2506 *map = offset;
2507 *file = bs;
2508 return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
2511 ret = find_allocation(bs, offset, &data, &hole);
2512 if (ret == -ENXIO) {
2513 /* Trailing hole */
2514 *pnum = bytes;
2515 ret = BDRV_BLOCK_ZERO;
2516 } else if (ret < 0) {
2517 /* No info available, so pretend there are no holes */
2518 *pnum = bytes;
2519 ret = BDRV_BLOCK_DATA;
2520 } else if (data == offset) {
2521 /* On a data extent, compute bytes to the end of the extent,
2522 * possibly including a partial sector at EOF. */
2523 *pnum = MIN(bytes, hole - offset);
2526 * We are not allowed to return partial sectors, though, so
2527 * round up if necessary.
2529 if (!QEMU_IS_ALIGNED(*pnum, bs->bl.request_alignment)) {
2530 int64_t file_length = raw_getlength(bs);
2531 if (file_length > 0) {
2532 /* Ignore errors, this is just a safeguard */
2533 assert(hole == file_length);
2535 *pnum = ROUND_UP(*pnum, bs->bl.request_alignment);
2538 ret = BDRV_BLOCK_DATA;
2539 } else {
2540 /* On a hole, compute bytes to the beginning of the next extent. */
2541 assert(hole == offset);
2542 *pnum = MIN(bytes, data - offset);
2543 ret = BDRV_BLOCK_ZERO;
2545 *map = offset;
2546 *file = bs;
2547 return ret | BDRV_BLOCK_OFFSET_VALID;
2550 #if defined(__linux__)
2551 /* Verify that the file is not in the page cache */
2552 static void check_cache_dropped(BlockDriverState *bs, Error **errp)
2554 const size_t window_size = 128 * 1024 * 1024;
2555 BDRVRawState *s = bs->opaque;
2556 void *window = NULL;
2557 size_t length = 0;
2558 unsigned char *vec;
2559 size_t page_size;
2560 off_t offset;
2561 off_t end;
2563 /* mincore(2) page status information requires 1 byte per page */
2564 page_size = sysconf(_SC_PAGESIZE);
2565 vec = g_malloc(DIV_ROUND_UP(window_size, page_size));
2567 end = raw_getlength(bs);
2569 for (offset = 0; offset < end; offset += window_size) {
2570 void *new_window;
2571 size_t new_length;
2572 size_t vec_end;
2573 size_t i;
2574 int ret;
2576 /* Unmap previous window if size has changed */
2577 new_length = MIN(end - offset, window_size);
2578 if (new_length != length) {
2579 munmap(window, length);
2580 window = NULL;
2581 length = 0;
2584 new_window = mmap(window, new_length, PROT_NONE, MAP_PRIVATE,
2585 s->fd, offset);
2586 if (new_window == MAP_FAILED) {
2587 error_setg_errno(errp, errno, "mmap failed");
2588 break;
2591 window = new_window;
2592 length = new_length;
2594 ret = mincore(window, length, vec);
2595 if (ret < 0) {
2596 error_setg_errno(errp, errno, "mincore failed");
2597 break;
2600 vec_end = DIV_ROUND_UP(length, page_size);
2601 for (i = 0; i < vec_end; i++) {
2602 if (vec[i] & 0x1) {
2603 error_setg(errp, "page cache still in use!");
2604 break;
2609 if (window) {
2610 munmap(window, length);
2613 g_free(vec);
2615 #endif /* __linux__ */
2617 static void coroutine_fn raw_co_invalidate_cache(BlockDriverState *bs,
2618 Error **errp)
2620 BDRVRawState *s = bs->opaque;
2621 int ret;
2623 ret = fd_open(bs);
2624 if (ret < 0) {
2625 error_setg_errno(errp, -ret, "The file descriptor is not open");
2626 return;
2629 if (!s->drop_cache) {
2630 return;
2633 if (s->open_flags & O_DIRECT) {
2634 return; /* No host kernel page cache */
2637 #if defined(__linux__)
2638 /* This sets the scene for the next syscall... */
2639 ret = bdrv_co_flush(bs);
2640 if (ret < 0) {
2641 error_setg_errno(errp, -ret, "flush failed");
2642 return;
2645 /* Linux does not invalidate pages that are dirty, locked, or mmapped by a
2646 * process. These limitations are okay because we just fsynced the file,
2647 * we don't use mmap, and the file should not be in use by other processes.
2649 ret = posix_fadvise(s->fd, 0, 0, POSIX_FADV_DONTNEED);
2650 if (ret != 0) { /* the return value is a positive errno */
2651 error_setg_errno(errp, ret, "fadvise failed");
2652 return;
2655 if (s->check_cache_dropped) {
2656 check_cache_dropped(bs, errp);
2658 #else /* __linux__ */
2659 /* Do nothing. Live migration to a remote host with cache.direct=off is
2660 * unsupported on other host operating systems. Cache consistency issues
2661 * may occur but no error is reported here, partly because that's the
2662 * historical behavior and partly because it's hard to differentiate valid
2663 * configurations that should not cause errors.
2665 #endif /* !__linux__ */
2668 static void raw_account_discard(BDRVRawState *s, uint64_t nbytes, int ret)
2670 if (ret) {
2671 s->stats.discard_nb_failed++;
2672 } else {
2673 s->stats.discard_nb_ok++;
2674 s->stats.discard_bytes_ok += nbytes;
2678 static coroutine_fn int
2679 raw_do_pdiscard(BlockDriverState *bs, int64_t offset, int bytes, bool blkdev)
2681 BDRVRawState *s = bs->opaque;
2682 RawPosixAIOData acb;
2683 int ret;
2685 acb = (RawPosixAIOData) {
2686 .bs = bs,
2687 .aio_fildes = s->fd,
2688 .aio_type = QEMU_AIO_DISCARD,
2689 .aio_offset = offset,
2690 .aio_nbytes = bytes,
2693 if (blkdev) {
2694 acb.aio_type |= QEMU_AIO_BLKDEV;
2697 ret = raw_thread_pool_submit(bs, handle_aiocb_discard, &acb);
2698 raw_account_discard(s, bytes, ret);
2699 return ret;
2702 static coroutine_fn int
2703 raw_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
2705 return raw_do_pdiscard(bs, offset, bytes, false);
2708 static int coroutine_fn
2709 raw_do_pwrite_zeroes(BlockDriverState *bs, int64_t offset, int bytes,
2710 BdrvRequestFlags flags, bool blkdev)
2712 BDRVRawState *s = bs->opaque;
2713 RawPosixAIOData acb;
2714 ThreadPoolFunc *handler;
2716 acb = (RawPosixAIOData) {
2717 .bs = bs,
2718 .aio_fildes = s->fd,
2719 .aio_type = QEMU_AIO_WRITE_ZEROES,
2720 .aio_offset = offset,
2721 .aio_nbytes = bytes,
2724 if (blkdev) {
2725 acb.aio_type |= QEMU_AIO_BLKDEV;
2727 if (flags & BDRV_REQ_NO_FALLBACK) {
2728 acb.aio_type |= QEMU_AIO_NO_FALLBACK;
2731 if (flags & BDRV_REQ_MAY_UNMAP) {
2732 acb.aio_type |= QEMU_AIO_DISCARD;
2733 handler = handle_aiocb_write_zeroes_unmap;
2734 } else {
2735 handler = handle_aiocb_write_zeroes;
2738 return raw_thread_pool_submit(bs, handler, &acb);
2741 static int coroutine_fn raw_co_pwrite_zeroes(
2742 BlockDriverState *bs, int64_t offset,
2743 int bytes, BdrvRequestFlags flags)
2745 return raw_do_pwrite_zeroes(bs, offset, bytes, flags, false);
2748 static int raw_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2750 BDRVRawState *s = bs->opaque;
2752 bdi->unallocated_blocks_are_zero = s->discard_zeroes;
2753 return 0;
2756 static BlockStatsSpecificFile get_blockstats_specific_file(BlockDriverState *bs)
2758 BDRVRawState *s = bs->opaque;
2759 return (BlockStatsSpecificFile) {
2760 .discard_nb_ok = s->stats.discard_nb_ok,
2761 .discard_nb_failed = s->stats.discard_nb_failed,
2762 .discard_bytes_ok = s->stats.discard_bytes_ok,
2766 static BlockStatsSpecific *raw_get_specific_stats(BlockDriverState *bs)
2768 BlockStatsSpecific *stats = g_new(BlockStatsSpecific, 1);
2770 stats->driver = BLOCKDEV_DRIVER_FILE;
2771 stats->u.file = get_blockstats_specific_file(bs);
2773 return stats;
2776 static BlockStatsSpecific *hdev_get_specific_stats(BlockDriverState *bs)
2778 BlockStatsSpecific *stats = g_new(BlockStatsSpecific, 1);
2780 stats->driver = BLOCKDEV_DRIVER_HOST_DEVICE;
2781 stats->u.host_device = get_blockstats_specific_file(bs);
2783 return stats;
2786 static QemuOptsList raw_create_opts = {
2787 .name = "raw-create-opts",
2788 .head = QTAILQ_HEAD_INITIALIZER(raw_create_opts.head),
2789 .desc = {
2791 .name = BLOCK_OPT_SIZE,
2792 .type = QEMU_OPT_SIZE,
2793 .help = "Virtual disk size"
2796 .name = BLOCK_OPT_NOCOW,
2797 .type = QEMU_OPT_BOOL,
2798 .help = "Turn off copy-on-write (valid only on btrfs)"
2801 .name = BLOCK_OPT_PREALLOC,
2802 .type = QEMU_OPT_STRING,
2803 .help = "Preallocation mode (allowed values: off"
2804 #ifdef CONFIG_POSIX_FALLOCATE
2805 ", falloc"
2806 #endif
2807 ", full)"
2809 { /* end of list */ }
2813 static int raw_check_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared,
2814 Error **errp)
2816 BDRVRawState *s = bs->opaque;
2817 BDRVRawReopenState *rs = NULL;
2818 int open_flags;
2819 int ret;
2821 if (s->perm_change_fd) {
2823 * In the context of reopen, this function may be called several times
2824 * (directly and recursively while change permissions of the parent).
2825 * This is even true for children that don't inherit from the original
2826 * reopen node, so s->reopen_state is not set.
2828 * Ignore all but the first call.
2830 return 0;
2833 if (s->reopen_state) {
2834 /* We already have a new file descriptor to set permissions for */
2835 assert(s->reopen_state->perm == perm);
2836 assert(s->reopen_state->shared_perm == shared);
2837 rs = s->reopen_state->opaque;
2838 s->perm_change_fd = rs->fd;
2839 s->perm_change_flags = rs->open_flags;
2840 } else {
2841 /* We may need a new fd if auto-read-only switches the mode */
2842 ret = raw_reconfigure_getfd(bs, bs->open_flags, &open_flags, perm,
2843 false, errp);
2844 if (ret < 0) {
2845 return ret;
2846 } else if (ret != s->fd) {
2847 s->perm_change_fd = ret;
2848 s->perm_change_flags = open_flags;
2852 /* Prepare permissions on old fd to avoid conflicts between old and new,
2853 * but keep everything locked that new will need. */
2854 ret = raw_handle_perm_lock(bs, RAW_PL_PREPARE, perm, shared, errp);
2855 if (ret < 0) {
2856 goto fail;
2859 /* Copy locks to the new fd */
2860 if (s->perm_change_fd) {
2861 ret = raw_apply_lock_bytes(NULL, s->perm_change_fd, perm, ~shared,
2862 false, errp);
2863 if (ret < 0) {
2864 raw_handle_perm_lock(bs, RAW_PL_ABORT, 0, 0, NULL);
2865 goto fail;
2868 return 0;
2870 fail:
2871 if (s->perm_change_fd && !s->reopen_state) {
2872 qemu_close(s->perm_change_fd);
2874 s->perm_change_fd = 0;
2875 return ret;
2878 static void raw_set_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared)
2880 BDRVRawState *s = bs->opaque;
2882 /* For reopen, we have already switched to the new fd (.bdrv_set_perm is
2883 * called after .bdrv_reopen_commit) */
2884 if (s->perm_change_fd && s->fd != s->perm_change_fd) {
2885 qemu_close(s->fd);
2886 s->fd = s->perm_change_fd;
2887 s->open_flags = s->perm_change_flags;
2889 s->perm_change_fd = 0;
2891 raw_handle_perm_lock(bs, RAW_PL_COMMIT, perm, shared, NULL);
2892 s->perm = perm;
2893 s->shared_perm = shared;
2896 static void raw_abort_perm_update(BlockDriverState *bs)
2898 BDRVRawState *s = bs->opaque;
2900 /* For reopen, .bdrv_reopen_abort is called afterwards and will close
2901 * the file descriptor. */
2902 if (s->perm_change_fd && !s->reopen_state) {
2903 qemu_close(s->perm_change_fd);
2905 s->perm_change_fd = 0;
2907 raw_handle_perm_lock(bs, RAW_PL_ABORT, 0, 0, NULL);
2910 static int coroutine_fn raw_co_copy_range_from(
2911 BlockDriverState *bs, BdrvChild *src, uint64_t src_offset,
2912 BdrvChild *dst, uint64_t dst_offset, uint64_t bytes,
2913 BdrvRequestFlags read_flags, BdrvRequestFlags write_flags)
2915 return bdrv_co_copy_range_to(src, src_offset, dst, dst_offset, bytes,
2916 read_flags, write_flags);
2919 static int coroutine_fn raw_co_copy_range_to(BlockDriverState *bs,
2920 BdrvChild *src,
2921 uint64_t src_offset,
2922 BdrvChild *dst,
2923 uint64_t dst_offset,
2924 uint64_t bytes,
2925 BdrvRequestFlags read_flags,
2926 BdrvRequestFlags write_flags)
2928 RawPosixAIOData acb;
2929 BDRVRawState *s = bs->opaque;
2930 BDRVRawState *src_s;
2932 assert(dst->bs == bs);
2933 if (src->bs->drv->bdrv_co_copy_range_to != raw_co_copy_range_to) {
2934 return -ENOTSUP;
2937 src_s = src->bs->opaque;
2938 if (fd_open(src->bs) < 0 || fd_open(dst->bs) < 0) {
2939 return -EIO;
2942 acb = (RawPosixAIOData) {
2943 .bs = bs,
2944 .aio_type = QEMU_AIO_COPY_RANGE,
2945 .aio_fildes = src_s->fd,
2946 .aio_offset = src_offset,
2947 .aio_nbytes = bytes,
2948 .copy_range = {
2949 .aio_fd2 = s->fd,
2950 .aio_offset2 = dst_offset,
2954 return raw_thread_pool_submit(bs, handle_aiocb_copy_range, &acb);
2957 BlockDriver bdrv_file = {
2958 .format_name = "file",
2959 .protocol_name = "file",
2960 .instance_size = sizeof(BDRVRawState),
2961 .bdrv_needs_filename = true,
2962 .bdrv_probe = NULL, /* no probe for protocols */
2963 .bdrv_parse_filename = raw_parse_filename,
2964 .bdrv_file_open = raw_open,
2965 .bdrv_reopen_prepare = raw_reopen_prepare,
2966 .bdrv_reopen_commit = raw_reopen_commit,
2967 .bdrv_reopen_abort = raw_reopen_abort,
2968 .bdrv_close = raw_close,
2969 .bdrv_co_create = raw_co_create,
2970 .bdrv_co_create_opts = raw_co_create_opts,
2971 .bdrv_has_zero_init = bdrv_has_zero_init_1,
2972 .bdrv_has_zero_init_truncate = bdrv_has_zero_init_1,
2973 .bdrv_co_block_status = raw_co_block_status,
2974 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
2975 .bdrv_co_pwrite_zeroes = raw_co_pwrite_zeroes,
2977 .bdrv_co_preadv = raw_co_preadv,
2978 .bdrv_co_pwritev = raw_co_pwritev,
2979 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
2980 .bdrv_co_pdiscard = raw_co_pdiscard,
2981 .bdrv_co_copy_range_from = raw_co_copy_range_from,
2982 .bdrv_co_copy_range_to = raw_co_copy_range_to,
2983 .bdrv_refresh_limits = raw_refresh_limits,
2984 .bdrv_io_plug = raw_aio_plug,
2985 .bdrv_io_unplug = raw_aio_unplug,
2986 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
2988 .bdrv_co_truncate = raw_co_truncate,
2989 .bdrv_getlength = raw_getlength,
2990 .bdrv_get_info = raw_get_info,
2991 .bdrv_get_allocated_file_size
2992 = raw_get_allocated_file_size,
2993 .bdrv_get_specific_stats = raw_get_specific_stats,
2994 .bdrv_check_perm = raw_check_perm,
2995 .bdrv_set_perm = raw_set_perm,
2996 .bdrv_abort_perm_update = raw_abort_perm_update,
2997 .create_opts = &raw_create_opts,
2998 .mutable_opts = mutable_opts,
3001 /***********************************************/
3002 /* host device */
3004 #if defined(__APPLE__) && defined(__MACH__)
3005 static kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
3006 CFIndex maxPathSize, int flags);
3007 static char *FindEjectableOpticalMedia(io_iterator_t *mediaIterator)
3009 kern_return_t kernResult = KERN_FAILURE;
3010 mach_port_t masterPort;
3011 CFMutableDictionaryRef classesToMatch;
3012 const char *matching_array[] = {kIODVDMediaClass, kIOCDMediaClass};
3013 char *mediaType = NULL;
3015 kernResult = IOMasterPort( MACH_PORT_NULL, &masterPort );
3016 if ( KERN_SUCCESS != kernResult ) {
3017 printf( "IOMasterPort returned %d\n", kernResult );
3020 int index;
3021 for (index = 0; index < ARRAY_SIZE(matching_array); index++) {
3022 classesToMatch = IOServiceMatching(matching_array[index]);
3023 if (classesToMatch == NULL) {
3024 error_report("IOServiceMatching returned NULL for %s",
3025 matching_array[index]);
3026 continue;
3028 CFDictionarySetValue(classesToMatch, CFSTR(kIOMediaEjectableKey),
3029 kCFBooleanTrue);
3030 kernResult = IOServiceGetMatchingServices(masterPort, classesToMatch,
3031 mediaIterator);
3032 if (kernResult != KERN_SUCCESS) {
3033 error_report("Note: IOServiceGetMatchingServices returned %d",
3034 kernResult);
3035 continue;
3038 /* If a match was found, leave the loop */
3039 if (*mediaIterator != 0) {
3040 trace_file_FindEjectableOpticalMedia(matching_array[index]);
3041 mediaType = g_strdup(matching_array[index]);
3042 break;
3045 return mediaType;
3048 kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
3049 CFIndex maxPathSize, int flags)
3051 io_object_t nextMedia;
3052 kern_return_t kernResult = KERN_FAILURE;
3053 *bsdPath = '\0';
3054 nextMedia = IOIteratorNext( mediaIterator );
3055 if ( nextMedia )
3057 CFTypeRef bsdPathAsCFString;
3058 bsdPathAsCFString = IORegistryEntryCreateCFProperty( nextMedia, CFSTR( kIOBSDNameKey ), kCFAllocatorDefault, 0 );
3059 if ( bsdPathAsCFString ) {
3060 size_t devPathLength;
3061 strcpy( bsdPath, _PATH_DEV );
3062 if (flags & BDRV_O_NOCACHE) {
3063 strcat(bsdPath, "r");
3065 devPathLength = strlen( bsdPath );
3066 if ( CFStringGetCString( bsdPathAsCFString, bsdPath + devPathLength, maxPathSize - devPathLength, kCFStringEncodingASCII ) ) {
3067 kernResult = KERN_SUCCESS;
3069 CFRelease( bsdPathAsCFString );
3071 IOObjectRelease( nextMedia );
3074 return kernResult;
3077 /* Sets up a real cdrom for use in QEMU */
3078 static bool setup_cdrom(char *bsd_path, Error **errp)
3080 int index, num_of_test_partitions = 2, fd;
3081 char test_partition[MAXPATHLEN];
3082 bool partition_found = false;
3084 /* look for a working partition */
3085 for (index = 0; index < num_of_test_partitions; index++) {
3086 snprintf(test_partition, sizeof(test_partition), "%ss%d", bsd_path,
3087 index);
3088 fd = qemu_open(test_partition, O_RDONLY | O_BINARY | O_LARGEFILE);
3089 if (fd >= 0) {
3090 partition_found = true;
3091 qemu_close(fd);
3092 break;
3096 /* if a working partition on the device was not found */
3097 if (partition_found == false) {
3098 error_setg(errp, "Failed to find a working partition on disc");
3099 } else {
3100 trace_file_setup_cdrom(test_partition);
3101 pstrcpy(bsd_path, MAXPATHLEN, test_partition);
3103 return partition_found;
3106 /* Prints directions on mounting and unmounting a device */
3107 static void print_unmounting_directions(const char *file_name)
3109 error_report("If device %s is mounted on the desktop, unmount"
3110 " it first before using it in QEMU", file_name);
3111 error_report("Command to unmount device: diskutil unmountDisk %s",
3112 file_name);
3113 error_report("Command to mount device: diskutil mountDisk %s", file_name);
3116 #endif /* defined(__APPLE__) && defined(__MACH__) */
3118 static int hdev_probe_device(const char *filename)
3120 struct stat st;
3122 /* allow a dedicated CD-ROM driver to match with a higher priority */
3123 if (strstart(filename, "/dev/cdrom", NULL))
3124 return 50;
3126 if (stat(filename, &st) >= 0 &&
3127 (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
3128 return 100;
3131 return 0;
3134 static int check_hdev_writable(BDRVRawState *s)
3136 #if defined(BLKROGET)
3137 /* Linux block devices can be configured "read-only" using blockdev(8).
3138 * This is independent of device node permissions and therefore open(2)
3139 * with O_RDWR succeeds. Actual writes fail with EPERM.
3141 * bdrv_open() is supposed to fail if the disk is read-only. Explicitly
3142 * check for read-only block devices so that Linux block devices behave
3143 * properly.
3145 struct stat st;
3146 int readonly = 0;
3148 if (fstat(s->fd, &st)) {
3149 return -errno;
3152 if (!S_ISBLK(st.st_mode)) {
3153 return 0;
3156 if (ioctl(s->fd, BLKROGET, &readonly) < 0) {
3157 return -errno;
3160 if (readonly) {
3161 return -EACCES;
3163 #endif /* defined(BLKROGET) */
3164 return 0;
3167 static void hdev_parse_filename(const char *filename, QDict *options,
3168 Error **errp)
3170 bdrv_parse_filename_strip_prefix(filename, "host_device:", options);
3173 static bool hdev_is_sg(BlockDriverState *bs)
3176 #if defined(__linux__)
3178 BDRVRawState *s = bs->opaque;
3179 struct stat st;
3180 struct sg_scsi_id scsiid;
3181 int sg_version;
3182 int ret;
3184 if (stat(bs->filename, &st) < 0 || !S_ISCHR(st.st_mode)) {
3185 return false;
3188 ret = ioctl(s->fd, SG_GET_VERSION_NUM, &sg_version);
3189 if (ret < 0) {
3190 return false;
3193 ret = ioctl(s->fd, SG_GET_SCSI_ID, &scsiid);
3194 if (ret >= 0) {
3195 trace_file_hdev_is_sg(scsiid.scsi_type, sg_version);
3196 return true;
3199 #endif
3201 return false;
3204 static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
3205 Error **errp)
3207 BDRVRawState *s = bs->opaque;
3208 Error *local_err = NULL;
3209 int ret;
3211 #if defined(__APPLE__) && defined(__MACH__)
3213 * Caution: while qdict_get_str() is fine, getting non-string types
3214 * would require more care. When @options come from -blockdev or
3215 * blockdev_add, its members are typed according to the QAPI
3216 * schema, but when they come from -drive, they're all QString.
3218 const char *filename = qdict_get_str(options, "filename");
3219 char bsd_path[MAXPATHLEN] = "";
3220 bool error_occurred = false;
3222 /* If using a real cdrom */
3223 if (strcmp(filename, "/dev/cdrom") == 0) {
3224 char *mediaType = NULL;
3225 kern_return_t ret_val;
3226 io_iterator_t mediaIterator = 0;
3228 mediaType = FindEjectableOpticalMedia(&mediaIterator);
3229 if (mediaType == NULL) {
3230 error_setg(errp, "Please make sure your CD/DVD is in the optical"
3231 " drive");
3232 error_occurred = true;
3233 goto hdev_open_Mac_error;
3236 ret_val = GetBSDPath(mediaIterator, bsd_path, sizeof(bsd_path), flags);
3237 if (ret_val != KERN_SUCCESS) {
3238 error_setg(errp, "Could not get BSD path for optical drive");
3239 error_occurred = true;
3240 goto hdev_open_Mac_error;
3243 /* If a real optical drive was not found */
3244 if (bsd_path[0] == '\0') {
3245 error_setg(errp, "Failed to obtain bsd path for optical drive");
3246 error_occurred = true;
3247 goto hdev_open_Mac_error;
3250 /* If using a cdrom disc and finding a partition on the disc failed */
3251 if (strncmp(mediaType, kIOCDMediaClass, 9) == 0 &&
3252 setup_cdrom(bsd_path, errp) == false) {
3253 print_unmounting_directions(bsd_path);
3254 error_occurred = true;
3255 goto hdev_open_Mac_error;
3258 qdict_put_str(options, "filename", bsd_path);
3260 hdev_open_Mac_error:
3261 g_free(mediaType);
3262 if (mediaIterator) {
3263 IOObjectRelease(mediaIterator);
3265 if (error_occurred) {
3266 return -ENOENT;
3269 #endif /* defined(__APPLE__) && defined(__MACH__) */
3271 s->type = FTYPE_FILE;
3273 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3274 if (ret < 0) {
3275 error_propagate(errp, local_err);
3276 #if defined(__APPLE__) && defined(__MACH__)
3277 if (*bsd_path) {
3278 filename = bsd_path;
3280 /* if a physical device experienced an error while being opened */
3281 if (strncmp(filename, "/dev/", 5) == 0) {
3282 print_unmounting_directions(filename);
3284 #endif /* defined(__APPLE__) && defined(__MACH__) */
3285 return ret;
3288 /* Since this does ioctl the device must be already opened */
3289 bs->sg = hdev_is_sg(bs);
3291 if (flags & BDRV_O_RDWR) {
3292 ret = check_hdev_writable(s);
3293 if (ret < 0) {
3294 raw_close(bs);
3295 error_setg_errno(errp, -ret, "The device is not writable");
3296 return ret;
3300 return ret;
3303 #if defined(__linux__)
3304 static int coroutine_fn
3305 hdev_co_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
3307 BDRVRawState *s = bs->opaque;
3308 RawPosixAIOData acb;
3309 int ret;
3311 ret = fd_open(bs);
3312 if (ret < 0) {
3313 return ret;
3316 if (req == SG_IO && s->pr_mgr) {
3317 struct sg_io_hdr *io_hdr = buf;
3318 if (io_hdr->cmdp[0] == PERSISTENT_RESERVE_OUT ||
3319 io_hdr->cmdp[0] == PERSISTENT_RESERVE_IN) {
3320 return pr_manager_execute(s->pr_mgr, bdrv_get_aio_context(bs),
3321 s->fd, io_hdr);
3325 acb = (RawPosixAIOData) {
3326 .bs = bs,
3327 .aio_type = QEMU_AIO_IOCTL,
3328 .aio_fildes = s->fd,
3329 .aio_offset = 0,
3330 .ioctl = {
3331 .buf = buf,
3332 .cmd = req,
3336 return raw_thread_pool_submit(bs, handle_aiocb_ioctl, &acb);
3338 #endif /* linux */
3340 static int fd_open(BlockDriverState *bs)
3342 BDRVRawState *s = bs->opaque;
3344 /* this is just to ensure s->fd is sane (its called by io ops) */
3345 if (s->fd >= 0)
3346 return 0;
3347 return -EIO;
3350 static coroutine_fn int
3351 hdev_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
3353 BDRVRawState *s = bs->opaque;
3354 int ret;
3356 ret = fd_open(bs);
3357 if (ret < 0) {
3358 raw_account_discard(s, bytes, ret);
3359 return ret;
3361 return raw_do_pdiscard(bs, offset, bytes, true);
3364 static coroutine_fn int hdev_co_pwrite_zeroes(BlockDriverState *bs,
3365 int64_t offset, int bytes, BdrvRequestFlags flags)
3367 int rc;
3369 rc = fd_open(bs);
3370 if (rc < 0) {
3371 return rc;
3374 return raw_do_pwrite_zeroes(bs, offset, bytes, flags, true);
3377 static int coroutine_fn hdev_co_create_opts(const char *filename, QemuOpts *opts,
3378 Error **errp)
3380 int fd;
3381 int ret = 0;
3382 struct stat stat_buf;
3383 int64_t total_size = 0;
3384 bool has_prefix;
3386 /* This function is used by both protocol block drivers and therefore either
3387 * of these prefixes may be given.
3388 * The return value has to be stored somewhere, otherwise this is an error
3389 * due to -Werror=unused-value. */
3390 has_prefix =
3391 strstart(filename, "host_device:", &filename) ||
3392 strstart(filename, "host_cdrom:" , &filename);
3394 (void)has_prefix;
3396 ret = raw_normalize_devicepath(&filename, errp);
3397 if (ret < 0) {
3398 return ret;
3401 /* Read out options */
3402 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
3403 BDRV_SECTOR_SIZE);
3405 fd = qemu_open(filename, O_WRONLY | O_BINARY);
3406 if (fd < 0) {
3407 ret = -errno;
3408 error_setg_errno(errp, -ret, "Could not open device");
3409 return ret;
3412 if (fstat(fd, &stat_buf) < 0) {
3413 ret = -errno;
3414 error_setg_errno(errp, -ret, "Could not stat device");
3415 } else if (!S_ISBLK(stat_buf.st_mode) && !S_ISCHR(stat_buf.st_mode)) {
3416 error_setg(errp,
3417 "The given file is neither a block nor a character device");
3418 ret = -ENODEV;
3419 } else if (lseek(fd, 0, SEEK_END) < total_size) {
3420 error_setg(errp, "Device is too small");
3421 ret = -ENOSPC;
3424 if (!ret && total_size) {
3425 uint8_t buf[BDRV_SECTOR_SIZE] = { 0 };
3426 int64_t zero_size = MIN(BDRV_SECTOR_SIZE, total_size);
3427 if (lseek(fd, 0, SEEK_SET) == -1) {
3428 ret = -errno;
3429 } else {
3430 ret = qemu_write_full(fd, buf, zero_size);
3431 ret = ret == zero_size ? 0 : -errno;
3434 qemu_close(fd);
3435 return ret;
3438 static BlockDriver bdrv_host_device = {
3439 .format_name = "host_device",
3440 .protocol_name = "host_device",
3441 .instance_size = sizeof(BDRVRawState),
3442 .bdrv_needs_filename = true,
3443 .bdrv_probe_device = hdev_probe_device,
3444 .bdrv_parse_filename = hdev_parse_filename,
3445 .bdrv_file_open = hdev_open,
3446 .bdrv_close = raw_close,
3447 .bdrv_reopen_prepare = raw_reopen_prepare,
3448 .bdrv_reopen_commit = raw_reopen_commit,
3449 .bdrv_reopen_abort = raw_reopen_abort,
3450 .bdrv_co_create_opts = hdev_co_create_opts,
3451 .create_opts = &raw_create_opts,
3452 .mutable_opts = mutable_opts,
3453 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3454 .bdrv_co_pwrite_zeroes = hdev_co_pwrite_zeroes,
3456 .bdrv_co_preadv = raw_co_preadv,
3457 .bdrv_co_pwritev = raw_co_pwritev,
3458 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3459 .bdrv_co_pdiscard = hdev_co_pdiscard,
3460 .bdrv_co_copy_range_from = raw_co_copy_range_from,
3461 .bdrv_co_copy_range_to = raw_co_copy_range_to,
3462 .bdrv_refresh_limits = raw_refresh_limits,
3463 .bdrv_io_plug = raw_aio_plug,
3464 .bdrv_io_unplug = raw_aio_unplug,
3465 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3467 .bdrv_co_truncate = raw_co_truncate,
3468 .bdrv_getlength = raw_getlength,
3469 .bdrv_get_info = raw_get_info,
3470 .bdrv_get_allocated_file_size
3471 = raw_get_allocated_file_size,
3472 .bdrv_get_specific_stats = hdev_get_specific_stats,
3473 .bdrv_check_perm = raw_check_perm,
3474 .bdrv_set_perm = raw_set_perm,
3475 .bdrv_abort_perm_update = raw_abort_perm_update,
3476 .bdrv_probe_blocksizes = hdev_probe_blocksizes,
3477 .bdrv_probe_geometry = hdev_probe_geometry,
3479 /* generic scsi device */
3480 #ifdef __linux__
3481 .bdrv_co_ioctl = hdev_co_ioctl,
3482 #endif
3485 #if defined(__linux__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3486 static void cdrom_parse_filename(const char *filename, QDict *options,
3487 Error **errp)
3489 bdrv_parse_filename_strip_prefix(filename, "host_cdrom:", options);
3491 #endif
3493 #ifdef __linux__
3494 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3495 Error **errp)
3497 BDRVRawState *s = bs->opaque;
3499 s->type = FTYPE_CD;
3501 /* open will not fail even if no CD is inserted, so add O_NONBLOCK */
3502 return raw_open_common(bs, options, flags, O_NONBLOCK, true, errp);
3505 static int cdrom_probe_device(const char *filename)
3507 int fd, ret;
3508 int prio = 0;
3509 struct stat st;
3511 fd = qemu_open(filename, O_RDONLY | O_NONBLOCK);
3512 if (fd < 0) {
3513 goto out;
3515 ret = fstat(fd, &st);
3516 if (ret == -1 || !S_ISBLK(st.st_mode)) {
3517 goto outc;
3520 /* Attempt to detect via a CDROM specific ioctl */
3521 ret = ioctl(fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3522 if (ret >= 0)
3523 prio = 100;
3525 outc:
3526 qemu_close(fd);
3527 out:
3528 return prio;
3531 static bool cdrom_is_inserted(BlockDriverState *bs)
3533 BDRVRawState *s = bs->opaque;
3534 int ret;
3536 ret = ioctl(s->fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3537 return ret == CDS_DISC_OK;
3540 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3542 BDRVRawState *s = bs->opaque;
3544 if (eject_flag) {
3545 if (ioctl(s->fd, CDROMEJECT, NULL) < 0)
3546 perror("CDROMEJECT");
3547 } else {
3548 if (ioctl(s->fd, CDROMCLOSETRAY, NULL) < 0)
3549 perror("CDROMEJECT");
3553 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3555 BDRVRawState *s = bs->opaque;
3557 if (ioctl(s->fd, CDROM_LOCKDOOR, locked) < 0) {
3559 * Note: an error can happen if the distribution automatically
3560 * mounts the CD-ROM
3562 /* perror("CDROM_LOCKDOOR"); */
3566 static BlockDriver bdrv_host_cdrom = {
3567 .format_name = "host_cdrom",
3568 .protocol_name = "host_cdrom",
3569 .instance_size = sizeof(BDRVRawState),
3570 .bdrv_needs_filename = true,
3571 .bdrv_probe_device = cdrom_probe_device,
3572 .bdrv_parse_filename = cdrom_parse_filename,
3573 .bdrv_file_open = cdrom_open,
3574 .bdrv_close = raw_close,
3575 .bdrv_reopen_prepare = raw_reopen_prepare,
3576 .bdrv_reopen_commit = raw_reopen_commit,
3577 .bdrv_reopen_abort = raw_reopen_abort,
3578 .bdrv_co_create_opts = hdev_co_create_opts,
3579 .create_opts = &raw_create_opts,
3580 .mutable_opts = mutable_opts,
3581 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3584 .bdrv_co_preadv = raw_co_preadv,
3585 .bdrv_co_pwritev = raw_co_pwritev,
3586 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3587 .bdrv_refresh_limits = raw_refresh_limits,
3588 .bdrv_io_plug = raw_aio_plug,
3589 .bdrv_io_unplug = raw_aio_unplug,
3590 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3592 .bdrv_co_truncate = raw_co_truncate,
3593 .bdrv_getlength = raw_getlength,
3594 .has_variable_length = true,
3595 .bdrv_get_allocated_file_size
3596 = raw_get_allocated_file_size,
3598 /* removable device support */
3599 .bdrv_is_inserted = cdrom_is_inserted,
3600 .bdrv_eject = cdrom_eject,
3601 .bdrv_lock_medium = cdrom_lock_medium,
3603 /* generic scsi device */
3604 .bdrv_co_ioctl = hdev_co_ioctl,
3606 #endif /* __linux__ */
3608 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
3609 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3610 Error **errp)
3612 BDRVRawState *s = bs->opaque;
3613 Error *local_err = NULL;
3614 int ret;
3616 s->type = FTYPE_CD;
3618 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3619 if (ret) {
3620 error_propagate(errp, local_err);
3621 return ret;
3624 /* make sure the door isn't locked at this time */
3625 ioctl(s->fd, CDIOCALLOW);
3626 return 0;
3629 static int cdrom_probe_device(const char *filename)
3631 if (strstart(filename, "/dev/cd", NULL) ||
3632 strstart(filename, "/dev/acd", NULL))
3633 return 100;
3634 return 0;
3637 static int cdrom_reopen(BlockDriverState *bs)
3639 BDRVRawState *s = bs->opaque;
3640 int fd;
3643 * Force reread of possibly changed/newly loaded disc,
3644 * FreeBSD seems to not notice sometimes...
3646 if (s->fd >= 0)
3647 qemu_close(s->fd);
3648 fd = qemu_open(bs->filename, s->open_flags, 0644);
3649 if (fd < 0) {
3650 s->fd = -1;
3651 return -EIO;
3653 s->fd = fd;
3655 /* make sure the door isn't locked at this time */
3656 ioctl(s->fd, CDIOCALLOW);
3657 return 0;
3660 static bool cdrom_is_inserted(BlockDriverState *bs)
3662 return raw_getlength(bs) > 0;
3665 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3667 BDRVRawState *s = bs->opaque;
3669 if (s->fd < 0)
3670 return;
3672 (void) ioctl(s->fd, CDIOCALLOW);
3674 if (eject_flag) {
3675 if (ioctl(s->fd, CDIOCEJECT) < 0)
3676 perror("CDIOCEJECT");
3677 } else {
3678 if (ioctl(s->fd, CDIOCCLOSE) < 0)
3679 perror("CDIOCCLOSE");
3682 cdrom_reopen(bs);
3685 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3687 BDRVRawState *s = bs->opaque;
3689 if (s->fd < 0)
3690 return;
3691 if (ioctl(s->fd, (locked ? CDIOCPREVENT : CDIOCALLOW)) < 0) {
3693 * Note: an error can happen if the distribution automatically
3694 * mounts the CD-ROM
3696 /* perror("CDROM_LOCKDOOR"); */
3700 static BlockDriver bdrv_host_cdrom = {
3701 .format_name = "host_cdrom",
3702 .protocol_name = "host_cdrom",
3703 .instance_size = sizeof(BDRVRawState),
3704 .bdrv_needs_filename = true,
3705 .bdrv_probe_device = cdrom_probe_device,
3706 .bdrv_parse_filename = cdrom_parse_filename,
3707 .bdrv_file_open = cdrom_open,
3708 .bdrv_close = raw_close,
3709 .bdrv_reopen_prepare = raw_reopen_prepare,
3710 .bdrv_reopen_commit = raw_reopen_commit,
3711 .bdrv_reopen_abort = raw_reopen_abort,
3712 .bdrv_co_create_opts = hdev_co_create_opts,
3713 .create_opts = &raw_create_opts,
3714 .mutable_opts = mutable_opts,
3716 .bdrv_co_preadv = raw_co_preadv,
3717 .bdrv_co_pwritev = raw_co_pwritev,
3718 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3719 .bdrv_refresh_limits = raw_refresh_limits,
3720 .bdrv_io_plug = raw_aio_plug,
3721 .bdrv_io_unplug = raw_aio_unplug,
3722 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3724 .bdrv_co_truncate = raw_co_truncate,
3725 .bdrv_getlength = raw_getlength,
3726 .has_variable_length = true,
3727 .bdrv_get_allocated_file_size
3728 = raw_get_allocated_file_size,
3730 /* removable device support */
3731 .bdrv_is_inserted = cdrom_is_inserted,
3732 .bdrv_eject = cdrom_eject,
3733 .bdrv_lock_medium = cdrom_lock_medium,
3735 #endif /* __FreeBSD__ */
3737 static void bdrv_file_init(void)
3740 * Register all the drivers. Note that order is important, the driver
3741 * registered last will get probed first.
3743 bdrv_register(&bdrv_file);
3744 bdrv_register(&bdrv_host_device);
3745 #ifdef __linux__
3746 bdrv_register(&bdrv_host_cdrom);
3747 #endif
3748 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3749 bdrv_register(&bdrv_host_cdrom);
3750 #endif
3753 block_init(bdrv_file_init);