travis: stop using container based envs
[qemu/ar7.git] / block / file-posix.c
blob8aee7a3fb8be591aa4b883182ebf0fa01cb35491
1 /*
2 * Block driver for RAW files (posix)
4 * Copyright (c) 2006 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
27 #include "qemu/cutils.h"
28 #include "qemu/error-report.h"
29 #include "block/block_int.h"
30 #include "qemu/module.h"
31 #include "qemu/option.h"
32 #include "trace.h"
33 #include "block/thread-pool.h"
34 #include "qemu/iov.h"
35 #include "block/raw-aio.h"
36 #include "qapi/qmp/qdict.h"
37 #include "qapi/qmp/qstring.h"
39 #include "scsi/pr-manager.h"
40 #include "scsi/constants.h"
42 #if defined(__APPLE__) && (__MACH__)
43 #include <paths.h>
44 #include <sys/param.h>
45 #include <IOKit/IOKitLib.h>
46 #include <IOKit/IOBSD.h>
47 #include <IOKit/storage/IOMediaBSDClient.h>
48 #include <IOKit/storage/IOMedia.h>
49 #include <IOKit/storage/IOCDMedia.h>
50 //#include <IOKit/storage/IOCDTypes.h>
51 #include <IOKit/storage/IODVDMedia.h>
52 #include <CoreFoundation/CoreFoundation.h>
53 #endif
55 #ifdef __sun__
56 #define _POSIX_PTHREAD_SEMANTICS 1
57 #include <sys/dkio.h>
58 #endif
59 #ifdef __linux__
60 #include <sys/ioctl.h>
61 #include <sys/param.h>
62 #include <sys/syscall.h>
63 #include <linux/cdrom.h>
64 #include <linux/fd.h>
65 #include <linux/fs.h>
66 #include <linux/hdreg.h>
67 #include <scsi/sg.h>
68 #ifdef __s390__
69 #include <asm/dasd.h>
70 #endif
71 #ifndef FS_NOCOW_FL
72 #define FS_NOCOW_FL 0x00800000 /* Do not cow file */
73 #endif
74 #endif
75 #if defined(CONFIG_FALLOCATE_PUNCH_HOLE) || defined(CONFIG_FALLOCATE_ZERO_RANGE)
76 #include <linux/falloc.h>
77 #endif
78 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
79 #include <sys/disk.h>
80 #include <sys/cdio.h>
81 #endif
83 #ifdef __OpenBSD__
84 #include <sys/ioctl.h>
85 #include <sys/disklabel.h>
86 #include <sys/dkio.h>
87 #endif
89 #ifdef __NetBSD__
90 #include <sys/ioctl.h>
91 #include <sys/disklabel.h>
92 #include <sys/dkio.h>
93 #include <sys/disk.h>
94 #endif
96 #ifdef __DragonFly__
97 #include <sys/ioctl.h>
98 #include <sys/diskslice.h>
99 #endif
101 #ifdef CONFIG_XFS
102 #include <xfs/xfs.h>
103 #endif
105 //#define DEBUG_BLOCK
107 #ifdef DEBUG_BLOCK
108 # define DEBUG_BLOCK_PRINT 1
109 #else
110 # define DEBUG_BLOCK_PRINT 0
111 #endif
112 #define DPRINTF(fmt, ...) \
113 do { \
114 if (DEBUG_BLOCK_PRINT) { \
115 printf(fmt, ## __VA_ARGS__); \
117 } while (0)
119 /* OS X does not have O_DSYNC */
120 #ifndef O_DSYNC
121 #ifdef O_SYNC
122 #define O_DSYNC O_SYNC
123 #elif defined(O_FSYNC)
124 #define O_DSYNC O_FSYNC
125 #endif
126 #endif
128 /* Approximate O_DIRECT with O_DSYNC if O_DIRECT isn't available */
129 #ifndef O_DIRECT
130 #define O_DIRECT O_DSYNC
131 #endif
133 #define FTYPE_FILE 0
134 #define FTYPE_CD 1
136 #define MAX_BLOCKSIZE 4096
138 /* Posix file locking bytes. Libvirt takes byte 0, we start from higher bytes,
139 * leaving a few more bytes for its future use. */
140 #define RAW_LOCK_PERM_BASE 100
141 #define RAW_LOCK_SHARED_BASE 200
143 typedef struct BDRVRawState {
144 int fd;
145 bool use_lock;
146 int type;
147 int open_flags;
148 size_t buf_align;
150 /* The current permissions. */
151 uint64_t perm;
152 uint64_t shared_perm;
154 /* The perms bits whose corresponding bytes are already locked in
155 * s->fd. */
156 uint64_t locked_perm;
157 uint64_t locked_shared_perm;
159 #ifdef CONFIG_XFS
160 bool is_xfs:1;
161 #endif
162 bool has_discard:1;
163 bool has_write_zeroes:1;
164 bool discard_zeroes:1;
165 bool use_linux_aio:1;
166 bool page_cache_inconsistent:1;
167 bool has_fallocate;
168 bool needs_alignment;
169 bool check_cache_dropped;
171 PRManager *pr_mgr;
172 } BDRVRawState;
174 typedef struct BDRVRawReopenState {
175 int fd;
176 int open_flags;
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_errno(errp, errno, "%s: stat failed", 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());
332 /* For SCSI generic devices the alignment is not really used.
333 With buffered I/O, we don't have any restrictions. */
334 if (bdrv_is_sg(bs) || !s->needs_alignment) {
335 bs->bl.request_alignment = 1;
336 s->buf_align = 1;
337 return;
340 bs->bl.request_alignment = 0;
341 s->buf_align = 0;
342 /* Let's try to use the logical blocksize for the alignment. */
343 if (probe_logical_blocksize(fd, &bs->bl.request_alignment) < 0) {
344 bs->bl.request_alignment = 0;
346 #ifdef CONFIG_XFS
347 if (s->is_xfs) {
348 struct dioattr da;
349 if (xfsctl(NULL, fd, XFS_IOC_DIOINFO, &da) >= 0) {
350 bs->bl.request_alignment = da.d_miniosz;
351 /* The kernel returns wrong information for d_mem */
352 /* s->buf_align = da.d_mem; */
355 #endif
357 /* If we could not get the sizes so far, we can only guess them */
358 if (!s->buf_align) {
359 size_t align;
360 buf = qemu_memalign(max_align, 2 * max_align);
361 for (align = 512; align <= max_align; align <<= 1) {
362 if (raw_is_io_aligned(fd, buf + align, max_align)) {
363 s->buf_align = align;
364 break;
367 qemu_vfree(buf);
370 if (!bs->bl.request_alignment) {
371 size_t align;
372 buf = qemu_memalign(s->buf_align, max_align);
373 for (align = 512; align <= max_align; align <<= 1) {
374 if (raw_is_io_aligned(fd, buf, align)) {
375 bs->bl.request_alignment = align;
376 break;
379 qemu_vfree(buf);
382 if (!s->buf_align || !bs->bl.request_alignment) {
383 error_setg(errp, "Could not find working O_DIRECT alignment");
384 error_append_hint(errp, "Try cache.direct=off\n");
388 static void raw_parse_flags(int bdrv_flags, int *open_flags)
390 assert(open_flags != NULL);
392 *open_flags |= O_BINARY;
393 *open_flags &= ~O_ACCMODE;
394 if (bdrv_flags & BDRV_O_RDWR) {
395 *open_flags |= O_RDWR;
396 } else {
397 *open_flags |= O_RDONLY;
400 /* Use O_DSYNC for write-through caching, no flags for write-back caching,
401 * and O_DIRECT for no caching. */
402 if ((bdrv_flags & BDRV_O_NOCACHE)) {
403 *open_flags |= O_DIRECT;
407 static void raw_parse_filename(const char *filename, QDict *options,
408 Error **errp)
410 bdrv_parse_filename_strip_prefix(filename, "file:", options);
413 static QemuOptsList raw_runtime_opts = {
414 .name = "raw",
415 .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
416 .desc = {
418 .name = "filename",
419 .type = QEMU_OPT_STRING,
420 .help = "File name of the image",
423 .name = "aio",
424 .type = QEMU_OPT_STRING,
425 .help = "host AIO implementation (threads, native)",
428 .name = "locking",
429 .type = QEMU_OPT_STRING,
430 .help = "file locking mode (on/off/auto, default: auto)",
433 .name = "pr-manager",
434 .type = QEMU_OPT_STRING,
435 .help = "id of persistent reservation manager object (default: none)",
438 .name = "x-check-cache-dropped",
439 .type = QEMU_OPT_BOOL,
440 .help = "check that page cache was dropped on live migration (default: off)"
442 { /* end of list */ }
446 static int raw_open_common(BlockDriverState *bs, QDict *options,
447 int bdrv_flags, int open_flags,
448 bool device, Error **errp)
450 BDRVRawState *s = bs->opaque;
451 QemuOpts *opts;
452 Error *local_err = NULL;
453 const char *filename = NULL;
454 const char *str;
455 BlockdevAioOptions aio, aio_default;
456 int fd, ret;
457 struct stat st;
458 OnOffAuto locking;
460 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
461 qemu_opts_absorb_qdict(opts, options, &local_err);
462 if (local_err) {
463 error_propagate(errp, local_err);
464 ret = -EINVAL;
465 goto fail;
468 filename = qemu_opt_get(opts, "filename");
470 ret = raw_normalize_devicepath(&filename, errp);
471 if (ret != 0) {
472 goto fail;
475 aio_default = (bdrv_flags & BDRV_O_NATIVE_AIO)
476 ? BLOCKDEV_AIO_OPTIONS_NATIVE
477 : BLOCKDEV_AIO_OPTIONS_THREADS;
478 aio = qapi_enum_parse(&BlockdevAioOptions_lookup,
479 qemu_opt_get(opts, "aio"),
480 aio_default, &local_err);
481 if (local_err) {
482 error_propagate(errp, local_err);
483 ret = -EINVAL;
484 goto fail;
486 s->use_linux_aio = (aio == BLOCKDEV_AIO_OPTIONS_NATIVE);
488 locking = qapi_enum_parse(&OnOffAuto_lookup,
489 qemu_opt_get(opts, "locking"),
490 ON_OFF_AUTO_AUTO, &local_err);
491 if (local_err) {
492 error_propagate(errp, local_err);
493 ret = -EINVAL;
494 goto fail;
496 switch (locking) {
497 case ON_OFF_AUTO_ON:
498 s->use_lock = true;
499 if (!qemu_has_ofd_lock()) {
500 warn_report("File lock requested but OFD locking syscall is "
501 "unavailable, falling back to POSIX file locks");
502 error_printf("Due to the implementation, locks can be lost "
503 "unexpectedly.\n");
505 break;
506 case ON_OFF_AUTO_OFF:
507 s->use_lock = false;
508 break;
509 case ON_OFF_AUTO_AUTO:
510 s->use_lock = qemu_has_ofd_lock();
511 break;
512 default:
513 abort();
516 str = qemu_opt_get(opts, "pr-manager");
517 if (str) {
518 s->pr_mgr = pr_manager_lookup(str, &local_err);
519 if (local_err) {
520 error_propagate(errp, local_err);
521 ret = -EINVAL;
522 goto fail;
526 s->check_cache_dropped = qemu_opt_get_bool(opts, "x-check-cache-dropped",
527 false);
529 s->open_flags = open_flags;
530 raw_parse_flags(bdrv_flags, &s->open_flags);
532 s->fd = -1;
533 fd = qemu_open(filename, s->open_flags, 0644);
534 ret = fd < 0 ? -errno : 0;
536 if (ret == -EACCES || ret == -EROFS) {
537 /* Try to degrade to read-only, but if it doesn't work, still use the
538 * normal error message. */
539 if (bdrv_apply_auto_read_only(bs, NULL, NULL) == 0) {
540 bdrv_flags &= ~BDRV_O_RDWR;
541 raw_parse_flags(bdrv_flags, &s->open_flags);
542 assert(!(s->open_flags & O_CREAT));
543 fd = qemu_open(filename, s->open_flags);
544 ret = fd < 0 ? -errno : 0;
548 if (ret < 0) {
549 error_setg_errno(errp, -ret, "Could not open '%s'", filename);
550 if (ret == -EROFS) {
551 ret = -EACCES;
553 goto fail;
555 s->fd = fd;
557 s->perm = 0;
558 s->shared_perm = BLK_PERM_ALL;
560 #ifdef CONFIG_LINUX_AIO
561 /* Currently Linux does AIO only for files opened with O_DIRECT */
562 if (s->use_linux_aio) {
563 if (!(s->open_flags & O_DIRECT)) {
564 error_setg(errp, "aio=native was specified, but it requires "
565 "cache.direct=on, which was not specified.");
566 ret = -EINVAL;
567 goto fail;
569 if (!aio_setup_linux_aio(bdrv_get_aio_context(bs), errp)) {
570 error_prepend(errp, "Unable to use native AIO: ");
571 goto fail;
574 #else
575 if (s->use_linux_aio) {
576 error_setg(errp, "aio=native was specified, but is not supported "
577 "in this build.");
578 ret = -EINVAL;
579 goto fail;
581 #endif /* !defined(CONFIG_LINUX_AIO) */
583 s->has_discard = true;
584 s->has_write_zeroes = true;
585 if ((bs->open_flags & BDRV_O_NOCACHE) != 0) {
586 s->needs_alignment = true;
589 if (fstat(s->fd, &st) < 0) {
590 ret = -errno;
591 error_setg_errno(errp, errno, "Could not stat file");
592 goto fail;
595 if (!device) {
596 if (S_ISBLK(st.st_mode)) {
597 warn_report("Opening a block device as a file using the '%s' "
598 "driver is deprecated", bs->drv->format_name);
599 } else if (S_ISCHR(st.st_mode)) {
600 warn_report("Opening a character device as a file using the '%s' "
601 "driver is deprecated", bs->drv->format_name);
602 } else if (!S_ISREG(st.st_mode)) {
603 error_setg(errp, "A regular file was expected by the '%s' driver, "
604 "but something else was given", bs->drv->format_name);
605 ret = -EINVAL;
606 goto fail;
607 } else {
608 s->discard_zeroes = true;
609 s->has_fallocate = true;
611 } else {
612 if (!(S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
613 error_setg(errp, "'%s' driver expects either "
614 "a character or block device", bs->drv->format_name);
615 ret = -EINVAL;
616 goto fail;
620 if (S_ISBLK(st.st_mode)) {
621 #ifdef BLKDISCARDZEROES
622 unsigned int arg;
623 if (ioctl(s->fd, BLKDISCARDZEROES, &arg) == 0 && arg) {
624 s->discard_zeroes = true;
626 #endif
627 #ifdef __linux__
628 /* On Linux 3.10, BLKDISCARD leaves stale data in the page cache. Do
629 * not rely on the contents of discarded blocks unless using O_DIRECT.
630 * Same for BLKZEROOUT.
632 if (!(bs->open_flags & BDRV_O_NOCACHE)) {
633 s->discard_zeroes = false;
634 s->has_write_zeroes = false;
636 #endif
638 #ifdef __FreeBSD__
639 if (S_ISCHR(st.st_mode)) {
641 * The file is a char device (disk), which on FreeBSD isn't behind
642 * a pager, so force all requests to be aligned. This is needed
643 * so QEMU makes sure all IO operations on the device are aligned
644 * to sector size, or else FreeBSD will reject them with EINVAL.
646 s->needs_alignment = true;
648 #endif
650 #ifdef CONFIG_XFS
651 if (platform_test_xfs_fd(s->fd)) {
652 s->is_xfs = true;
654 #endif
656 bs->supported_zero_flags = BDRV_REQ_MAY_UNMAP;
657 ret = 0;
658 fail:
659 if (filename && (bdrv_flags & BDRV_O_TEMPORARY)) {
660 unlink(filename);
662 qemu_opts_del(opts);
663 return ret;
666 static int raw_open(BlockDriverState *bs, QDict *options, int flags,
667 Error **errp)
669 BDRVRawState *s = bs->opaque;
671 s->type = FTYPE_FILE;
672 return raw_open_common(bs, options, flags, 0, false, errp);
675 typedef enum {
676 RAW_PL_PREPARE,
677 RAW_PL_COMMIT,
678 RAW_PL_ABORT,
679 } RawPermLockOp;
681 #define PERM_FOREACH(i) \
682 for ((i) = 0; (1ULL << (i)) <= BLK_PERM_ALL; i++)
684 /* Lock bytes indicated by @perm_lock_bits and @shared_perm_lock_bits in the
685 * file; if @unlock == true, also unlock the unneeded bytes.
686 * @shared_perm_lock_bits is the mask of all permissions that are NOT shared.
688 static int raw_apply_lock_bytes(BDRVRawState *s, int fd,
689 uint64_t perm_lock_bits,
690 uint64_t shared_perm_lock_bits,
691 bool unlock, Error **errp)
693 int ret;
694 int i;
695 uint64_t locked_perm, locked_shared_perm;
697 if (s) {
698 locked_perm = s->locked_perm;
699 locked_shared_perm = s->locked_shared_perm;
700 } else {
702 * We don't have the previous bits, just lock/unlock for each of the
703 * requested bits.
705 if (unlock) {
706 locked_perm = BLK_PERM_ALL;
707 locked_shared_perm = BLK_PERM_ALL;
708 } else {
709 locked_perm = 0;
710 locked_shared_perm = 0;
714 PERM_FOREACH(i) {
715 int off = RAW_LOCK_PERM_BASE + i;
716 uint64_t bit = (1ULL << i);
717 if ((perm_lock_bits & bit) && !(locked_perm & bit)) {
718 ret = qemu_lock_fd(fd, off, 1, false);
719 if (ret) {
720 error_setg(errp, "Failed to lock byte %d", off);
721 return ret;
722 } else if (s) {
723 s->locked_perm |= bit;
725 } else if (unlock && (locked_perm & bit) && !(perm_lock_bits & bit)) {
726 ret = qemu_unlock_fd(fd, off, 1);
727 if (ret) {
728 error_setg(errp, "Failed to unlock byte %d", off);
729 return ret;
730 } else if (s) {
731 s->locked_perm &= ~bit;
735 PERM_FOREACH(i) {
736 int off = RAW_LOCK_SHARED_BASE + i;
737 uint64_t bit = (1ULL << i);
738 if ((shared_perm_lock_bits & bit) && !(locked_shared_perm & bit)) {
739 ret = qemu_lock_fd(fd, off, 1, false);
740 if (ret) {
741 error_setg(errp, "Failed to lock byte %d", off);
742 return ret;
743 } else if (s) {
744 s->locked_shared_perm |= bit;
746 } else if (unlock && (locked_shared_perm & bit) &&
747 !(shared_perm_lock_bits & bit)) {
748 ret = qemu_unlock_fd(fd, off, 1);
749 if (ret) {
750 error_setg(errp, "Failed to unlock byte %d", off);
751 return ret;
752 } else if (s) {
753 s->locked_shared_perm &= ~bit;
757 return 0;
760 /* Check "unshared" bytes implied by @perm and ~@shared_perm in the file. */
761 static int raw_check_lock_bytes(int fd, uint64_t perm, uint64_t shared_perm,
762 Error **errp)
764 int ret;
765 int i;
767 PERM_FOREACH(i) {
768 int off = RAW_LOCK_SHARED_BASE + i;
769 uint64_t p = 1ULL << i;
770 if (perm & p) {
771 ret = qemu_lock_fd_test(fd, off, 1, true);
772 if (ret) {
773 char *perm_name = bdrv_perm_names(p);
774 error_setg(errp,
775 "Failed to get \"%s\" lock",
776 perm_name);
777 g_free(perm_name);
778 return ret;
782 PERM_FOREACH(i) {
783 int off = RAW_LOCK_PERM_BASE + i;
784 uint64_t p = 1ULL << i;
785 if (!(shared_perm & p)) {
786 ret = qemu_lock_fd_test(fd, off, 1, true);
787 if (ret) {
788 char *perm_name = bdrv_perm_names(p);
789 error_setg(errp,
790 "Failed to get shared \"%s\" lock",
791 perm_name);
792 g_free(perm_name);
793 return ret;
797 return 0;
800 static int raw_handle_perm_lock(BlockDriverState *bs,
801 RawPermLockOp op,
802 uint64_t new_perm, uint64_t new_shared,
803 Error **errp)
805 BDRVRawState *s = bs->opaque;
806 int ret = 0;
807 Error *local_err = NULL;
809 if (!s->use_lock) {
810 return 0;
813 if (bdrv_get_flags(bs) & BDRV_O_INACTIVE) {
814 return 0;
817 switch (op) {
818 case RAW_PL_PREPARE:
819 ret = raw_apply_lock_bytes(s, s->fd, s->perm | new_perm,
820 ~s->shared_perm | ~new_shared,
821 false, errp);
822 if (!ret) {
823 ret = raw_check_lock_bytes(s->fd, new_perm, new_shared, errp);
824 if (!ret) {
825 return 0;
827 error_append_hint(errp,
828 "Is another process using the image [%s]?\n",
829 bs->filename);
831 op = RAW_PL_ABORT;
832 /* fall through to unlock bytes. */
833 case RAW_PL_ABORT:
834 raw_apply_lock_bytes(s, s->fd, s->perm, ~s->shared_perm,
835 true, &local_err);
836 if (local_err) {
837 /* Theoretically the above call only unlocks bytes and it cannot
838 * fail. Something weird happened, report it.
840 warn_report_err(local_err);
842 break;
843 case RAW_PL_COMMIT:
844 raw_apply_lock_bytes(s, s->fd, new_perm, ~new_shared,
845 true, &local_err);
846 if (local_err) {
847 /* Theoretically the above call only unlocks bytes and it cannot
848 * fail. Something weird happened, report it.
850 warn_report_err(local_err);
852 break;
854 return ret;
857 static int raw_reopen_prepare(BDRVReopenState *state,
858 BlockReopenQueue *queue, Error **errp)
860 BDRVRawState *s;
861 BDRVRawReopenState *rs;
862 QemuOpts *opts;
863 int ret = 0;
864 Error *local_err = NULL;
866 assert(state != NULL);
867 assert(state->bs != NULL);
869 s = state->bs->opaque;
871 state->opaque = g_new0(BDRVRawReopenState, 1);
872 rs = state->opaque;
873 rs->fd = -1;
875 /* Handle options changes */
876 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
877 qemu_opts_absorb_qdict(opts, state->options, &local_err);
878 if (local_err) {
879 error_propagate(errp, local_err);
880 ret = -EINVAL;
881 goto out;
884 rs->check_cache_dropped =
885 qemu_opt_get_bool_del(opts, "x-check-cache-dropped", false);
887 /* This driver's reopen function doesn't currently allow changing
888 * other options, so let's put them back in the original QDict and
889 * bdrv_reopen_prepare() will detect changes and complain. */
890 qemu_opts_to_qdict(opts, state->options);
892 if (s->type == FTYPE_CD) {
893 rs->open_flags |= O_NONBLOCK;
896 raw_parse_flags(state->flags, &rs->open_flags);
898 int fcntl_flags = O_APPEND | O_NONBLOCK;
899 #ifdef O_NOATIME
900 fcntl_flags |= O_NOATIME;
901 #endif
903 #ifdef O_ASYNC
904 /* Not all operating systems have O_ASYNC, and those that don't
905 * will not let us track the state into rs->open_flags (typically
906 * you achieve the same effect with an ioctl, for example I_SETSIG
907 * on Solaris). But we do not use O_ASYNC, so that's fine.
909 assert((s->open_flags & O_ASYNC) == 0);
910 #endif
912 if ((rs->open_flags & ~fcntl_flags) == (s->open_flags & ~fcntl_flags)) {
913 /* dup the original fd */
914 rs->fd = qemu_dup(s->fd);
915 if (rs->fd >= 0) {
916 ret = fcntl_setfl(rs->fd, rs->open_flags);
917 if (ret) {
918 qemu_close(rs->fd);
919 rs->fd = -1;
924 /* If we cannot use fcntl, or fcntl failed, fall back to qemu_open() */
925 if (rs->fd == -1) {
926 const char *normalized_filename = state->bs->filename;
927 ret = raw_normalize_devicepath(&normalized_filename, errp);
928 if (ret >= 0) {
929 assert(!(rs->open_flags & O_CREAT));
930 rs->fd = qemu_open(normalized_filename, rs->open_flags);
931 if (rs->fd == -1) {
932 error_setg_errno(errp, errno, "Could not reopen file");
933 ret = -1;
938 /* Fail already reopen_prepare() if we can't get a working O_DIRECT
939 * alignment with the new fd. */
940 if (rs->fd != -1) {
941 raw_probe_alignment(state->bs, rs->fd, &local_err);
942 if (local_err) {
943 qemu_close(rs->fd);
944 rs->fd = -1;
945 error_propagate(errp, local_err);
946 ret = -EINVAL;
950 out:
951 qemu_opts_del(opts);
952 return ret;
955 static void raw_reopen_commit(BDRVReopenState *state)
957 BDRVRawReopenState *rs = state->opaque;
958 BDRVRawState *s = state->bs->opaque;
959 Error *local_err = NULL;
961 s->check_cache_dropped = rs->check_cache_dropped;
962 s->open_flags = rs->open_flags;
964 /* Copy locks to the new fd before closing the old one. */
965 raw_apply_lock_bytes(NULL, rs->fd, s->locked_perm,
966 s->locked_shared_perm, false, &local_err);
967 if (local_err) {
968 /* shouldn't fail in a sane host, but report it just in case. */
969 error_report_err(local_err);
971 qemu_close(s->fd);
972 s->fd = rs->fd;
974 g_free(state->opaque);
975 state->opaque = NULL;
979 static void raw_reopen_abort(BDRVReopenState *state)
981 BDRVRawReopenState *rs = state->opaque;
983 /* nothing to do if NULL, we didn't get far enough */
984 if (rs == NULL) {
985 return;
988 if (rs->fd >= 0) {
989 qemu_close(rs->fd);
990 rs->fd = -1;
992 g_free(state->opaque);
993 state->opaque = NULL;
996 static int hdev_get_max_transfer_length(BlockDriverState *bs, int fd)
998 #ifdef BLKSECTGET
999 int max_bytes = 0;
1000 short max_sectors = 0;
1001 if (bs->sg && ioctl(fd, BLKSECTGET, &max_bytes) == 0) {
1002 return max_bytes;
1003 } else if (!bs->sg && ioctl(fd, BLKSECTGET, &max_sectors) == 0) {
1004 return max_sectors << BDRV_SECTOR_BITS;
1005 } else {
1006 return -errno;
1008 #else
1009 return -ENOSYS;
1010 #endif
1013 static int hdev_get_max_segments(const struct stat *st)
1015 #ifdef CONFIG_LINUX
1016 char buf[32];
1017 const char *end;
1018 char *sysfspath;
1019 int ret;
1020 int fd = -1;
1021 long max_segments;
1023 sysfspath = g_strdup_printf("/sys/dev/block/%u:%u/queue/max_segments",
1024 major(st->st_rdev), minor(st->st_rdev));
1025 fd = open(sysfspath, O_RDONLY);
1026 if (fd == -1) {
1027 ret = -errno;
1028 goto out;
1030 do {
1031 ret = read(fd, buf, sizeof(buf) - 1);
1032 } while (ret == -1 && errno == EINTR);
1033 if (ret < 0) {
1034 ret = -errno;
1035 goto out;
1036 } else if (ret == 0) {
1037 ret = -EIO;
1038 goto out;
1040 buf[ret] = 0;
1041 /* The file is ended with '\n', pass 'end' to accept that. */
1042 ret = qemu_strtol(buf, &end, 10, &max_segments);
1043 if (ret == 0 && end && *end == '\n') {
1044 ret = max_segments;
1047 out:
1048 if (fd != -1) {
1049 close(fd);
1051 g_free(sysfspath);
1052 return ret;
1053 #else
1054 return -ENOTSUP;
1055 #endif
1058 static void raw_refresh_limits(BlockDriverState *bs, Error **errp)
1060 BDRVRawState *s = bs->opaque;
1061 struct stat st;
1063 if (!fstat(s->fd, &st)) {
1064 if (S_ISBLK(st.st_mode) || S_ISCHR(st.st_mode)) {
1065 int ret = hdev_get_max_transfer_length(bs, s->fd);
1066 if (ret > 0 && ret <= BDRV_REQUEST_MAX_BYTES) {
1067 bs->bl.max_transfer = pow2floor(ret);
1069 ret = hdev_get_max_segments(&st);
1070 if (ret > 0) {
1071 bs->bl.max_transfer = MIN(bs->bl.max_transfer,
1072 ret * getpagesize());
1077 raw_probe_alignment(bs, s->fd, errp);
1078 bs->bl.min_mem_alignment = s->buf_align;
1079 bs->bl.opt_mem_alignment = MAX(s->buf_align, getpagesize());
1082 static int check_for_dasd(int fd)
1084 #ifdef BIODASDINFO2
1085 struct dasd_information2_t info = {0};
1087 return ioctl(fd, BIODASDINFO2, &info);
1088 #else
1089 return -1;
1090 #endif
1094 * Try to get @bs's logical and physical block size.
1095 * On success, store them in @bsz and return zero.
1096 * On failure, return negative errno.
1098 static int hdev_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz)
1100 BDRVRawState *s = bs->opaque;
1101 int ret;
1103 /* If DASD, get blocksizes */
1104 if (check_for_dasd(s->fd) < 0) {
1105 return -ENOTSUP;
1107 ret = probe_logical_blocksize(s->fd, &bsz->log);
1108 if (ret < 0) {
1109 return ret;
1111 return probe_physical_blocksize(s->fd, &bsz->phys);
1115 * Try to get @bs's geometry: cyls, heads, sectors.
1116 * On success, store them in @geo and return 0.
1117 * On failure return -errno.
1118 * (Allows block driver to assign default geometry values that guest sees)
1120 #ifdef __linux__
1121 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1123 BDRVRawState *s = bs->opaque;
1124 struct hd_geometry ioctl_geo = {0};
1126 /* If DASD, get its geometry */
1127 if (check_for_dasd(s->fd) < 0) {
1128 return -ENOTSUP;
1130 if (ioctl(s->fd, HDIO_GETGEO, &ioctl_geo) < 0) {
1131 return -errno;
1133 /* HDIO_GETGEO may return success even though geo contains zeros
1134 (e.g. certain multipath setups) */
1135 if (!ioctl_geo.heads || !ioctl_geo.sectors || !ioctl_geo.cylinders) {
1136 return -ENOTSUP;
1138 /* Do not return a geometry for partition */
1139 if (ioctl_geo.start != 0) {
1140 return -ENOTSUP;
1142 geo->heads = ioctl_geo.heads;
1143 geo->sectors = ioctl_geo.sectors;
1144 geo->cylinders = ioctl_geo.cylinders;
1146 return 0;
1148 #else /* __linux__ */
1149 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1151 return -ENOTSUP;
1153 #endif
1155 #if defined(__linux__)
1156 static int handle_aiocb_ioctl(void *opaque)
1158 RawPosixAIOData *aiocb = opaque;
1159 int ret;
1161 ret = ioctl(aiocb->aio_fildes, aiocb->ioctl.cmd, aiocb->ioctl.buf);
1162 if (ret == -1) {
1163 return -errno;
1166 return 0;
1168 #endif /* linux */
1170 static int handle_aiocb_flush(void *opaque)
1172 RawPosixAIOData *aiocb = opaque;
1173 BDRVRawState *s = aiocb->bs->opaque;
1174 int ret;
1176 if (s->page_cache_inconsistent) {
1177 return -EIO;
1180 ret = qemu_fdatasync(aiocb->aio_fildes);
1181 if (ret == -1) {
1182 /* There is no clear definition of the semantics of a failing fsync(),
1183 * so we may have to assume the worst. The sad truth is that this
1184 * assumption is correct for Linux. Some pages are now probably marked
1185 * clean in the page cache even though they are inconsistent with the
1186 * on-disk contents. The next fdatasync() call would succeed, but no
1187 * further writeback attempt will be made. We can't get back to a state
1188 * in which we know what is on disk (we would have to rewrite
1189 * everything that was touched since the last fdatasync() at least), so
1190 * make bdrv_flush() fail permanently. Given that the behaviour isn't
1191 * really defined, I have little hope that other OSes are doing better.
1193 * Obviously, this doesn't affect O_DIRECT, which bypasses the page
1194 * cache. */
1195 if ((s->open_flags & O_DIRECT) == 0) {
1196 s->page_cache_inconsistent = true;
1198 return -errno;
1200 return 0;
1203 #ifdef CONFIG_PREADV
1205 static bool preadv_present = true;
1207 static ssize_t
1208 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1210 return preadv(fd, iov, nr_iov, offset);
1213 static ssize_t
1214 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1216 return pwritev(fd, iov, nr_iov, offset);
1219 #else
1221 static bool preadv_present = false;
1223 static ssize_t
1224 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1226 return -ENOSYS;
1229 static ssize_t
1230 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1232 return -ENOSYS;
1235 #endif
1237 static ssize_t handle_aiocb_rw_vector(RawPosixAIOData *aiocb)
1239 ssize_t len;
1241 do {
1242 if (aiocb->aio_type & QEMU_AIO_WRITE)
1243 len = qemu_pwritev(aiocb->aio_fildes,
1244 aiocb->io.iov,
1245 aiocb->io.niov,
1246 aiocb->aio_offset);
1247 else
1248 len = qemu_preadv(aiocb->aio_fildes,
1249 aiocb->io.iov,
1250 aiocb->io.niov,
1251 aiocb->aio_offset);
1252 } while (len == -1 && errno == EINTR);
1254 if (len == -1) {
1255 return -errno;
1257 return len;
1261 * Read/writes the data to/from a given linear buffer.
1263 * Returns the number of bytes handles or -errno in case of an error. Short
1264 * reads are only returned if the end of the file is reached.
1266 static ssize_t handle_aiocb_rw_linear(RawPosixAIOData *aiocb, char *buf)
1268 ssize_t offset = 0;
1269 ssize_t len;
1271 while (offset < aiocb->aio_nbytes) {
1272 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1273 len = pwrite(aiocb->aio_fildes,
1274 (const char *)buf + offset,
1275 aiocb->aio_nbytes - offset,
1276 aiocb->aio_offset + offset);
1277 } else {
1278 len = pread(aiocb->aio_fildes,
1279 buf + offset,
1280 aiocb->aio_nbytes - offset,
1281 aiocb->aio_offset + offset);
1283 if (len == -1 && errno == EINTR) {
1284 continue;
1285 } else if (len == -1 && errno == EINVAL &&
1286 (aiocb->bs->open_flags & BDRV_O_NOCACHE) &&
1287 !(aiocb->aio_type & QEMU_AIO_WRITE) &&
1288 offset > 0) {
1289 /* O_DIRECT pread() may fail with EINVAL when offset is unaligned
1290 * after a short read. Assume that O_DIRECT short reads only occur
1291 * at EOF. Therefore this is a short read, not an I/O error.
1293 break;
1294 } else if (len == -1) {
1295 offset = -errno;
1296 break;
1297 } else if (len == 0) {
1298 break;
1300 offset += len;
1303 return offset;
1306 static int handle_aiocb_rw(void *opaque)
1308 RawPosixAIOData *aiocb = opaque;
1309 ssize_t nbytes;
1310 char *buf;
1312 if (!(aiocb->aio_type & QEMU_AIO_MISALIGNED)) {
1314 * If there is just a single buffer, and it is properly aligned
1315 * we can just use plain pread/pwrite without any problems.
1317 if (aiocb->io.niov == 1) {
1318 nbytes = handle_aiocb_rw_linear(aiocb, aiocb->io.iov->iov_base);
1319 goto out;
1322 * We have more than one iovec, and all are properly aligned.
1324 * Try preadv/pwritev first and fall back to linearizing the
1325 * buffer if it's not supported.
1327 if (preadv_present) {
1328 nbytes = handle_aiocb_rw_vector(aiocb);
1329 if (nbytes == aiocb->aio_nbytes ||
1330 (nbytes < 0 && nbytes != -ENOSYS)) {
1331 goto out;
1333 preadv_present = false;
1337 * XXX(hch): short read/write. no easy way to handle the reminder
1338 * using these interfaces. For now retry using plain
1339 * pread/pwrite?
1344 * Ok, we have to do it the hard way, copy all segments into
1345 * a single aligned buffer.
1347 buf = qemu_try_blockalign(aiocb->bs, aiocb->aio_nbytes);
1348 if (buf == NULL) {
1349 nbytes = -ENOMEM;
1350 goto out;
1353 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1354 char *p = buf;
1355 int i;
1357 for (i = 0; i < aiocb->io.niov; ++i) {
1358 memcpy(p, aiocb->io.iov[i].iov_base, aiocb->io.iov[i].iov_len);
1359 p += aiocb->io.iov[i].iov_len;
1361 assert(p - buf == aiocb->aio_nbytes);
1364 nbytes = handle_aiocb_rw_linear(aiocb, buf);
1365 if (!(aiocb->aio_type & QEMU_AIO_WRITE)) {
1366 char *p = buf;
1367 size_t count = aiocb->aio_nbytes, copy;
1368 int i;
1370 for (i = 0; i < aiocb->io.niov && count; ++i) {
1371 copy = count;
1372 if (copy > aiocb->io.iov[i].iov_len) {
1373 copy = aiocb->io.iov[i].iov_len;
1375 memcpy(aiocb->io.iov[i].iov_base, p, copy);
1376 assert(count >= copy);
1377 p += copy;
1378 count -= copy;
1380 assert(count == 0);
1382 qemu_vfree(buf);
1384 out:
1385 if (nbytes == aiocb->aio_nbytes) {
1386 return 0;
1387 } else if (nbytes >= 0 && nbytes < aiocb->aio_nbytes) {
1388 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1389 return -EINVAL;
1390 } else {
1391 iov_memset(aiocb->io.iov, aiocb->io.niov, nbytes,
1392 0, aiocb->aio_nbytes - nbytes);
1393 return 0;
1395 } else {
1396 assert(nbytes < 0);
1397 return nbytes;
1401 #ifdef CONFIG_XFS
1402 static int xfs_write_zeroes(BDRVRawState *s, int64_t offset, uint64_t bytes)
1404 struct xfs_flock64 fl;
1405 int err;
1407 memset(&fl, 0, sizeof(fl));
1408 fl.l_whence = SEEK_SET;
1409 fl.l_start = offset;
1410 fl.l_len = bytes;
1412 if (xfsctl(NULL, s->fd, XFS_IOC_ZERO_RANGE, &fl) < 0) {
1413 err = errno;
1414 DPRINTF("cannot write zero range (%s)\n", strerror(errno));
1415 return -err;
1418 return 0;
1421 static int xfs_discard(BDRVRawState *s, int64_t offset, uint64_t bytes)
1423 struct xfs_flock64 fl;
1424 int err;
1426 memset(&fl, 0, sizeof(fl));
1427 fl.l_whence = SEEK_SET;
1428 fl.l_start = offset;
1429 fl.l_len = bytes;
1431 if (xfsctl(NULL, s->fd, XFS_IOC_UNRESVSP64, &fl) < 0) {
1432 err = errno;
1433 DPRINTF("cannot punch hole (%s)\n", strerror(errno));
1434 return -err;
1437 return 0;
1439 #endif
1441 static int translate_err(int err)
1443 if (err == -ENODEV || err == -ENOSYS || err == -EOPNOTSUPP ||
1444 err == -ENOTTY) {
1445 err = -ENOTSUP;
1447 return err;
1450 #ifdef CONFIG_FALLOCATE
1451 static int do_fallocate(int fd, int mode, off_t offset, off_t len)
1453 do {
1454 if (fallocate(fd, mode, offset, len) == 0) {
1455 return 0;
1457 } while (errno == EINTR);
1458 return translate_err(-errno);
1460 #endif
1462 static ssize_t handle_aiocb_write_zeroes_block(RawPosixAIOData *aiocb)
1464 int ret = -ENOTSUP;
1465 BDRVRawState *s = aiocb->bs->opaque;
1467 if (!s->has_write_zeroes) {
1468 return -ENOTSUP;
1471 #ifdef BLKZEROOUT
1472 do {
1473 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1474 if (ioctl(aiocb->aio_fildes, BLKZEROOUT, range) == 0) {
1475 return 0;
1477 } while (errno == EINTR);
1479 ret = translate_err(-errno);
1480 #endif
1482 if (ret == -ENOTSUP) {
1483 s->has_write_zeroes = false;
1485 return ret;
1488 static int handle_aiocb_write_zeroes(void *opaque)
1490 RawPosixAIOData *aiocb = opaque;
1491 #if defined(CONFIG_FALLOCATE) || defined(CONFIG_XFS)
1492 BDRVRawState *s = aiocb->bs->opaque;
1493 #endif
1494 #ifdef CONFIG_FALLOCATE
1495 int64_t len;
1496 #endif
1498 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1499 return handle_aiocb_write_zeroes_block(aiocb);
1502 #ifdef CONFIG_XFS
1503 if (s->is_xfs) {
1504 return xfs_write_zeroes(s, aiocb->aio_offset, aiocb->aio_nbytes);
1506 #endif
1508 #ifdef CONFIG_FALLOCATE_ZERO_RANGE
1509 if (s->has_write_zeroes) {
1510 int ret = do_fallocate(s->fd, FALLOC_FL_ZERO_RANGE,
1511 aiocb->aio_offset, aiocb->aio_nbytes);
1512 if (ret == 0 || ret != -ENOTSUP) {
1513 return ret;
1515 s->has_write_zeroes = false;
1517 #endif
1519 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1520 if (s->has_discard && s->has_fallocate) {
1521 int ret = do_fallocate(s->fd,
1522 FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1523 aiocb->aio_offset, aiocb->aio_nbytes);
1524 if (ret == 0) {
1525 ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1526 if (ret == 0 || ret != -ENOTSUP) {
1527 return ret;
1529 s->has_fallocate = false;
1530 } else if (ret != -ENOTSUP) {
1531 return ret;
1532 } else {
1533 s->has_discard = false;
1536 #endif
1538 #ifdef CONFIG_FALLOCATE
1539 /* Last resort: we are trying to extend the file with zeroed data. This
1540 * can be done via fallocate(fd, 0) */
1541 len = bdrv_getlength(aiocb->bs);
1542 if (s->has_fallocate && len >= 0 && aiocb->aio_offset >= len) {
1543 int ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1544 if (ret == 0 || ret != -ENOTSUP) {
1545 return ret;
1547 s->has_fallocate = false;
1549 #endif
1551 return -ENOTSUP;
1554 static int handle_aiocb_write_zeroes_unmap(void *opaque)
1556 RawPosixAIOData *aiocb = opaque;
1557 BDRVRawState *s G_GNUC_UNUSED = aiocb->bs->opaque;
1558 int ret;
1560 /* First try to write zeros and unmap at the same time */
1562 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1563 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1564 aiocb->aio_offset, aiocb->aio_nbytes);
1565 if (ret != -ENOTSUP) {
1566 return ret;
1568 #endif
1570 #ifdef CONFIG_XFS
1571 if (s->is_xfs) {
1572 /* xfs_discard() guarantees that the discarded area reads as all-zero
1573 * afterwards, so we can use it here. */
1574 return xfs_discard(s, aiocb->aio_offset, aiocb->aio_nbytes);
1576 #endif
1578 /* If we couldn't manage to unmap while guaranteed that the area reads as
1579 * all-zero afterwards, just write zeroes without unmapping */
1580 ret = handle_aiocb_write_zeroes(aiocb);
1581 return ret;
1584 #ifndef HAVE_COPY_FILE_RANGE
1585 static off_t copy_file_range(int in_fd, off_t *in_off, int out_fd,
1586 off_t *out_off, size_t len, unsigned int flags)
1588 #ifdef __NR_copy_file_range
1589 return syscall(__NR_copy_file_range, in_fd, in_off, out_fd,
1590 out_off, len, flags);
1591 #else
1592 errno = ENOSYS;
1593 return -1;
1594 #endif
1596 #endif
1598 static int handle_aiocb_copy_range(void *opaque)
1600 RawPosixAIOData *aiocb = opaque;
1601 uint64_t bytes = aiocb->aio_nbytes;
1602 off_t in_off = aiocb->aio_offset;
1603 off_t out_off = aiocb->copy_range.aio_offset2;
1605 while (bytes) {
1606 ssize_t ret = copy_file_range(aiocb->aio_fildes, &in_off,
1607 aiocb->copy_range.aio_fd2, &out_off,
1608 bytes, 0);
1609 trace_file_copy_file_range(aiocb->bs, aiocb->aio_fildes, in_off,
1610 aiocb->copy_range.aio_fd2, out_off, bytes,
1611 0, ret);
1612 if (ret == 0) {
1613 /* No progress (e.g. when beyond EOF), let the caller fall back to
1614 * buffer I/O. */
1615 return -ENOSPC;
1617 if (ret < 0) {
1618 switch (errno) {
1619 case ENOSYS:
1620 return -ENOTSUP;
1621 case EINTR:
1622 continue;
1623 default:
1624 return -errno;
1627 bytes -= ret;
1629 return 0;
1632 static int handle_aiocb_discard(void *opaque)
1634 RawPosixAIOData *aiocb = opaque;
1635 int ret = -EOPNOTSUPP;
1636 BDRVRawState *s = aiocb->bs->opaque;
1638 if (!s->has_discard) {
1639 return -ENOTSUP;
1642 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1643 #ifdef BLKDISCARD
1644 do {
1645 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1646 if (ioctl(aiocb->aio_fildes, BLKDISCARD, range) == 0) {
1647 return 0;
1649 } while (errno == EINTR);
1651 ret = -errno;
1652 #endif
1653 } else {
1654 #ifdef CONFIG_XFS
1655 if (s->is_xfs) {
1656 return xfs_discard(s, aiocb->aio_offset, aiocb->aio_nbytes);
1658 #endif
1660 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1661 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1662 aiocb->aio_offset, aiocb->aio_nbytes);
1663 #endif
1666 ret = translate_err(ret);
1667 if (ret == -ENOTSUP) {
1668 s->has_discard = false;
1670 return ret;
1673 static int handle_aiocb_truncate(void *opaque)
1675 RawPosixAIOData *aiocb = opaque;
1676 int result = 0;
1677 int64_t current_length = 0;
1678 char *buf = NULL;
1679 struct stat st;
1680 int fd = aiocb->aio_fildes;
1681 int64_t offset = aiocb->aio_offset;
1682 PreallocMode prealloc = aiocb->truncate.prealloc;
1683 Error **errp = aiocb->truncate.errp;
1685 if (fstat(fd, &st) < 0) {
1686 result = -errno;
1687 error_setg_errno(errp, -result, "Could not stat file");
1688 return result;
1691 current_length = st.st_size;
1692 if (current_length > offset && prealloc != PREALLOC_MODE_OFF) {
1693 error_setg(errp, "Cannot use preallocation for shrinking files");
1694 return -ENOTSUP;
1697 switch (prealloc) {
1698 #ifdef CONFIG_POSIX_FALLOCATE
1699 case PREALLOC_MODE_FALLOC:
1701 * Truncating before posix_fallocate() makes it about twice slower on
1702 * file systems that do not support fallocate(), trying to check if a
1703 * block is allocated before allocating it, so don't do that here.
1705 if (offset != current_length) {
1706 result = -posix_fallocate(fd, current_length,
1707 offset - current_length);
1708 if (result != 0) {
1709 /* posix_fallocate() doesn't set errno. */
1710 error_setg_errno(errp, -result,
1711 "Could not preallocate new data");
1713 } else {
1714 result = 0;
1716 goto out;
1717 #endif
1718 case PREALLOC_MODE_FULL:
1720 int64_t num = 0, left = offset - current_length;
1721 off_t seek_result;
1724 * Knowing the final size from the beginning could allow the file
1725 * system driver to do less allocations and possibly avoid
1726 * fragmentation of the file.
1728 if (ftruncate(fd, offset) != 0) {
1729 result = -errno;
1730 error_setg_errno(errp, -result, "Could not resize file");
1731 goto out;
1734 buf = g_malloc0(65536);
1736 seek_result = lseek(fd, current_length, SEEK_SET);
1737 if (seek_result < 0) {
1738 result = -errno;
1739 error_setg_errno(errp, -result,
1740 "Failed to seek to the old end of file");
1741 goto out;
1744 while (left > 0) {
1745 num = MIN(left, 65536);
1746 result = write(fd, buf, num);
1747 if (result < 0) {
1748 if (errno == EINTR) {
1749 continue;
1751 result = -errno;
1752 error_setg_errno(errp, -result,
1753 "Could not write zeros for preallocation");
1754 goto out;
1756 left -= result;
1758 if (result >= 0) {
1759 result = fsync(fd);
1760 if (result < 0) {
1761 result = -errno;
1762 error_setg_errno(errp, -result,
1763 "Could not flush file to disk");
1764 goto out;
1767 goto out;
1769 case PREALLOC_MODE_OFF:
1770 if (ftruncate(fd, offset) != 0) {
1771 result = -errno;
1772 error_setg_errno(errp, -result, "Could not resize file");
1774 return result;
1775 default:
1776 result = -ENOTSUP;
1777 error_setg(errp, "Unsupported preallocation mode: %s",
1778 PreallocMode_str(prealloc));
1779 return result;
1782 out:
1783 if (result < 0) {
1784 if (ftruncate(fd, current_length) < 0) {
1785 error_report("Failed to restore old file length: %s",
1786 strerror(errno));
1790 g_free(buf);
1791 return result;
1794 static int coroutine_fn raw_thread_pool_submit(BlockDriverState *bs,
1795 ThreadPoolFunc func, void *arg)
1797 /* @bs can be NULL, bdrv_get_aio_context() returns the main context then */
1798 ThreadPool *pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
1799 return thread_pool_submit_co(pool, func, arg);
1802 static int coroutine_fn raw_co_prw(BlockDriverState *bs, uint64_t offset,
1803 uint64_t bytes, QEMUIOVector *qiov, int type)
1805 BDRVRawState *s = bs->opaque;
1806 RawPosixAIOData acb;
1808 if (fd_open(bs) < 0)
1809 return -EIO;
1812 * Check if the underlying device requires requests to be aligned,
1813 * and if the request we are trying to submit is aligned or not.
1814 * If this is the case tell the low-level driver that it needs
1815 * to copy the buffer.
1817 if (s->needs_alignment) {
1818 if (!bdrv_qiov_is_aligned(bs, qiov)) {
1819 type |= QEMU_AIO_MISALIGNED;
1820 #ifdef CONFIG_LINUX_AIO
1821 } else if (s->use_linux_aio) {
1822 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1823 assert(qiov->size == bytes);
1824 return laio_co_submit(bs, aio, s->fd, offset, qiov, type);
1825 #endif
1829 acb = (RawPosixAIOData) {
1830 .bs = bs,
1831 .aio_fildes = s->fd,
1832 .aio_type = type,
1833 .aio_offset = offset,
1834 .aio_nbytes = bytes,
1835 .io = {
1836 .iov = qiov->iov,
1837 .niov = qiov->niov,
1841 assert(qiov->size == bytes);
1842 return raw_thread_pool_submit(bs, handle_aiocb_rw, &acb);
1845 static int coroutine_fn raw_co_preadv(BlockDriverState *bs, uint64_t offset,
1846 uint64_t bytes, QEMUIOVector *qiov,
1847 int flags)
1849 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_READ);
1852 static int coroutine_fn raw_co_pwritev(BlockDriverState *bs, uint64_t offset,
1853 uint64_t bytes, QEMUIOVector *qiov,
1854 int flags)
1856 assert(flags == 0);
1857 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_WRITE);
1860 static void raw_aio_plug(BlockDriverState *bs)
1862 #ifdef CONFIG_LINUX_AIO
1863 BDRVRawState *s = bs->opaque;
1864 if (s->use_linux_aio) {
1865 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1866 laio_io_plug(bs, aio);
1868 #endif
1871 static void raw_aio_unplug(BlockDriverState *bs)
1873 #ifdef CONFIG_LINUX_AIO
1874 BDRVRawState *s = bs->opaque;
1875 if (s->use_linux_aio) {
1876 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1877 laio_io_unplug(bs, aio);
1879 #endif
1882 static int raw_co_flush_to_disk(BlockDriverState *bs)
1884 BDRVRawState *s = bs->opaque;
1885 RawPosixAIOData acb;
1886 int ret;
1888 ret = fd_open(bs);
1889 if (ret < 0) {
1890 return ret;
1893 acb = (RawPosixAIOData) {
1894 .bs = bs,
1895 .aio_fildes = s->fd,
1896 .aio_type = QEMU_AIO_FLUSH,
1899 return raw_thread_pool_submit(bs, handle_aiocb_flush, &acb);
1902 static void raw_aio_attach_aio_context(BlockDriverState *bs,
1903 AioContext *new_context)
1905 #ifdef CONFIG_LINUX_AIO
1906 BDRVRawState *s = bs->opaque;
1907 if (s->use_linux_aio) {
1908 Error *local_err;
1909 if (!aio_setup_linux_aio(new_context, &local_err)) {
1910 error_reportf_err(local_err, "Unable to use native AIO, "
1911 "falling back to thread pool: ");
1912 s->use_linux_aio = false;
1915 #endif
1918 static void raw_close(BlockDriverState *bs)
1920 BDRVRawState *s = bs->opaque;
1922 if (s->fd >= 0) {
1923 qemu_close(s->fd);
1924 s->fd = -1;
1929 * Truncates the given regular file @fd to @offset and, when growing, fills the
1930 * new space according to @prealloc.
1932 * Returns: 0 on success, -errno on failure.
1934 static int coroutine_fn
1935 raw_regular_truncate(BlockDriverState *bs, int fd, int64_t offset,
1936 PreallocMode prealloc, Error **errp)
1938 RawPosixAIOData acb;
1940 acb = (RawPosixAIOData) {
1941 .bs = bs,
1942 .aio_fildes = fd,
1943 .aio_type = QEMU_AIO_TRUNCATE,
1944 .aio_offset = offset,
1945 .truncate = {
1946 .prealloc = prealloc,
1947 .errp = errp,
1951 return raw_thread_pool_submit(bs, handle_aiocb_truncate, &acb);
1954 static int coroutine_fn raw_co_truncate(BlockDriverState *bs, int64_t offset,
1955 PreallocMode prealloc, Error **errp)
1957 BDRVRawState *s = bs->opaque;
1958 struct stat st;
1959 int ret;
1961 if (fstat(s->fd, &st)) {
1962 ret = -errno;
1963 error_setg_errno(errp, -ret, "Failed to fstat() the file");
1964 return ret;
1967 if (S_ISREG(st.st_mode)) {
1968 return raw_regular_truncate(bs, s->fd, offset, prealloc, errp);
1971 if (prealloc != PREALLOC_MODE_OFF) {
1972 error_setg(errp, "Preallocation mode '%s' unsupported for this "
1973 "non-regular file", PreallocMode_str(prealloc));
1974 return -ENOTSUP;
1977 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
1978 if (offset > raw_getlength(bs)) {
1979 error_setg(errp, "Cannot grow device files");
1980 return -EINVAL;
1982 } else {
1983 error_setg(errp, "Resizing this file is not supported");
1984 return -ENOTSUP;
1987 return 0;
1990 #ifdef __OpenBSD__
1991 static int64_t raw_getlength(BlockDriverState *bs)
1993 BDRVRawState *s = bs->opaque;
1994 int fd = s->fd;
1995 struct stat st;
1997 if (fstat(fd, &st))
1998 return -errno;
1999 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2000 struct disklabel dl;
2002 if (ioctl(fd, DIOCGDINFO, &dl))
2003 return -errno;
2004 return (uint64_t)dl.d_secsize *
2005 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2006 } else
2007 return st.st_size;
2009 #elif defined(__NetBSD__)
2010 static int64_t raw_getlength(BlockDriverState *bs)
2012 BDRVRawState *s = bs->opaque;
2013 int fd = s->fd;
2014 struct stat st;
2016 if (fstat(fd, &st))
2017 return -errno;
2018 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2019 struct dkwedge_info dkw;
2021 if (ioctl(fd, DIOCGWEDGEINFO, &dkw) != -1) {
2022 return dkw.dkw_size * 512;
2023 } else {
2024 struct disklabel dl;
2026 if (ioctl(fd, DIOCGDINFO, &dl))
2027 return -errno;
2028 return (uint64_t)dl.d_secsize *
2029 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2031 } else
2032 return st.st_size;
2034 #elif defined(__sun__)
2035 static int64_t raw_getlength(BlockDriverState *bs)
2037 BDRVRawState *s = bs->opaque;
2038 struct dk_minfo minfo;
2039 int ret;
2040 int64_t size;
2042 ret = fd_open(bs);
2043 if (ret < 0) {
2044 return ret;
2048 * Use the DKIOCGMEDIAINFO ioctl to read the size.
2050 ret = ioctl(s->fd, DKIOCGMEDIAINFO, &minfo);
2051 if (ret != -1) {
2052 return minfo.dki_lbsize * minfo.dki_capacity;
2056 * There are reports that lseek on some devices fails, but
2057 * irc discussion said that contingency on contingency was overkill.
2059 size = lseek(s->fd, 0, SEEK_END);
2060 if (size < 0) {
2061 return -errno;
2063 return size;
2065 #elif defined(CONFIG_BSD)
2066 static int64_t raw_getlength(BlockDriverState *bs)
2068 BDRVRawState *s = bs->opaque;
2069 int fd = s->fd;
2070 int64_t size;
2071 struct stat sb;
2072 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2073 int reopened = 0;
2074 #endif
2075 int ret;
2077 ret = fd_open(bs);
2078 if (ret < 0)
2079 return ret;
2081 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2082 again:
2083 #endif
2084 if (!fstat(fd, &sb) && (S_IFCHR & sb.st_mode)) {
2085 #ifdef DIOCGMEDIASIZE
2086 if (ioctl(fd, DIOCGMEDIASIZE, (off_t *)&size))
2087 #elif defined(DIOCGPART)
2089 struct partinfo pi;
2090 if (ioctl(fd, DIOCGPART, &pi) == 0)
2091 size = pi.media_size;
2092 else
2093 size = 0;
2095 if (size == 0)
2096 #endif
2097 #if defined(__APPLE__) && defined(__MACH__)
2099 uint64_t sectors = 0;
2100 uint32_t sector_size = 0;
2102 if (ioctl(fd, DKIOCGETBLOCKCOUNT, &sectors) == 0
2103 && ioctl(fd, DKIOCGETBLOCKSIZE, &sector_size) == 0) {
2104 size = sectors * sector_size;
2105 } else {
2106 size = lseek(fd, 0LL, SEEK_END);
2107 if (size < 0) {
2108 return -errno;
2112 #else
2113 size = lseek(fd, 0LL, SEEK_END);
2114 if (size < 0) {
2115 return -errno;
2117 #endif
2118 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
2119 switch(s->type) {
2120 case FTYPE_CD:
2121 /* XXX FreeBSD acd returns UINT_MAX sectors for an empty drive */
2122 if (size == 2048LL * (unsigned)-1)
2123 size = 0;
2124 /* XXX no disc? maybe we need to reopen... */
2125 if (size <= 0 && !reopened && cdrom_reopen(bs) >= 0) {
2126 reopened = 1;
2127 goto again;
2130 #endif
2131 } else {
2132 size = lseek(fd, 0, SEEK_END);
2133 if (size < 0) {
2134 return -errno;
2137 return size;
2139 #else
2140 static int64_t raw_getlength(BlockDriverState *bs)
2142 BDRVRawState *s = bs->opaque;
2143 int ret;
2144 int64_t size;
2146 ret = fd_open(bs);
2147 if (ret < 0) {
2148 return ret;
2151 size = lseek(s->fd, 0, SEEK_END);
2152 if (size < 0) {
2153 return -errno;
2155 return size;
2157 #endif
2159 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
2161 struct stat st;
2162 BDRVRawState *s = bs->opaque;
2164 if (fstat(s->fd, &st) < 0) {
2165 return -errno;
2167 return (int64_t)st.st_blocks * 512;
2170 static int coroutine_fn
2171 raw_co_create(BlockdevCreateOptions *options, Error **errp)
2173 BlockdevCreateOptionsFile *file_opts;
2174 Error *local_err = NULL;
2175 int fd;
2176 uint64_t perm, shared;
2177 int result = 0;
2179 /* Validate options and set default values */
2180 assert(options->driver == BLOCKDEV_DRIVER_FILE);
2181 file_opts = &options->u.file;
2183 if (!file_opts->has_nocow) {
2184 file_opts->nocow = false;
2186 if (!file_opts->has_preallocation) {
2187 file_opts->preallocation = PREALLOC_MODE_OFF;
2190 /* Create file */
2191 fd = qemu_open(file_opts->filename, O_RDWR | O_CREAT | O_BINARY, 0644);
2192 if (fd < 0) {
2193 result = -errno;
2194 error_setg_errno(errp, -result, "Could not create file");
2195 goto out;
2198 /* Take permissions: We want to discard everything, so we need
2199 * BLK_PERM_WRITE; and truncation to the desired size requires
2200 * BLK_PERM_RESIZE.
2201 * On the other hand, we cannot share the RESIZE permission
2202 * because we promise that after this function, the file has the
2203 * size given in the options. If someone else were to resize it
2204 * concurrently, we could not guarantee that.
2205 * Note that after this function, we can no longer guarantee that
2206 * the file is not touched by a third party, so it may be resized
2207 * then. */
2208 perm = BLK_PERM_WRITE | BLK_PERM_RESIZE;
2209 shared = BLK_PERM_ALL & ~BLK_PERM_RESIZE;
2211 /* Step one: Take locks */
2212 result = raw_apply_lock_bytes(NULL, fd, perm, ~shared, false, errp);
2213 if (result < 0) {
2214 goto out_close;
2217 /* Step two: Check that nobody else has taken conflicting locks */
2218 result = raw_check_lock_bytes(fd, perm, shared, errp);
2219 if (result < 0) {
2220 error_append_hint(errp,
2221 "Is another process using the image [%s]?\n",
2222 file_opts->filename);
2223 goto out_unlock;
2226 /* Clear the file by truncating it to 0 */
2227 result = raw_regular_truncate(NULL, fd, 0, PREALLOC_MODE_OFF, errp);
2228 if (result < 0) {
2229 goto out_unlock;
2232 if (file_opts->nocow) {
2233 #ifdef __linux__
2234 /* Set NOCOW flag to solve performance issue on fs like btrfs.
2235 * This is an optimisation. The FS_IOC_SETFLAGS ioctl return value
2236 * will be ignored since any failure of this operation should not
2237 * block the left work.
2239 int attr;
2240 if (ioctl(fd, FS_IOC_GETFLAGS, &attr) == 0) {
2241 attr |= FS_NOCOW_FL;
2242 ioctl(fd, FS_IOC_SETFLAGS, &attr);
2244 #endif
2247 /* Resize and potentially preallocate the file to the desired
2248 * final size */
2249 result = raw_regular_truncate(NULL, fd, file_opts->size,
2250 file_opts->preallocation, errp);
2251 if (result < 0) {
2252 goto out_unlock;
2255 out_unlock:
2256 raw_apply_lock_bytes(NULL, fd, 0, 0, true, &local_err);
2257 if (local_err) {
2258 /* The above call should not fail, and if it does, that does
2259 * not mean the whole creation operation has failed. So
2260 * report it the user for their convenience, but do not report
2261 * it to the caller. */
2262 warn_report_err(local_err);
2265 out_close:
2266 if (qemu_close(fd) != 0 && result == 0) {
2267 result = -errno;
2268 error_setg_errno(errp, -result, "Could not close the new file");
2270 out:
2271 return result;
2274 static int coroutine_fn raw_co_create_opts(const char *filename, QemuOpts *opts,
2275 Error **errp)
2277 BlockdevCreateOptions options;
2278 int64_t total_size = 0;
2279 bool nocow = false;
2280 PreallocMode prealloc;
2281 char *buf = NULL;
2282 Error *local_err = NULL;
2284 /* Skip file: protocol prefix */
2285 strstart(filename, "file:", &filename);
2287 /* Read out options */
2288 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2289 BDRV_SECTOR_SIZE);
2290 nocow = qemu_opt_get_bool(opts, BLOCK_OPT_NOCOW, false);
2291 buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
2292 prealloc = qapi_enum_parse(&PreallocMode_lookup, buf,
2293 PREALLOC_MODE_OFF, &local_err);
2294 g_free(buf);
2295 if (local_err) {
2296 error_propagate(errp, local_err);
2297 return -EINVAL;
2300 options = (BlockdevCreateOptions) {
2301 .driver = BLOCKDEV_DRIVER_FILE,
2302 .u.file = {
2303 .filename = (char *) filename,
2304 .size = total_size,
2305 .has_preallocation = true,
2306 .preallocation = prealloc,
2307 .has_nocow = true,
2308 .nocow = nocow,
2311 return raw_co_create(&options, errp);
2315 * Find allocation range in @bs around offset @start.
2316 * May change underlying file descriptor's file offset.
2317 * If @start is not in a hole, store @start in @data, and the
2318 * beginning of the next hole in @hole, and return 0.
2319 * If @start is in a non-trailing hole, store @start in @hole and the
2320 * beginning of the next non-hole in @data, and return 0.
2321 * If @start is in a trailing hole or beyond EOF, return -ENXIO.
2322 * If we can't find out, return a negative errno other than -ENXIO.
2324 static int find_allocation(BlockDriverState *bs, off_t start,
2325 off_t *data, off_t *hole)
2327 #if defined SEEK_HOLE && defined SEEK_DATA
2328 BDRVRawState *s = bs->opaque;
2329 off_t offs;
2332 * SEEK_DATA cases:
2333 * D1. offs == start: start is in data
2334 * D2. offs > start: start is in a hole, next data at offs
2335 * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
2336 * or start is beyond EOF
2337 * If the latter happens, the file has been truncated behind
2338 * our back since we opened it. All bets are off then.
2339 * Treating like a trailing hole is simplest.
2340 * D4. offs < 0, errno != ENXIO: we learned nothing
2342 offs = lseek(s->fd, start, SEEK_DATA);
2343 if (offs < 0) {
2344 return -errno; /* D3 or D4 */
2347 if (offs < start) {
2348 /* This is not a valid return by lseek(). We are safe to just return
2349 * -EIO in this case, and we'll treat it like D4. */
2350 return -EIO;
2353 if (offs > start) {
2354 /* D2: in hole, next data at offs */
2355 *hole = start;
2356 *data = offs;
2357 return 0;
2360 /* D1: in data, end not yet known */
2363 * SEEK_HOLE cases:
2364 * H1. offs == start: start is in a hole
2365 * If this happens here, a hole has been dug behind our back
2366 * since the previous lseek().
2367 * H2. offs > start: either start is in data, next hole at offs,
2368 * or start is in trailing hole, EOF at offs
2369 * Linux treats trailing holes like any other hole: offs ==
2370 * start. Solaris seeks to EOF instead: offs > start (blech).
2371 * If that happens here, a hole has been dug behind our back
2372 * since the previous lseek().
2373 * H3. offs < 0, errno = ENXIO: start is beyond EOF
2374 * If this happens, the file has been truncated behind our
2375 * back since we opened it. Treat it like a trailing hole.
2376 * H4. offs < 0, errno != ENXIO: we learned nothing
2377 * Pretend we know nothing at all, i.e. "forget" about D1.
2379 offs = lseek(s->fd, start, SEEK_HOLE);
2380 if (offs < 0) {
2381 return -errno; /* D1 and (H3 or H4) */
2384 if (offs < start) {
2385 /* This is not a valid return by lseek(). We are safe to just return
2386 * -EIO in this case, and we'll treat it like H4. */
2387 return -EIO;
2390 if (offs > start) {
2392 * D1 and H2: either in data, next hole at offs, or it was in
2393 * data but is now in a trailing hole. In the latter case,
2394 * all bets are off. Treating it as if it there was data all
2395 * the way to EOF is safe, so simply do that.
2397 *data = start;
2398 *hole = offs;
2399 return 0;
2402 /* D1 and H1 */
2403 return -EBUSY;
2404 #else
2405 return -ENOTSUP;
2406 #endif
2410 * Returns the allocation status of the specified offset.
2412 * The block layer guarantees 'offset' and 'bytes' are within bounds.
2414 * 'pnum' is set to the number of bytes (including and immediately following
2415 * the specified offset) that are known to be in the same
2416 * allocated/unallocated state.
2418 * 'bytes' is the max value 'pnum' should be set to.
2420 static int coroutine_fn raw_co_block_status(BlockDriverState *bs,
2421 bool want_zero,
2422 int64_t offset,
2423 int64_t bytes, int64_t *pnum,
2424 int64_t *map,
2425 BlockDriverState **file)
2427 off_t data = 0, hole = 0;
2428 int ret;
2430 ret = fd_open(bs);
2431 if (ret < 0) {
2432 return ret;
2435 if (!want_zero) {
2436 *pnum = bytes;
2437 *map = offset;
2438 *file = bs;
2439 return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
2442 ret = find_allocation(bs, offset, &data, &hole);
2443 if (ret == -ENXIO) {
2444 /* Trailing hole */
2445 *pnum = bytes;
2446 ret = BDRV_BLOCK_ZERO;
2447 } else if (ret < 0) {
2448 /* No info available, so pretend there are no holes */
2449 *pnum = bytes;
2450 ret = BDRV_BLOCK_DATA;
2451 } else if (data == offset) {
2452 /* On a data extent, compute bytes to the end of the extent,
2453 * possibly including a partial sector at EOF. */
2454 *pnum = MIN(bytes, hole - offset);
2455 ret = BDRV_BLOCK_DATA;
2456 } else {
2457 /* On a hole, compute bytes to the beginning of the next extent. */
2458 assert(hole == offset);
2459 *pnum = MIN(bytes, data - offset);
2460 ret = BDRV_BLOCK_ZERO;
2462 *map = offset;
2463 *file = bs;
2464 return ret | BDRV_BLOCK_OFFSET_VALID;
2467 #if defined(__linux__)
2468 /* Verify that the file is not in the page cache */
2469 static void check_cache_dropped(BlockDriverState *bs, Error **errp)
2471 const size_t window_size = 128 * 1024 * 1024;
2472 BDRVRawState *s = bs->opaque;
2473 void *window = NULL;
2474 size_t length = 0;
2475 unsigned char *vec;
2476 size_t page_size;
2477 off_t offset;
2478 off_t end;
2480 /* mincore(2) page status information requires 1 byte per page */
2481 page_size = sysconf(_SC_PAGESIZE);
2482 vec = g_malloc(DIV_ROUND_UP(window_size, page_size));
2484 end = raw_getlength(bs);
2486 for (offset = 0; offset < end; offset += window_size) {
2487 void *new_window;
2488 size_t new_length;
2489 size_t vec_end;
2490 size_t i;
2491 int ret;
2493 /* Unmap previous window if size has changed */
2494 new_length = MIN(end - offset, window_size);
2495 if (new_length != length) {
2496 munmap(window, length);
2497 window = NULL;
2498 length = 0;
2501 new_window = mmap(window, new_length, PROT_NONE, MAP_PRIVATE,
2502 s->fd, offset);
2503 if (new_window == MAP_FAILED) {
2504 error_setg_errno(errp, errno, "mmap failed");
2505 break;
2508 window = new_window;
2509 length = new_length;
2511 ret = mincore(window, length, vec);
2512 if (ret < 0) {
2513 error_setg_errno(errp, errno, "mincore failed");
2514 break;
2517 vec_end = DIV_ROUND_UP(length, page_size);
2518 for (i = 0; i < vec_end; i++) {
2519 if (vec[i] & 0x1) {
2520 error_setg(errp, "page cache still in use!");
2521 break;
2526 if (window) {
2527 munmap(window, length);
2530 g_free(vec);
2532 #endif /* __linux__ */
2534 static void coroutine_fn raw_co_invalidate_cache(BlockDriverState *bs,
2535 Error **errp)
2537 BDRVRawState *s = bs->opaque;
2538 int ret;
2540 ret = fd_open(bs);
2541 if (ret < 0) {
2542 error_setg_errno(errp, -ret, "The file descriptor is not open");
2543 return;
2546 if (s->open_flags & O_DIRECT) {
2547 return; /* No host kernel page cache */
2550 #if defined(__linux__)
2551 /* This sets the scene for the next syscall... */
2552 ret = bdrv_co_flush(bs);
2553 if (ret < 0) {
2554 error_setg_errno(errp, -ret, "flush failed");
2555 return;
2558 /* Linux does not invalidate pages that are dirty, locked, or mmapped by a
2559 * process. These limitations are okay because we just fsynced the file,
2560 * we don't use mmap, and the file should not be in use by other processes.
2562 ret = posix_fadvise(s->fd, 0, 0, POSIX_FADV_DONTNEED);
2563 if (ret != 0) { /* the return value is a positive errno */
2564 error_setg_errno(errp, ret, "fadvise failed");
2565 return;
2568 if (s->check_cache_dropped) {
2569 check_cache_dropped(bs, errp);
2571 #else /* __linux__ */
2572 /* Do nothing. Live migration to a remote host with cache.direct=off is
2573 * unsupported on other host operating systems. Cache consistency issues
2574 * may occur but no error is reported here, partly because that's the
2575 * historical behavior and partly because it's hard to differentiate valid
2576 * configurations that should not cause errors.
2578 #endif /* !__linux__ */
2581 static coroutine_fn int
2582 raw_do_pdiscard(BlockDriverState *bs, int64_t offset, int bytes, bool blkdev)
2584 BDRVRawState *s = bs->opaque;
2585 RawPosixAIOData acb;
2587 acb = (RawPosixAIOData) {
2588 .bs = bs,
2589 .aio_fildes = s->fd,
2590 .aio_type = QEMU_AIO_DISCARD,
2591 .aio_offset = offset,
2592 .aio_nbytes = bytes,
2595 if (blkdev) {
2596 acb.aio_type |= QEMU_AIO_BLKDEV;
2599 return raw_thread_pool_submit(bs, handle_aiocb_discard, &acb);
2602 static coroutine_fn int
2603 raw_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
2605 return raw_do_pdiscard(bs, offset, bytes, false);
2608 static int coroutine_fn
2609 raw_do_pwrite_zeroes(BlockDriverState *bs, int64_t offset, int bytes,
2610 BdrvRequestFlags flags, bool blkdev)
2612 BDRVRawState *s = bs->opaque;
2613 RawPosixAIOData acb;
2614 ThreadPoolFunc *handler;
2616 acb = (RawPosixAIOData) {
2617 .bs = bs,
2618 .aio_fildes = s->fd,
2619 .aio_type = QEMU_AIO_WRITE_ZEROES,
2620 .aio_offset = offset,
2621 .aio_nbytes = bytes,
2624 if (blkdev) {
2625 acb.aio_type |= QEMU_AIO_BLKDEV;
2628 if (flags & BDRV_REQ_MAY_UNMAP) {
2629 acb.aio_type |= QEMU_AIO_DISCARD;
2630 handler = handle_aiocb_write_zeroes_unmap;
2631 } else {
2632 handler = handle_aiocb_write_zeroes;
2635 return raw_thread_pool_submit(bs, handler, &acb);
2638 static int coroutine_fn raw_co_pwrite_zeroes(
2639 BlockDriverState *bs, int64_t offset,
2640 int bytes, BdrvRequestFlags flags)
2642 return raw_do_pwrite_zeroes(bs, offset, bytes, flags, false);
2645 static int raw_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2647 BDRVRawState *s = bs->opaque;
2649 bdi->unallocated_blocks_are_zero = s->discard_zeroes;
2650 return 0;
2653 static QemuOptsList raw_create_opts = {
2654 .name = "raw-create-opts",
2655 .head = QTAILQ_HEAD_INITIALIZER(raw_create_opts.head),
2656 .desc = {
2658 .name = BLOCK_OPT_SIZE,
2659 .type = QEMU_OPT_SIZE,
2660 .help = "Virtual disk size"
2663 .name = BLOCK_OPT_NOCOW,
2664 .type = QEMU_OPT_BOOL,
2665 .help = "Turn off copy-on-write (valid only on btrfs)"
2668 .name = BLOCK_OPT_PREALLOC,
2669 .type = QEMU_OPT_STRING,
2670 .help = "Preallocation mode (allowed values: off, falloc, full)"
2672 { /* end of list */ }
2676 static int raw_check_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared,
2677 Error **errp)
2679 return raw_handle_perm_lock(bs, RAW_PL_PREPARE, perm, shared, errp);
2682 static void raw_set_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared)
2684 BDRVRawState *s = bs->opaque;
2685 raw_handle_perm_lock(bs, RAW_PL_COMMIT, perm, shared, NULL);
2686 s->perm = perm;
2687 s->shared_perm = shared;
2690 static void raw_abort_perm_update(BlockDriverState *bs)
2692 raw_handle_perm_lock(bs, RAW_PL_ABORT, 0, 0, NULL);
2695 static int coroutine_fn raw_co_copy_range_from(
2696 BlockDriverState *bs, BdrvChild *src, uint64_t src_offset,
2697 BdrvChild *dst, uint64_t dst_offset, uint64_t bytes,
2698 BdrvRequestFlags read_flags, BdrvRequestFlags write_flags)
2700 return bdrv_co_copy_range_to(src, src_offset, dst, dst_offset, bytes,
2701 read_flags, write_flags);
2704 static int coroutine_fn raw_co_copy_range_to(BlockDriverState *bs,
2705 BdrvChild *src,
2706 uint64_t src_offset,
2707 BdrvChild *dst,
2708 uint64_t dst_offset,
2709 uint64_t bytes,
2710 BdrvRequestFlags read_flags,
2711 BdrvRequestFlags write_flags)
2713 RawPosixAIOData acb;
2714 BDRVRawState *s = bs->opaque;
2715 BDRVRawState *src_s;
2717 assert(dst->bs == bs);
2718 if (src->bs->drv->bdrv_co_copy_range_to != raw_co_copy_range_to) {
2719 return -ENOTSUP;
2722 src_s = src->bs->opaque;
2723 if (fd_open(src->bs) < 0 || fd_open(dst->bs) < 0) {
2724 return -EIO;
2727 acb = (RawPosixAIOData) {
2728 .bs = bs,
2729 .aio_type = QEMU_AIO_COPY_RANGE,
2730 .aio_fildes = src_s->fd,
2731 .aio_offset = src_offset,
2732 .aio_nbytes = bytes,
2733 .copy_range = {
2734 .aio_fd2 = s->fd,
2735 .aio_offset2 = dst_offset,
2739 return raw_thread_pool_submit(bs, handle_aiocb_copy_range, &acb);
2742 BlockDriver bdrv_file = {
2743 .format_name = "file",
2744 .protocol_name = "file",
2745 .instance_size = sizeof(BDRVRawState),
2746 .bdrv_needs_filename = true,
2747 .bdrv_probe = NULL, /* no probe for protocols */
2748 .bdrv_parse_filename = raw_parse_filename,
2749 .bdrv_file_open = raw_open,
2750 .bdrv_reopen_prepare = raw_reopen_prepare,
2751 .bdrv_reopen_commit = raw_reopen_commit,
2752 .bdrv_reopen_abort = raw_reopen_abort,
2753 .bdrv_close = raw_close,
2754 .bdrv_co_create = raw_co_create,
2755 .bdrv_co_create_opts = raw_co_create_opts,
2756 .bdrv_has_zero_init = bdrv_has_zero_init_1,
2757 .bdrv_co_block_status = raw_co_block_status,
2758 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
2759 .bdrv_co_pwrite_zeroes = raw_co_pwrite_zeroes,
2761 .bdrv_co_preadv = raw_co_preadv,
2762 .bdrv_co_pwritev = raw_co_pwritev,
2763 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
2764 .bdrv_co_pdiscard = raw_co_pdiscard,
2765 .bdrv_co_copy_range_from = raw_co_copy_range_from,
2766 .bdrv_co_copy_range_to = raw_co_copy_range_to,
2767 .bdrv_refresh_limits = raw_refresh_limits,
2768 .bdrv_io_plug = raw_aio_plug,
2769 .bdrv_io_unplug = raw_aio_unplug,
2770 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
2772 .bdrv_co_truncate = raw_co_truncate,
2773 .bdrv_getlength = raw_getlength,
2774 .bdrv_get_info = raw_get_info,
2775 .bdrv_get_allocated_file_size
2776 = raw_get_allocated_file_size,
2777 .bdrv_check_perm = raw_check_perm,
2778 .bdrv_set_perm = raw_set_perm,
2779 .bdrv_abort_perm_update = raw_abort_perm_update,
2780 .create_opts = &raw_create_opts,
2783 /***********************************************/
2784 /* host device */
2786 #if defined(__APPLE__) && defined(__MACH__)
2787 static kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
2788 CFIndex maxPathSize, int flags);
2789 static char *FindEjectableOpticalMedia(io_iterator_t *mediaIterator)
2791 kern_return_t kernResult = KERN_FAILURE;
2792 mach_port_t masterPort;
2793 CFMutableDictionaryRef classesToMatch;
2794 const char *matching_array[] = {kIODVDMediaClass, kIOCDMediaClass};
2795 char *mediaType = NULL;
2797 kernResult = IOMasterPort( MACH_PORT_NULL, &masterPort );
2798 if ( KERN_SUCCESS != kernResult ) {
2799 printf( "IOMasterPort returned %d\n", kernResult );
2802 int index;
2803 for (index = 0; index < ARRAY_SIZE(matching_array); index++) {
2804 classesToMatch = IOServiceMatching(matching_array[index]);
2805 if (classesToMatch == NULL) {
2806 error_report("IOServiceMatching returned NULL for %s",
2807 matching_array[index]);
2808 continue;
2810 CFDictionarySetValue(classesToMatch, CFSTR(kIOMediaEjectableKey),
2811 kCFBooleanTrue);
2812 kernResult = IOServiceGetMatchingServices(masterPort, classesToMatch,
2813 mediaIterator);
2814 if (kernResult != KERN_SUCCESS) {
2815 error_report("Note: IOServiceGetMatchingServices returned %d",
2816 kernResult);
2817 continue;
2820 /* If a match was found, leave the loop */
2821 if (*mediaIterator != 0) {
2822 DPRINTF("Matching using %s\n", matching_array[index]);
2823 mediaType = g_strdup(matching_array[index]);
2824 break;
2827 return mediaType;
2830 kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
2831 CFIndex maxPathSize, int flags)
2833 io_object_t nextMedia;
2834 kern_return_t kernResult = KERN_FAILURE;
2835 *bsdPath = '\0';
2836 nextMedia = IOIteratorNext( mediaIterator );
2837 if ( nextMedia )
2839 CFTypeRef bsdPathAsCFString;
2840 bsdPathAsCFString = IORegistryEntryCreateCFProperty( nextMedia, CFSTR( kIOBSDNameKey ), kCFAllocatorDefault, 0 );
2841 if ( bsdPathAsCFString ) {
2842 size_t devPathLength;
2843 strcpy( bsdPath, _PATH_DEV );
2844 if (flags & BDRV_O_NOCACHE) {
2845 strcat(bsdPath, "r");
2847 devPathLength = strlen( bsdPath );
2848 if ( CFStringGetCString( bsdPathAsCFString, bsdPath + devPathLength, maxPathSize - devPathLength, kCFStringEncodingASCII ) ) {
2849 kernResult = KERN_SUCCESS;
2851 CFRelease( bsdPathAsCFString );
2853 IOObjectRelease( nextMedia );
2856 return kernResult;
2859 /* Sets up a real cdrom for use in QEMU */
2860 static bool setup_cdrom(char *bsd_path, Error **errp)
2862 int index, num_of_test_partitions = 2, fd;
2863 char test_partition[MAXPATHLEN];
2864 bool partition_found = false;
2866 /* look for a working partition */
2867 for (index = 0; index < num_of_test_partitions; index++) {
2868 snprintf(test_partition, sizeof(test_partition), "%ss%d", bsd_path,
2869 index);
2870 fd = qemu_open(test_partition, O_RDONLY | O_BINARY | O_LARGEFILE);
2871 if (fd >= 0) {
2872 partition_found = true;
2873 qemu_close(fd);
2874 break;
2878 /* if a working partition on the device was not found */
2879 if (partition_found == false) {
2880 error_setg(errp, "Failed to find a working partition on disc");
2881 } else {
2882 DPRINTF("Using %s as optical disc\n", test_partition);
2883 pstrcpy(bsd_path, MAXPATHLEN, test_partition);
2885 return partition_found;
2888 /* Prints directions on mounting and unmounting a device */
2889 static void print_unmounting_directions(const char *file_name)
2891 error_report("If device %s is mounted on the desktop, unmount"
2892 " it first before using it in QEMU", file_name);
2893 error_report("Command to unmount device: diskutil unmountDisk %s",
2894 file_name);
2895 error_report("Command to mount device: diskutil mountDisk %s", file_name);
2898 #endif /* defined(__APPLE__) && defined(__MACH__) */
2900 static int hdev_probe_device(const char *filename)
2902 struct stat st;
2904 /* allow a dedicated CD-ROM driver to match with a higher priority */
2905 if (strstart(filename, "/dev/cdrom", NULL))
2906 return 50;
2908 if (stat(filename, &st) >= 0 &&
2909 (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
2910 return 100;
2913 return 0;
2916 static int check_hdev_writable(BDRVRawState *s)
2918 #if defined(BLKROGET)
2919 /* Linux block devices can be configured "read-only" using blockdev(8).
2920 * This is independent of device node permissions and therefore open(2)
2921 * with O_RDWR succeeds. Actual writes fail with EPERM.
2923 * bdrv_open() is supposed to fail if the disk is read-only. Explicitly
2924 * check for read-only block devices so that Linux block devices behave
2925 * properly.
2927 struct stat st;
2928 int readonly = 0;
2930 if (fstat(s->fd, &st)) {
2931 return -errno;
2934 if (!S_ISBLK(st.st_mode)) {
2935 return 0;
2938 if (ioctl(s->fd, BLKROGET, &readonly) < 0) {
2939 return -errno;
2942 if (readonly) {
2943 return -EACCES;
2945 #endif /* defined(BLKROGET) */
2946 return 0;
2949 static void hdev_parse_filename(const char *filename, QDict *options,
2950 Error **errp)
2952 bdrv_parse_filename_strip_prefix(filename, "host_device:", options);
2955 static bool hdev_is_sg(BlockDriverState *bs)
2958 #if defined(__linux__)
2960 BDRVRawState *s = bs->opaque;
2961 struct stat st;
2962 struct sg_scsi_id scsiid;
2963 int sg_version;
2964 int ret;
2966 if (stat(bs->filename, &st) < 0 || !S_ISCHR(st.st_mode)) {
2967 return false;
2970 ret = ioctl(s->fd, SG_GET_VERSION_NUM, &sg_version);
2971 if (ret < 0) {
2972 return false;
2975 ret = ioctl(s->fd, SG_GET_SCSI_ID, &scsiid);
2976 if (ret >= 0) {
2977 DPRINTF("SG device found: type=%d, version=%d\n",
2978 scsiid.scsi_type, sg_version);
2979 return true;
2982 #endif
2984 return false;
2987 static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
2988 Error **errp)
2990 BDRVRawState *s = bs->opaque;
2991 Error *local_err = NULL;
2992 int ret;
2994 #if defined(__APPLE__) && defined(__MACH__)
2996 * Caution: while qdict_get_str() is fine, getting non-string types
2997 * would require more care. When @options come from -blockdev or
2998 * blockdev_add, its members are typed according to the QAPI
2999 * schema, but when they come from -drive, they're all QString.
3001 const char *filename = qdict_get_str(options, "filename");
3002 char bsd_path[MAXPATHLEN] = "";
3003 bool error_occurred = false;
3005 /* If using a real cdrom */
3006 if (strcmp(filename, "/dev/cdrom") == 0) {
3007 char *mediaType = NULL;
3008 kern_return_t ret_val;
3009 io_iterator_t mediaIterator = 0;
3011 mediaType = FindEjectableOpticalMedia(&mediaIterator);
3012 if (mediaType == NULL) {
3013 error_setg(errp, "Please make sure your CD/DVD is in the optical"
3014 " drive");
3015 error_occurred = true;
3016 goto hdev_open_Mac_error;
3019 ret_val = GetBSDPath(mediaIterator, bsd_path, sizeof(bsd_path), flags);
3020 if (ret_val != KERN_SUCCESS) {
3021 error_setg(errp, "Could not get BSD path for optical drive");
3022 error_occurred = true;
3023 goto hdev_open_Mac_error;
3026 /* If a real optical drive was not found */
3027 if (bsd_path[0] == '\0') {
3028 error_setg(errp, "Failed to obtain bsd path for optical drive");
3029 error_occurred = true;
3030 goto hdev_open_Mac_error;
3033 /* If using a cdrom disc and finding a partition on the disc failed */
3034 if (strncmp(mediaType, kIOCDMediaClass, 9) == 0 &&
3035 setup_cdrom(bsd_path, errp) == false) {
3036 print_unmounting_directions(bsd_path);
3037 error_occurred = true;
3038 goto hdev_open_Mac_error;
3041 qdict_put_str(options, "filename", bsd_path);
3043 hdev_open_Mac_error:
3044 g_free(mediaType);
3045 if (mediaIterator) {
3046 IOObjectRelease(mediaIterator);
3048 if (error_occurred) {
3049 return -ENOENT;
3052 #endif /* defined(__APPLE__) && defined(__MACH__) */
3054 s->type = FTYPE_FILE;
3056 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3057 if (ret < 0) {
3058 error_propagate(errp, local_err);
3059 #if defined(__APPLE__) && defined(__MACH__)
3060 if (*bsd_path) {
3061 filename = bsd_path;
3063 /* if a physical device experienced an error while being opened */
3064 if (strncmp(filename, "/dev/", 5) == 0) {
3065 print_unmounting_directions(filename);
3067 #endif /* defined(__APPLE__) && defined(__MACH__) */
3068 return ret;
3071 /* Since this does ioctl the device must be already opened */
3072 bs->sg = hdev_is_sg(bs);
3074 if (flags & BDRV_O_RDWR) {
3075 ret = check_hdev_writable(s);
3076 if (ret < 0) {
3077 raw_close(bs);
3078 error_setg_errno(errp, -ret, "The device is not writable");
3079 return ret;
3083 return ret;
3086 #if defined(__linux__)
3087 static int coroutine_fn
3088 hdev_co_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
3090 BDRVRawState *s = bs->opaque;
3091 RawPosixAIOData acb;
3092 int ret;
3094 ret = fd_open(bs);
3095 if (ret < 0) {
3096 return ret;
3099 if (req == SG_IO && s->pr_mgr) {
3100 struct sg_io_hdr *io_hdr = buf;
3101 if (io_hdr->cmdp[0] == PERSISTENT_RESERVE_OUT ||
3102 io_hdr->cmdp[0] == PERSISTENT_RESERVE_IN) {
3103 return pr_manager_execute(s->pr_mgr, bdrv_get_aio_context(bs),
3104 s->fd, io_hdr);
3108 acb = (RawPosixAIOData) {
3109 .bs = bs,
3110 .aio_type = QEMU_AIO_IOCTL,
3111 .aio_fildes = s->fd,
3112 .aio_offset = 0,
3113 .ioctl = {
3114 .buf = buf,
3115 .cmd = req,
3119 return raw_thread_pool_submit(bs, handle_aiocb_ioctl, &acb);
3121 #endif /* linux */
3123 static int fd_open(BlockDriverState *bs)
3125 BDRVRawState *s = bs->opaque;
3127 /* this is just to ensure s->fd is sane (its called by io ops) */
3128 if (s->fd >= 0)
3129 return 0;
3130 return -EIO;
3133 static coroutine_fn int
3134 hdev_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
3136 int ret;
3138 ret = fd_open(bs);
3139 if (ret < 0) {
3140 return ret;
3142 return raw_do_pdiscard(bs, offset, bytes, true);
3145 static coroutine_fn int hdev_co_pwrite_zeroes(BlockDriverState *bs,
3146 int64_t offset, int bytes, BdrvRequestFlags flags)
3148 int rc;
3150 rc = fd_open(bs);
3151 if (rc < 0) {
3152 return rc;
3155 return raw_do_pwrite_zeroes(bs, offset, bytes, flags, true);
3158 static int coroutine_fn hdev_co_create_opts(const char *filename, QemuOpts *opts,
3159 Error **errp)
3161 int fd;
3162 int ret = 0;
3163 struct stat stat_buf;
3164 int64_t total_size = 0;
3165 bool has_prefix;
3167 /* This function is used by both protocol block drivers and therefore either
3168 * of these prefixes may be given.
3169 * The return value has to be stored somewhere, otherwise this is an error
3170 * due to -Werror=unused-value. */
3171 has_prefix =
3172 strstart(filename, "host_device:", &filename) ||
3173 strstart(filename, "host_cdrom:" , &filename);
3175 (void)has_prefix;
3177 ret = raw_normalize_devicepath(&filename, errp);
3178 if (ret < 0) {
3179 return ret;
3182 /* Read out options */
3183 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
3184 BDRV_SECTOR_SIZE);
3186 fd = qemu_open(filename, O_WRONLY | O_BINARY);
3187 if (fd < 0) {
3188 ret = -errno;
3189 error_setg_errno(errp, -ret, "Could not open device");
3190 return ret;
3193 if (fstat(fd, &stat_buf) < 0) {
3194 ret = -errno;
3195 error_setg_errno(errp, -ret, "Could not stat device");
3196 } else if (!S_ISBLK(stat_buf.st_mode) && !S_ISCHR(stat_buf.st_mode)) {
3197 error_setg(errp,
3198 "The given file is neither a block nor a character device");
3199 ret = -ENODEV;
3200 } else if (lseek(fd, 0, SEEK_END) < total_size) {
3201 error_setg(errp, "Device is too small");
3202 ret = -ENOSPC;
3205 if (!ret && total_size) {
3206 uint8_t buf[BDRV_SECTOR_SIZE] = { 0 };
3207 int64_t zero_size = MIN(BDRV_SECTOR_SIZE, total_size);
3208 if (lseek(fd, 0, SEEK_SET) == -1) {
3209 ret = -errno;
3210 } else {
3211 ret = qemu_write_full(fd, buf, zero_size);
3212 ret = ret == zero_size ? 0 : -errno;
3215 qemu_close(fd);
3216 return ret;
3219 static BlockDriver bdrv_host_device = {
3220 .format_name = "host_device",
3221 .protocol_name = "host_device",
3222 .instance_size = sizeof(BDRVRawState),
3223 .bdrv_needs_filename = true,
3224 .bdrv_probe_device = hdev_probe_device,
3225 .bdrv_parse_filename = hdev_parse_filename,
3226 .bdrv_file_open = hdev_open,
3227 .bdrv_close = raw_close,
3228 .bdrv_reopen_prepare = raw_reopen_prepare,
3229 .bdrv_reopen_commit = raw_reopen_commit,
3230 .bdrv_reopen_abort = raw_reopen_abort,
3231 .bdrv_co_create_opts = hdev_co_create_opts,
3232 .create_opts = &raw_create_opts,
3233 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3234 .bdrv_co_pwrite_zeroes = hdev_co_pwrite_zeroes,
3236 .bdrv_co_preadv = raw_co_preadv,
3237 .bdrv_co_pwritev = raw_co_pwritev,
3238 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3239 .bdrv_co_pdiscard = hdev_co_pdiscard,
3240 .bdrv_co_copy_range_from = raw_co_copy_range_from,
3241 .bdrv_co_copy_range_to = raw_co_copy_range_to,
3242 .bdrv_refresh_limits = raw_refresh_limits,
3243 .bdrv_io_plug = raw_aio_plug,
3244 .bdrv_io_unplug = raw_aio_unplug,
3245 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3247 .bdrv_co_truncate = raw_co_truncate,
3248 .bdrv_getlength = raw_getlength,
3249 .bdrv_get_info = raw_get_info,
3250 .bdrv_get_allocated_file_size
3251 = raw_get_allocated_file_size,
3252 .bdrv_check_perm = raw_check_perm,
3253 .bdrv_set_perm = raw_set_perm,
3254 .bdrv_abort_perm_update = raw_abort_perm_update,
3255 .bdrv_probe_blocksizes = hdev_probe_blocksizes,
3256 .bdrv_probe_geometry = hdev_probe_geometry,
3258 /* generic scsi device */
3259 #ifdef __linux__
3260 .bdrv_co_ioctl = hdev_co_ioctl,
3261 #endif
3264 #if defined(__linux__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3265 static void cdrom_parse_filename(const char *filename, QDict *options,
3266 Error **errp)
3268 bdrv_parse_filename_strip_prefix(filename, "host_cdrom:", options);
3270 #endif
3272 #ifdef __linux__
3273 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3274 Error **errp)
3276 BDRVRawState *s = bs->opaque;
3278 s->type = FTYPE_CD;
3280 /* open will not fail even if no CD is inserted, so add O_NONBLOCK */
3281 return raw_open_common(bs, options, flags, O_NONBLOCK, true, errp);
3284 static int cdrom_probe_device(const char *filename)
3286 int fd, ret;
3287 int prio = 0;
3288 struct stat st;
3290 fd = qemu_open(filename, O_RDONLY | O_NONBLOCK);
3291 if (fd < 0) {
3292 goto out;
3294 ret = fstat(fd, &st);
3295 if (ret == -1 || !S_ISBLK(st.st_mode)) {
3296 goto outc;
3299 /* Attempt to detect via a CDROM specific ioctl */
3300 ret = ioctl(fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3301 if (ret >= 0)
3302 prio = 100;
3304 outc:
3305 qemu_close(fd);
3306 out:
3307 return prio;
3310 static bool cdrom_is_inserted(BlockDriverState *bs)
3312 BDRVRawState *s = bs->opaque;
3313 int ret;
3315 ret = ioctl(s->fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3316 return ret == CDS_DISC_OK;
3319 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3321 BDRVRawState *s = bs->opaque;
3323 if (eject_flag) {
3324 if (ioctl(s->fd, CDROMEJECT, NULL) < 0)
3325 perror("CDROMEJECT");
3326 } else {
3327 if (ioctl(s->fd, CDROMCLOSETRAY, NULL) < 0)
3328 perror("CDROMEJECT");
3332 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3334 BDRVRawState *s = bs->opaque;
3336 if (ioctl(s->fd, CDROM_LOCKDOOR, locked) < 0) {
3338 * Note: an error can happen if the distribution automatically
3339 * mounts the CD-ROM
3341 /* perror("CDROM_LOCKDOOR"); */
3345 static BlockDriver bdrv_host_cdrom = {
3346 .format_name = "host_cdrom",
3347 .protocol_name = "host_cdrom",
3348 .instance_size = sizeof(BDRVRawState),
3349 .bdrv_needs_filename = true,
3350 .bdrv_probe_device = cdrom_probe_device,
3351 .bdrv_parse_filename = cdrom_parse_filename,
3352 .bdrv_file_open = cdrom_open,
3353 .bdrv_close = raw_close,
3354 .bdrv_reopen_prepare = raw_reopen_prepare,
3355 .bdrv_reopen_commit = raw_reopen_commit,
3356 .bdrv_reopen_abort = raw_reopen_abort,
3357 .bdrv_co_create_opts = hdev_co_create_opts,
3358 .create_opts = &raw_create_opts,
3359 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3362 .bdrv_co_preadv = raw_co_preadv,
3363 .bdrv_co_pwritev = raw_co_pwritev,
3364 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3365 .bdrv_refresh_limits = raw_refresh_limits,
3366 .bdrv_io_plug = raw_aio_plug,
3367 .bdrv_io_unplug = raw_aio_unplug,
3368 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3370 .bdrv_co_truncate = raw_co_truncate,
3371 .bdrv_getlength = raw_getlength,
3372 .has_variable_length = true,
3373 .bdrv_get_allocated_file_size
3374 = raw_get_allocated_file_size,
3376 /* removable device support */
3377 .bdrv_is_inserted = cdrom_is_inserted,
3378 .bdrv_eject = cdrom_eject,
3379 .bdrv_lock_medium = cdrom_lock_medium,
3381 /* generic scsi device */
3382 .bdrv_co_ioctl = hdev_co_ioctl,
3384 #endif /* __linux__ */
3386 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
3387 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3388 Error **errp)
3390 BDRVRawState *s = bs->opaque;
3391 Error *local_err = NULL;
3392 int ret;
3394 s->type = FTYPE_CD;
3396 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3397 if (ret) {
3398 error_propagate(errp, local_err);
3399 return ret;
3402 /* make sure the door isn't locked at this time */
3403 ioctl(s->fd, CDIOCALLOW);
3404 return 0;
3407 static int cdrom_probe_device(const char *filename)
3409 if (strstart(filename, "/dev/cd", NULL) ||
3410 strstart(filename, "/dev/acd", NULL))
3411 return 100;
3412 return 0;
3415 static int cdrom_reopen(BlockDriverState *bs)
3417 BDRVRawState *s = bs->opaque;
3418 int fd;
3421 * Force reread of possibly changed/newly loaded disc,
3422 * FreeBSD seems to not notice sometimes...
3424 if (s->fd >= 0)
3425 qemu_close(s->fd);
3426 fd = qemu_open(bs->filename, s->open_flags, 0644);
3427 if (fd < 0) {
3428 s->fd = -1;
3429 return -EIO;
3431 s->fd = fd;
3433 /* make sure the door isn't locked at this time */
3434 ioctl(s->fd, CDIOCALLOW);
3435 return 0;
3438 static bool cdrom_is_inserted(BlockDriverState *bs)
3440 return raw_getlength(bs) > 0;
3443 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3445 BDRVRawState *s = bs->opaque;
3447 if (s->fd < 0)
3448 return;
3450 (void) ioctl(s->fd, CDIOCALLOW);
3452 if (eject_flag) {
3453 if (ioctl(s->fd, CDIOCEJECT) < 0)
3454 perror("CDIOCEJECT");
3455 } else {
3456 if (ioctl(s->fd, CDIOCCLOSE) < 0)
3457 perror("CDIOCCLOSE");
3460 cdrom_reopen(bs);
3463 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3465 BDRVRawState *s = bs->opaque;
3467 if (s->fd < 0)
3468 return;
3469 if (ioctl(s->fd, (locked ? CDIOCPREVENT : CDIOCALLOW)) < 0) {
3471 * Note: an error can happen if the distribution automatically
3472 * mounts the CD-ROM
3474 /* perror("CDROM_LOCKDOOR"); */
3478 static BlockDriver bdrv_host_cdrom = {
3479 .format_name = "host_cdrom",
3480 .protocol_name = "host_cdrom",
3481 .instance_size = sizeof(BDRVRawState),
3482 .bdrv_needs_filename = true,
3483 .bdrv_probe_device = cdrom_probe_device,
3484 .bdrv_parse_filename = cdrom_parse_filename,
3485 .bdrv_file_open = cdrom_open,
3486 .bdrv_close = raw_close,
3487 .bdrv_reopen_prepare = raw_reopen_prepare,
3488 .bdrv_reopen_commit = raw_reopen_commit,
3489 .bdrv_reopen_abort = raw_reopen_abort,
3490 .bdrv_co_create_opts = hdev_co_create_opts,
3491 .create_opts = &raw_create_opts,
3493 .bdrv_co_preadv = raw_co_preadv,
3494 .bdrv_co_pwritev = raw_co_pwritev,
3495 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3496 .bdrv_refresh_limits = raw_refresh_limits,
3497 .bdrv_io_plug = raw_aio_plug,
3498 .bdrv_io_unplug = raw_aio_unplug,
3499 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3501 .bdrv_co_truncate = raw_co_truncate,
3502 .bdrv_getlength = raw_getlength,
3503 .has_variable_length = true,
3504 .bdrv_get_allocated_file_size
3505 = raw_get_allocated_file_size,
3507 /* removable device support */
3508 .bdrv_is_inserted = cdrom_is_inserted,
3509 .bdrv_eject = cdrom_eject,
3510 .bdrv_lock_medium = cdrom_lock_medium,
3512 #endif /* __FreeBSD__ */
3514 static void bdrv_file_init(void)
3517 * Register all the drivers. Note that order is important, the driver
3518 * registered last will get probed first.
3520 bdrv_register(&bdrv_file);
3521 bdrv_register(&bdrv_host_device);
3522 #ifdef __linux__
3523 bdrv_register(&bdrv_host_cdrom);
3524 #endif
3525 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3526 bdrv_register(&bdrv_host_cdrom);
3527 #endif
3530 block_init(bdrv_file_init);