target/arm: Move debug routines to debug_helper.c
[qemu/ar7.git] / block / file-posix.c
blobab05b51a6670156ae364923d0c7c7b0e28cac231
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;
165 PRManager *pr_mgr;
166 } BDRVRawState;
168 typedef struct BDRVRawReopenState {
169 int fd;
170 int open_flags;
171 bool drop_cache;
172 bool check_cache_dropped;
173 } BDRVRawReopenState;
175 static int fd_open(BlockDriverState *bs);
176 static int64_t raw_getlength(BlockDriverState *bs);
178 typedef struct RawPosixAIOData {
179 BlockDriverState *bs;
180 int aio_type;
181 int aio_fildes;
183 off_t aio_offset;
184 uint64_t aio_nbytes;
186 union {
187 struct {
188 struct iovec *iov;
189 int niov;
190 } io;
191 struct {
192 uint64_t cmd;
193 void *buf;
194 } ioctl;
195 struct {
196 int aio_fd2;
197 off_t aio_offset2;
198 } copy_range;
199 struct {
200 PreallocMode prealloc;
201 Error **errp;
202 } truncate;
204 } RawPosixAIOData;
206 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
207 static int cdrom_reopen(BlockDriverState *bs);
208 #endif
210 #if defined(__NetBSD__)
211 static int raw_normalize_devicepath(const char **filename, Error **errp)
213 static char namebuf[PATH_MAX];
214 const char *dp, *fname;
215 struct stat sb;
217 fname = *filename;
218 dp = strrchr(fname, '/');
219 if (lstat(fname, &sb) < 0) {
220 error_setg_errno(errp, errno, "%s: stat failed", fname);
221 return -errno;
224 if (!S_ISBLK(sb.st_mode)) {
225 return 0;
228 if (dp == NULL) {
229 snprintf(namebuf, PATH_MAX, "r%s", fname);
230 } else {
231 snprintf(namebuf, PATH_MAX, "%.*s/r%s",
232 (int)(dp - fname), fname, dp + 1);
234 *filename = namebuf;
235 warn_report("%s is a block device, using %s", fname, *filename);
237 return 0;
239 #else
240 static int raw_normalize_devicepath(const char **filename, Error **errp)
242 return 0;
244 #endif
247 * Get logical block size via ioctl. On success store it in @sector_size_p.
249 static int probe_logical_blocksize(int fd, unsigned int *sector_size_p)
251 unsigned int sector_size;
252 bool success = false;
253 int i;
255 errno = ENOTSUP;
256 static const unsigned long ioctl_list[] = {
257 #ifdef BLKSSZGET
258 BLKSSZGET,
259 #endif
260 #ifdef DKIOCGETBLOCKSIZE
261 DKIOCGETBLOCKSIZE,
262 #endif
263 #ifdef DIOCGSECTORSIZE
264 DIOCGSECTORSIZE,
265 #endif
268 /* Try a few ioctls to get the right size */
269 for (i = 0; i < (int)ARRAY_SIZE(ioctl_list); i++) {
270 if (ioctl(fd, ioctl_list[i], &sector_size) >= 0) {
271 *sector_size_p = sector_size;
272 success = true;
276 return success ? 0 : -errno;
280 * Get physical block size of @fd.
281 * On success, store it in @blk_size and return 0.
282 * On failure, return -errno.
284 static int probe_physical_blocksize(int fd, unsigned int *blk_size)
286 #ifdef BLKPBSZGET
287 if (ioctl(fd, BLKPBSZGET, blk_size) < 0) {
288 return -errno;
290 return 0;
291 #else
292 return -ENOTSUP;
293 #endif
296 /* Check if read is allowed with given memory buffer and length.
298 * This function is used to check O_DIRECT memory buffer and request alignment.
300 static bool raw_is_io_aligned(int fd, void *buf, size_t len)
302 ssize_t ret = pread(fd, buf, len, 0);
304 if (ret >= 0) {
305 return true;
308 #ifdef __linux__
309 /* The Linux kernel returns EINVAL for misaligned O_DIRECT reads. Ignore
310 * other errors (e.g. real I/O error), which could happen on a failed
311 * drive, since we only care about probing alignment.
313 if (errno != EINVAL) {
314 return true;
316 #endif
318 return false;
321 static void raw_probe_alignment(BlockDriverState *bs, int fd, Error **errp)
323 BDRVRawState *s = bs->opaque;
324 char *buf;
325 size_t max_align = MAX(MAX_BLOCKSIZE, getpagesize());
327 /* For SCSI generic devices the alignment is not really used.
328 With buffered I/O, we don't have any restrictions. */
329 if (bdrv_is_sg(bs) || !s->needs_alignment) {
330 bs->bl.request_alignment = 1;
331 s->buf_align = 1;
332 return;
335 bs->bl.request_alignment = 0;
336 s->buf_align = 0;
337 /* Let's try to use the logical blocksize for the alignment. */
338 if (probe_logical_blocksize(fd, &bs->bl.request_alignment) < 0) {
339 bs->bl.request_alignment = 0;
341 #ifdef CONFIG_XFS
342 if (s->is_xfs) {
343 struct dioattr da;
344 if (xfsctl(NULL, fd, XFS_IOC_DIOINFO, &da) >= 0) {
345 bs->bl.request_alignment = da.d_miniosz;
346 /* The kernel returns wrong information for d_mem */
347 /* s->buf_align = da.d_mem; */
350 #endif
352 /* If we could not get the sizes so far, we can only guess them */
353 if (!s->buf_align) {
354 size_t align;
355 buf = qemu_memalign(max_align, 2 * max_align);
356 for (align = 512; align <= max_align; align <<= 1) {
357 if (raw_is_io_aligned(fd, buf + align, max_align)) {
358 s->buf_align = align;
359 break;
362 qemu_vfree(buf);
365 if (!bs->bl.request_alignment) {
366 size_t align;
367 buf = qemu_memalign(s->buf_align, max_align);
368 for (align = 512; align <= max_align; align <<= 1) {
369 if (raw_is_io_aligned(fd, buf, align)) {
370 bs->bl.request_alignment = align;
371 break;
374 qemu_vfree(buf);
377 if (!s->buf_align || !bs->bl.request_alignment) {
378 error_setg(errp, "Could not find working O_DIRECT alignment");
379 error_append_hint(errp, "Try cache.direct=off\n");
383 static void raw_parse_flags(int bdrv_flags, int *open_flags, bool has_writers)
385 bool read_write = false;
386 assert(open_flags != NULL);
388 *open_flags |= O_BINARY;
389 *open_flags &= ~O_ACCMODE;
391 if (bdrv_flags & BDRV_O_AUTO_RDONLY) {
392 read_write = has_writers;
393 } else if (bdrv_flags & BDRV_O_RDWR) {
394 read_write = true;
397 if (read_write) {
398 *open_flags |= O_RDWR;
399 } else {
400 *open_flags |= O_RDONLY;
403 /* Use O_DSYNC for write-through caching, no flags for write-back caching,
404 * and O_DIRECT for no caching. */
405 if ((bdrv_flags & BDRV_O_NOCACHE)) {
406 *open_flags |= O_DIRECT;
410 static void raw_parse_filename(const char *filename, QDict *options,
411 Error **errp)
413 bdrv_parse_filename_strip_prefix(filename, "file:", options);
416 static QemuOptsList raw_runtime_opts = {
417 .name = "raw",
418 .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
419 .desc = {
421 .name = "filename",
422 .type = QEMU_OPT_STRING,
423 .help = "File name of the image",
426 .name = "aio",
427 .type = QEMU_OPT_STRING,
428 .help = "host AIO implementation (threads, native)",
431 .name = "locking",
432 .type = QEMU_OPT_STRING,
433 .help = "file locking mode (on/off/auto, default: auto)",
436 .name = "pr-manager",
437 .type = QEMU_OPT_STRING,
438 .help = "id of persistent reservation manager object (default: none)",
440 #if defined(__linux__)
442 .name = "drop-cache",
443 .type = QEMU_OPT_BOOL,
444 .help = "invalidate page cache during live migration (default: on)",
446 #endif
448 .name = "x-check-cache-dropped",
449 .type = QEMU_OPT_BOOL,
450 .help = "check that page cache was dropped on live migration (default: off)"
452 { /* end of list */ }
456 static const char *const mutable_opts[] = { "x-check-cache-dropped", NULL };
458 static int raw_open_common(BlockDriverState *bs, QDict *options,
459 int bdrv_flags, int open_flags,
460 bool device, Error **errp)
462 BDRVRawState *s = bs->opaque;
463 QemuOpts *opts;
464 Error *local_err = NULL;
465 const char *filename = NULL;
466 const char *str;
467 BlockdevAioOptions aio, aio_default;
468 int fd, ret;
469 struct stat st;
470 OnOffAuto locking;
472 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
473 qemu_opts_absorb_qdict(opts, options, &local_err);
474 if (local_err) {
475 error_propagate(errp, local_err);
476 ret = -EINVAL;
477 goto fail;
480 filename = qemu_opt_get(opts, "filename");
482 ret = raw_normalize_devicepath(&filename, errp);
483 if (ret != 0) {
484 goto fail;
487 aio_default = (bdrv_flags & BDRV_O_NATIVE_AIO)
488 ? BLOCKDEV_AIO_OPTIONS_NATIVE
489 : BLOCKDEV_AIO_OPTIONS_THREADS;
490 aio = qapi_enum_parse(&BlockdevAioOptions_lookup,
491 qemu_opt_get(opts, "aio"),
492 aio_default, &local_err);
493 if (local_err) {
494 error_propagate(errp, local_err);
495 ret = -EINVAL;
496 goto fail;
498 s->use_linux_aio = (aio == BLOCKDEV_AIO_OPTIONS_NATIVE);
500 locking = qapi_enum_parse(&OnOffAuto_lookup,
501 qemu_opt_get(opts, "locking"),
502 ON_OFF_AUTO_AUTO, &local_err);
503 if (local_err) {
504 error_propagate(errp, local_err);
505 ret = -EINVAL;
506 goto fail;
508 switch (locking) {
509 case ON_OFF_AUTO_ON:
510 s->use_lock = true;
511 if (!qemu_has_ofd_lock()) {
512 warn_report("File lock requested but OFD locking syscall is "
513 "unavailable, falling back to POSIX file locks");
514 error_printf("Due to the implementation, locks can be lost "
515 "unexpectedly.\n");
517 break;
518 case ON_OFF_AUTO_OFF:
519 s->use_lock = false;
520 break;
521 case ON_OFF_AUTO_AUTO:
522 s->use_lock = qemu_has_ofd_lock();
523 break;
524 default:
525 abort();
528 str = qemu_opt_get(opts, "pr-manager");
529 if (str) {
530 s->pr_mgr = pr_manager_lookup(str, &local_err);
531 if (local_err) {
532 error_propagate(errp, local_err);
533 ret = -EINVAL;
534 goto fail;
538 s->drop_cache = qemu_opt_get_bool(opts, "drop-cache", true);
539 s->check_cache_dropped = qemu_opt_get_bool(opts, "x-check-cache-dropped",
540 false);
542 s->open_flags = open_flags;
543 raw_parse_flags(bdrv_flags, &s->open_flags, false);
545 s->fd = -1;
546 fd = qemu_open(filename, s->open_flags, 0644);
547 ret = fd < 0 ? -errno : 0;
549 if (ret < 0) {
550 error_setg_errno(errp, -ret, "Could not open '%s'", filename);
551 if (ret == -EROFS) {
552 ret = -EACCES;
554 goto fail;
556 s->fd = fd;
558 s->perm = 0;
559 s->shared_perm = BLK_PERM_ALL;
561 #ifdef CONFIG_LINUX_AIO
562 /* Currently Linux does AIO only for files opened with O_DIRECT */
563 if (s->use_linux_aio) {
564 if (!(s->open_flags & O_DIRECT)) {
565 error_setg(errp, "aio=native was specified, but it requires "
566 "cache.direct=on, which was not specified.");
567 ret = -EINVAL;
568 goto fail;
570 if (!aio_setup_linux_aio(bdrv_get_aio_context(bs), errp)) {
571 error_prepend(errp, "Unable to use native AIO: ");
572 goto fail;
575 #else
576 if (s->use_linux_aio) {
577 error_setg(errp, "aio=native was specified, but is not supported "
578 "in this build.");
579 ret = -EINVAL;
580 goto fail;
582 #endif /* !defined(CONFIG_LINUX_AIO) */
584 s->has_discard = true;
585 s->has_write_zeroes = true;
586 if ((bs->open_flags & BDRV_O_NOCACHE) != 0) {
587 s->needs_alignment = true;
590 if (fstat(s->fd, &st) < 0) {
591 ret = -errno;
592 error_setg_errno(errp, errno, "Could not stat file");
593 goto fail;
596 if (!device) {
597 if (S_ISBLK(st.st_mode)) {
598 warn_report("Opening a block device as a file using the '%s' "
599 "driver is deprecated", bs->drv->format_name);
600 } else if (S_ISCHR(st.st_mode)) {
601 warn_report("Opening a character device as a file using the '%s' "
602 "driver is deprecated", bs->drv->format_name);
603 } else if (!S_ISREG(st.st_mode)) {
604 error_setg(errp, "A regular file was expected by the '%s' driver, "
605 "but something else was given", bs->drv->format_name);
606 ret = -EINVAL;
607 goto fail;
608 } else {
609 s->discard_zeroes = true;
610 s->has_fallocate = true;
612 } else {
613 if (!(S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
614 error_setg(errp, "'%s' driver expects either "
615 "a character or block device", bs->drv->format_name);
616 ret = -EINVAL;
617 goto fail;
621 if (S_ISBLK(st.st_mode)) {
622 #ifdef BLKDISCARDZEROES
623 unsigned int arg;
624 if (ioctl(s->fd, BLKDISCARDZEROES, &arg) == 0 && arg) {
625 s->discard_zeroes = true;
627 #endif
628 #ifdef __linux__
629 /* On Linux 3.10, BLKDISCARD leaves stale data in the page cache. Do
630 * not rely on the contents of discarded blocks unless using O_DIRECT.
631 * Same for BLKZEROOUT.
633 if (!(bs->open_flags & BDRV_O_NOCACHE)) {
634 s->discard_zeroes = false;
635 s->has_write_zeroes = false;
637 #endif
639 #ifdef __FreeBSD__
640 if (S_ISCHR(st.st_mode)) {
642 * The file is a char device (disk), which on FreeBSD isn't behind
643 * a pager, so force all requests to be aligned. This is needed
644 * so QEMU makes sure all IO operations on the device are aligned
645 * to sector size, or else FreeBSD will reject them with EINVAL.
647 s->needs_alignment = true;
649 #endif
651 #ifdef CONFIG_XFS
652 if (platform_test_xfs_fd(s->fd)) {
653 s->is_xfs = true;
655 #endif
657 bs->supported_zero_flags = BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK;
658 ret = 0;
659 fail:
660 if (filename && (bdrv_flags & BDRV_O_TEMPORARY)) {
661 unlink(filename);
663 qemu_opts_del(opts);
664 return ret;
667 static int raw_open(BlockDriverState *bs, QDict *options, int flags,
668 Error **errp)
670 BDRVRawState *s = bs->opaque;
672 s->type = FTYPE_FILE;
673 return raw_open_common(bs, options, flags, 0, false, errp);
676 typedef enum {
677 RAW_PL_PREPARE,
678 RAW_PL_COMMIT,
679 RAW_PL_ABORT,
680 } RawPermLockOp;
682 #define PERM_FOREACH(i) \
683 for ((i) = 0; (1ULL << (i)) <= BLK_PERM_ALL; i++)
685 /* Lock bytes indicated by @perm_lock_bits and @shared_perm_lock_bits in the
686 * file; if @unlock == true, also unlock the unneeded bytes.
687 * @shared_perm_lock_bits is the mask of all permissions that are NOT shared.
689 static int raw_apply_lock_bytes(BDRVRawState *s, int fd,
690 uint64_t perm_lock_bits,
691 uint64_t shared_perm_lock_bits,
692 bool unlock, Error **errp)
694 int ret;
695 int i;
696 uint64_t locked_perm, locked_shared_perm;
698 if (s) {
699 locked_perm = s->locked_perm;
700 locked_shared_perm = s->locked_shared_perm;
701 } else {
703 * We don't have the previous bits, just lock/unlock for each of the
704 * requested bits.
706 if (unlock) {
707 locked_perm = BLK_PERM_ALL;
708 locked_shared_perm = BLK_PERM_ALL;
709 } else {
710 locked_perm = 0;
711 locked_shared_perm = 0;
715 PERM_FOREACH(i) {
716 int off = RAW_LOCK_PERM_BASE + i;
717 uint64_t bit = (1ULL << i);
718 if ((perm_lock_bits & bit) && !(locked_perm & bit)) {
719 ret = qemu_lock_fd(fd, off, 1, false);
720 if (ret) {
721 error_setg(errp, "Failed to lock byte %d", off);
722 return ret;
723 } else if (s) {
724 s->locked_perm |= bit;
726 } else if (unlock && (locked_perm & bit) && !(perm_lock_bits & bit)) {
727 ret = qemu_unlock_fd(fd, off, 1);
728 if (ret) {
729 error_setg(errp, "Failed to unlock byte %d", off);
730 return ret;
731 } else if (s) {
732 s->locked_perm &= ~bit;
736 PERM_FOREACH(i) {
737 int off = RAW_LOCK_SHARED_BASE + i;
738 uint64_t bit = (1ULL << i);
739 if ((shared_perm_lock_bits & bit) && !(locked_shared_perm & bit)) {
740 ret = qemu_lock_fd(fd, off, 1, false);
741 if (ret) {
742 error_setg(errp, "Failed to lock byte %d", off);
743 return ret;
744 } else if (s) {
745 s->locked_shared_perm |= bit;
747 } else if (unlock && (locked_shared_perm & bit) &&
748 !(shared_perm_lock_bits & bit)) {
749 ret = qemu_unlock_fd(fd, off, 1);
750 if (ret) {
751 error_setg(errp, "Failed to unlock byte %d", off);
752 return ret;
753 } else if (s) {
754 s->locked_shared_perm &= ~bit;
758 return 0;
761 /* Check "unshared" bytes implied by @perm and ~@shared_perm in the file. */
762 static int raw_check_lock_bytes(int fd, uint64_t perm, uint64_t shared_perm,
763 Error **errp)
765 int ret;
766 int i;
768 PERM_FOREACH(i) {
769 int off = RAW_LOCK_SHARED_BASE + i;
770 uint64_t p = 1ULL << i;
771 if (perm & p) {
772 ret = qemu_lock_fd_test(fd, off, 1, true);
773 if (ret) {
774 char *perm_name = bdrv_perm_names(p);
775 error_setg(errp,
776 "Failed to get \"%s\" lock",
777 perm_name);
778 g_free(perm_name);
779 return ret;
783 PERM_FOREACH(i) {
784 int off = RAW_LOCK_PERM_BASE + i;
785 uint64_t p = 1ULL << i;
786 if (!(shared_perm & p)) {
787 ret = qemu_lock_fd_test(fd, off, 1, true);
788 if (ret) {
789 char *perm_name = bdrv_perm_names(p);
790 error_setg(errp,
791 "Failed to get shared \"%s\" lock",
792 perm_name);
793 g_free(perm_name);
794 return ret;
798 return 0;
801 static int raw_handle_perm_lock(BlockDriverState *bs,
802 RawPermLockOp op,
803 uint64_t new_perm, uint64_t new_shared,
804 Error **errp)
806 BDRVRawState *s = bs->opaque;
807 int ret = 0;
808 Error *local_err = NULL;
810 if (!s->use_lock) {
811 return 0;
814 if (bdrv_get_flags(bs) & BDRV_O_INACTIVE) {
815 return 0;
818 switch (op) {
819 case RAW_PL_PREPARE:
820 if ((s->perm | new_perm) == s->perm &&
821 (s->shared_perm & new_shared) == s->shared_perm)
824 * We are going to unlock bytes, it should not fail. If it fail due
825 * to some fs-dependent permission-unrelated reasons (which occurs
826 * sometimes on NFS and leads to abort in bdrv_replace_child) we
827 * can't prevent such errors by any check here. And we ignore them
828 * anyway in ABORT and COMMIT.
830 return 0;
832 ret = raw_apply_lock_bytes(s, s->fd, s->perm | new_perm,
833 ~s->shared_perm | ~new_shared,
834 false, errp);
835 if (!ret) {
836 ret = raw_check_lock_bytes(s->fd, new_perm, new_shared, errp);
837 if (!ret) {
838 return 0;
840 error_append_hint(errp,
841 "Is another process using the image [%s]?\n",
842 bs->filename);
844 op = RAW_PL_ABORT;
845 /* fall through to unlock bytes. */
846 case RAW_PL_ABORT:
847 raw_apply_lock_bytes(s, s->fd, s->perm, ~s->shared_perm,
848 true, &local_err);
849 if (local_err) {
850 /* Theoretically the above call only unlocks bytes and it cannot
851 * fail. Something weird happened, report it.
853 warn_report_err(local_err);
855 break;
856 case RAW_PL_COMMIT:
857 raw_apply_lock_bytes(s, s->fd, new_perm, ~new_shared,
858 true, &local_err);
859 if (local_err) {
860 /* Theoretically the above call only unlocks bytes and it cannot
861 * fail. Something weird happened, report it.
863 warn_report_err(local_err);
865 break;
867 return ret;
870 static int raw_reconfigure_getfd(BlockDriverState *bs, int flags,
871 int *open_flags, uint64_t perm, bool force_dup,
872 Error **errp)
874 BDRVRawState *s = bs->opaque;
875 int fd = -1;
876 int ret;
877 bool has_writers = perm &
878 (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED | BLK_PERM_RESIZE);
879 int fcntl_flags = O_APPEND | O_NONBLOCK;
880 #ifdef O_NOATIME
881 fcntl_flags |= O_NOATIME;
882 #endif
884 *open_flags = 0;
885 if (s->type == FTYPE_CD) {
886 *open_flags |= O_NONBLOCK;
889 raw_parse_flags(flags, open_flags, has_writers);
891 #ifdef O_ASYNC
892 /* Not all operating systems have O_ASYNC, and those that don't
893 * will not let us track the state into rs->open_flags (typically
894 * you achieve the same effect with an ioctl, for example I_SETSIG
895 * on Solaris). But we do not use O_ASYNC, so that's fine.
897 assert((s->open_flags & O_ASYNC) == 0);
898 #endif
900 if (!force_dup && *open_flags == s->open_flags) {
901 /* We're lucky, the existing fd is fine */
902 return s->fd;
905 if ((*open_flags & ~fcntl_flags) == (s->open_flags & ~fcntl_flags)) {
906 /* dup the original fd */
907 fd = qemu_dup(s->fd);
908 if (fd >= 0) {
909 ret = fcntl_setfl(fd, *open_flags);
910 if (ret) {
911 qemu_close(fd);
912 fd = -1;
917 /* If we cannot use fcntl, or fcntl failed, fall back to qemu_open() */
918 if (fd == -1) {
919 const char *normalized_filename = bs->filename;
920 ret = raw_normalize_devicepath(&normalized_filename, errp);
921 if (ret >= 0) {
922 assert(!(*open_flags & O_CREAT));
923 fd = qemu_open(normalized_filename, *open_flags);
924 if (fd == -1) {
925 error_setg_errno(errp, errno, "Could not reopen file");
926 return -1;
931 return fd;
934 static int raw_reopen_prepare(BDRVReopenState *state,
935 BlockReopenQueue *queue, Error **errp)
937 BDRVRawState *s;
938 BDRVRawReopenState *rs;
939 QemuOpts *opts;
940 int ret;
941 Error *local_err = NULL;
943 assert(state != NULL);
944 assert(state->bs != NULL);
946 s = state->bs->opaque;
948 state->opaque = g_new0(BDRVRawReopenState, 1);
949 rs = state->opaque;
951 /* Handle options changes */
952 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
953 qemu_opts_absorb_qdict(opts, state->options, &local_err);
954 if (local_err) {
955 error_propagate(errp, local_err);
956 ret = -EINVAL;
957 goto out;
960 rs->drop_cache = qemu_opt_get_bool_del(opts, "drop-cache", true);
961 rs->check_cache_dropped =
962 qemu_opt_get_bool_del(opts, "x-check-cache-dropped", false);
964 /* This driver's reopen function doesn't currently allow changing
965 * other options, so let's put them back in the original QDict and
966 * bdrv_reopen_prepare() will detect changes and complain. */
967 qemu_opts_to_qdict(opts, state->options);
969 rs->fd = raw_reconfigure_getfd(state->bs, state->flags, &rs->open_flags,
970 state->perm, true, &local_err);
971 if (local_err) {
972 error_propagate(errp, local_err);
973 ret = -1;
974 goto out;
977 /* Fail already reopen_prepare() if we can't get a working O_DIRECT
978 * alignment with the new fd. */
979 if (rs->fd != -1) {
980 raw_probe_alignment(state->bs, rs->fd, &local_err);
981 if (local_err) {
982 error_propagate(errp, local_err);
983 ret = -EINVAL;
984 goto out_fd;
988 s->reopen_state = state;
989 ret = 0;
990 out_fd:
991 if (ret < 0) {
992 qemu_close(rs->fd);
993 rs->fd = -1;
995 out:
996 qemu_opts_del(opts);
997 return ret;
1000 static void raw_reopen_commit(BDRVReopenState *state)
1002 BDRVRawReopenState *rs = state->opaque;
1003 BDRVRawState *s = state->bs->opaque;
1005 s->drop_cache = rs->drop_cache;
1006 s->check_cache_dropped = rs->check_cache_dropped;
1007 s->open_flags = rs->open_flags;
1009 qemu_close(s->fd);
1010 s->fd = rs->fd;
1012 g_free(state->opaque);
1013 state->opaque = NULL;
1015 assert(s->reopen_state == state);
1016 s->reopen_state = NULL;
1020 static void raw_reopen_abort(BDRVReopenState *state)
1022 BDRVRawReopenState *rs = state->opaque;
1023 BDRVRawState *s = state->bs->opaque;
1025 /* nothing to do if NULL, we didn't get far enough */
1026 if (rs == NULL) {
1027 return;
1030 if (rs->fd >= 0) {
1031 qemu_close(rs->fd);
1032 rs->fd = -1;
1034 g_free(state->opaque);
1035 state->opaque = NULL;
1037 assert(s->reopen_state == state);
1038 s->reopen_state = NULL;
1041 static int hdev_get_max_transfer_length(BlockDriverState *bs, int fd)
1043 #ifdef BLKSECTGET
1044 int max_bytes = 0;
1045 short max_sectors = 0;
1046 if (bs->sg && ioctl(fd, BLKSECTGET, &max_bytes) == 0) {
1047 return max_bytes;
1048 } else if (!bs->sg && ioctl(fd, BLKSECTGET, &max_sectors) == 0) {
1049 return max_sectors << BDRV_SECTOR_BITS;
1050 } else {
1051 return -errno;
1053 #else
1054 return -ENOSYS;
1055 #endif
1058 static int hdev_get_max_segments(const struct stat *st)
1060 #ifdef CONFIG_LINUX
1061 char buf[32];
1062 const char *end;
1063 char *sysfspath;
1064 int ret;
1065 int fd = -1;
1066 long max_segments;
1068 sysfspath = g_strdup_printf("/sys/dev/block/%u:%u/queue/max_segments",
1069 major(st->st_rdev), minor(st->st_rdev));
1070 fd = open(sysfspath, O_RDONLY);
1071 if (fd == -1) {
1072 ret = -errno;
1073 goto out;
1075 do {
1076 ret = read(fd, buf, sizeof(buf) - 1);
1077 } while (ret == -1 && errno == EINTR);
1078 if (ret < 0) {
1079 ret = -errno;
1080 goto out;
1081 } else if (ret == 0) {
1082 ret = -EIO;
1083 goto out;
1085 buf[ret] = 0;
1086 /* The file is ended with '\n', pass 'end' to accept that. */
1087 ret = qemu_strtol(buf, &end, 10, &max_segments);
1088 if (ret == 0 && end && *end == '\n') {
1089 ret = max_segments;
1092 out:
1093 if (fd != -1) {
1094 close(fd);
1096 g_free(sysfspath);
1097 return ret;
1098 #else
1099 return -ENOTSUP;
1100 #endif
1103 static void raw_refresh_limits(BlockDriverState *bs, Error **errp)
1105 BDRVRawState *s = bs->opaque;
1106 struct stat st;
1108 if (!fstat(s->fd, &st)) {
1109 if (S_ISBLK(st.st_mode) || S_ISCHR(st.st_mode)) {
1110 int ret = hdev_get_max_transfer_length(bs, s->fd);
1111 if (ret > 0 && ret <= BDRV_REQUEST_MAX_BYTES) {
1112 bs->bl.max_transfer = pow2floor(ret);
1114 ret = hdev_get_max_segments(&st);
1115 if (ret > 0) {
1116 bs->bl.max_transfer = MIN(bs->bl.max_transfer,
1117 ret * getpagesize());
1122 raw_probe_alignment(bs, s->fd, errp);
1123 bs->bl.min_mem_alignment = s->buf_align;
1124 bs->bl.opt_mem_alignment = MAX(s->buf_align, getpagesize());
1127 static int check_for_dasd(int fd)
1129 #ifdef BIODASDINFO2
1130 struct dasd_information2_t info = {0};
1132 return ioctl(fd, BIODASDINFO2, &info);
1133 #else
1134 return -1;
1135 #endif
1139 * Try to get @bs's logical and physical block size.
1140 * On success, store them in @bsz and return zero.
1141 * On failure, return negative errno.
1143 static int hdev_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz)
1145 BDRVRawState *s = bs->opaque;
1146 int ret;
1148 /* If DASD, get blocksizes */
1149 if (check_for_dasd(s->fd) < 0) {
1150 return -ENOTSUP;
1152 ret = probe_logical_blocksize(s->fd, &bsz->log);
1153 if (ret < 0) {
1154 return ret;
1156 return probe_physical_blocksize(s->fd, &bsz->phys);
1160 * Try to get @bs's geometry: cyls, heads, sectors.
1161 * On success, store them in @geo and return 0.
1162 * On failure return -errno.
1163 * (Allows block driver to assign default geometry values that guest sees)
1165 #ifdef __linux__
1166 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1168 BDRVRawState *s = bs->opaque;
1169 struct hd_geometry ioctl_geo = {0};
1171 /* If DASD, get its geometry */
1172 if (check_for_dasd(s->fd) < 0) {
1173 return -ENOTSUP;
1175 if (ioctl(s->fd, HDIO_GETGEO, &ioctl_geo) < 0) {
1176 return -errno;
1178 /* HDIO_GETGEO may return success even though geo contains zeros
1179 (e.g. certain multipath setups) */
1180 if (!ioctl_geo.heads || !ioctl_geo.sectors || !ioctl_geo.cylinders) {
1181 return -ENOTSUP;
1183 /* Do not return a geometry for partition */
1184 if (ioctl_geo.start != 0) {
1185 return -ENOTSUP;
1187 geo->heads = ioctl_geo.heads;
1188 geo->sectors = ioctl_geo.sectors;
1189 geo->cylinders = ioctl_geo.cylinders;
1191 return 0;
1193 #else /* __linux__ */
1194 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1196 return -ENOTSUP;
1198 #endif
1200 #if defined(__linux__)
1201 static int handle_aiocb_ioctl(void *opaque)
1203 RawPosixAIOData *aiocb = opaque;
1204 int ret;
1206 ret = ioctl(aiocb->aio_fildes, aiocb->ioctl.cmd, aiocb->ioctl.buf);
1207 if (ret == -1) {
1208 return -errno;
1211 return 0;
1213 #endif /* linux */
1215 static int handle_aiocb_flush(void *opaque)
1217 RawPosixAIOData *aiocb = opaque;
1218 BDRVRawState *s = aiocb->bs->opaque;
1219 int ret;
1221 if (s->page_cache_inconsistent) {
1222 return -EIO;
1225 ret = qemu_fdatasync(aiocb->aio_fildes);
1226 if (ret == -1) {
1227 /* There is no clear definition of the semantics of a failing fsync(),
1228 * so we may have to assume the worst. The sad truth is that this
1229 * assumption is correct for Linux. Some pages are now probably marked
1230 * clean in the page cache even though they are inconsistent with the
1231 * on-disk contents. The next fdatasync() call would succeed, but no
1232 * further writeback attempt will be made. We can't get back to a state
1233 * in which we know what is on disk (we would have to rewrite
1234 * everything that was touched since the last fdatasync() at least), so
1235 * make bdrv_flush() fail permanently. Given that the behaviour isn't
1236 * really defined, I have little hope that other OSes are doing better.
1238 * Obviously, this doesn't affect O_DIRECT, which bypasses the page
1239 * cache. */
1240 if ((s->open_flags & O_DIRECT) == 0) {
1241 s->page_cache_inconsistent = true;
1243 return -errno;
1245 return 0;
1248 #ifdef CONFIG_PREADV
1250 static bool preadv_present = true;
1252 static ssize_t
1253 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1255 return preadv(fd, iov, nr_iov, offset);
1258 static ssize_t
1259 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1261 return pwritev(fd, iov, nr_iov, offset);
1264 #else
1266 static bool preadv_present = false;
1268 static ssize_t
1269 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1271 return -ENOSYS;
1274 static ssize_t
1275 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1277 return -ENOSYS;
1280 #endif
1282 static ssize_t handle_aiocb_rw_vector(RawPosixAIOData *aiocb)
1284 ssize_t len;
1286 do {
1287 if (aiocb->aio_type & QEMU_AIO_WRITE)
1288 len = qemu_pwritev(aiocb->aio_fildes,
1289 aiocb->io.iov,
1290 aiocb->io.niov,
1291 aiocb->aio_offset);
1292 else
1293 len = qemu_preadv(aiocb->aio_fildes,
1294 aiocb->io.iov,
1295 aiocb->io.niov,
1296 aiocb->aio_offset);
1297 } while (len == -1 && errno == EINTR);
1299 if (len == -1) {
1300 return -errno;
1302 return len;
1306 * Read/writes the data to/from a given linear buffer.
1308 * Returns the number of bytes handles or -errno in case of an error. Short
1309 * reads are only returned if the end of the file is reached.
1311 static ssize_t handle_aiocb_rw_linear(RawPosixAIOData *aiocb, char *buf)
1313 ssize_t offset = 0;
1314 ssize_t len;
1316 while (offset < aiocb->aio_nbytes) {
1317 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1318 len = pwrite(aiocb->aio_fildes,
1319 (const char *)buf + offset,
1320 aiocb->aio_nbytes - offset,
1321 aiocb->aio_offset + offset);
1322 } else {
1323 len = pread(aiocb->aio_fildes,
1324 buf + offset,
1325 aiocb->aio_nbytes - offset,
1326 aiocb->aio_offset + offset);
1328 if (len == -1 && errno == EINTR) {
1329 continue;
1330 } else if (len == -1 && errno == EINVAL &&
1331 (aiocb->bs->open_flags & BDRV_O_NOCACHE) &&
1332 !(aiocb->aio_type & QEMU_AIO_WRITE) &&
1333 offset > 0) {
1334 /* O_DIRECT pread() may fail with EINVAL when offset is unaligned
1335 * after a short read. Assume that O_DIRECT short reads only occur
1336 * at EOF. Therefore this is a short read, not an I/O error.
1338 break;
1339 } else if (len == -1) {
1340 offset = -errno;
1341 break;
1342 } else if (len == 0) {
1343 break;
1345 offset += len;
1348 return offset;
1351 static int handle_aiocb_rw(void *opaque)
1353 RawPosixAIOData *aiocb = opaque;
1354 ssize_t nbytes;
1355 char *buf;
1357 if (!(aiocb->aio_type & QEMU_AIO_MISALIGNED)) {
1359 * If there is just a single buffer, and it is properly aligned
1360 * we can just use plain pread/pwrite without any problems.
1362 if (aiocb->io.niov == 1) {
1363 nbytes = handle_aiocb_rw_linear(aiocb, aiocb->io.iov->iov_base);
1364 goto out;
1367 * We have more than one iovec, and all are properly aligned.
1369 * Try preadv/pwritev first and fall back to linearizing the
1370 * buffer if it's not supported.
1372 if (preadv_present) {
1373 nbytes = handle_aiocb_rw_vector(aiocb);
1374 if (nbytes == aiocb->aio_nbytes ||
1375 (nbytes < 0 && nbytes != -ENOSYS)) {
1376 goto out;
1378 preadv_present = false;
1382 * XXX(hch): short read/write. no easy way to handle the reminder
1383 * using these interfaces. For now retry using plain
1384 * pread/pwrite?
1389 * Ok, we have to do it the hard way, copy all segments into
1390 * a single aligned buffer.
1392 buf = qemu_try_blockalign(aiocb->bs, aiocb->aio_nbytes);
1393 if (buf == NULL) {
1394 nbytes = -ENOMEM;
1395 goto out;
1398 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1399 char *p = buf;
1400 int i;
1402 for (i = 0; i < aiocb->io.niov; ++i) {
1403 memcpy(p, aiocb->io.iov[i].iov_base, aiocb->io.iov[i].iov_len);
1404 p += aiocb->io.iov[i].iov_len;
1406 assert(p - buf == aiocb->aio_nbytes);
1409 nbytes = handle_aiocb_rw_linear(aiocb, buf);
1410 if (!(aiocb->aio_type & QEMU_AIO_WRITE)) {
1411 char *p = buf;
1412 size_t count = aiocb->aio_nbytes, copy;
1413 int i;
1415 for (i = 0; i < aiocb->io.niov && count; ++i) {
1416 copy = count;
1417 if (copy > aiocb->io.iov[i].iov_len) {
1418 copy = aiocb->io.iov[i].iov_len;
1420 memcpy(aiocb->io.iov[i].iov_base, p, copy);
1421 assert(count >= copy);
1422 p += copy;
1423 count -= copy;
1425 assert(count == 0);
1427 qemu_vfree(buf);
1429 out:
1430 if (nbytes == aiocb->aio_nbytes) {
1431 return 0;
1432 } else if (nbytes >= 0 && nbytes < aiocb->aio_nbytes) {
1433 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1434 return -EINVAL;
1435 } else {
1436 iov_memset(aiocb->io.iov, aiocb->io.niov, nbytes,
1437 0, aiocb->aio_nbytes - nbytes);
1438 return 0;
1440 } else {
1441 assert(nbytes < 0);
1442 return nbytes;
1446 #ifdef CONFIG_XFS
1447 static int xfs_write_zeroes(BDRVRawState *s, int64_t offset, uint64_t bytes)
1449 int64_t len;
1450 struct xfs_flock64 fl;
1451 int err;
1453 len = lseek(s->fd, 0, SEEK_END);
1454 if (len < 0) {
1455 return -errno;
1458 if (offset + bytes > len) {
1459 /* XFS_IOC_ZERO_RANGE does not increase the file length */
1460 if (ftruncate(s->fd, offset + bytes) < 0) {
1461 return -errno;
1465 memset(&fl, 0, sizeof(fl));
1466 fl.l_whence = SEEK_SET;
1467 fl.l_start = offset;
1468 fl.l_len = bytes;
1470 if (xfsctl(NULL, s->fd, XFS_IOC_ZERO_RANGE, &fl) < 0) {
1471 err = errno;
1472 trace_file_xfs_write_zeroes(strerror(errno));
1473 return -err;
1476 return 0;
1479 static int xfs_discard(BDRVRawState *s, int64_t offset, uint64_t bytes)
1481 struct xfs_flock64 fl;
1482 int err;
1484 memset(&fl, 0, sizeof(fl));
1485 fl.l_whence = SEEK_SET;
1486 fl.l_start = offset;
1487 fl.l_len = bytes;
1489 if (xfsctl(NULL, s->fd, XFS_IOC_UNRESVSP64, &fl) < 0) {
1490 err = errno;
1491 trace_file_xfs_discard(strerror(errno));
1492 return -err;
1495 return 0;
1497 #endif
1499 static int translate_err(int err)
1501 if (err == -ENODEV || err == -ENOSYS || err == -EOPNOTSUPP ||
1502 err == -ENOTTY) {
1503 err = -ENOTSUP;
1505 return err;
1508 #ifdef CONFIG_FALLOCATE
1509 static int do_fallocate(int fd, int mode, off_t offset, off_t len)
1511 do {
1512 if (fallocate(fd, mode, offset, len) == 0) {
1513 return 0;
1515 } while (errno == EINTR);
1516 return translate_err(-errno);
1518 #endif
1520 static ssize_t handle_aiocb_write_zeroes_block(RawPosixAIOData *aiocb)
1522 int ret = -ENOTSUP;
1523 BDRVRawState *s = aiocb->bs->opaque;
1525 if (!s->has_write_zeroes) {
1526 return -ENOTSUP;
1529 #ifdef BLKZEROOUT
1530 /* The BLKZEROOUT implementation in the kernel doesn't set
1531 * BLKDEV_ZERO_NOFALLBACK, so we can't call this if we have to avoid slow
1532 * fallbacks. */
1533 if (!(aiocb->aio_type & QEMU_AIO_NO_FALLBACK)) {
1534 do {
1535 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1536 if (ioctl(aiocb->aio_fildes, BLKZEROOUT, range) == 0) {
1537 return 0;
1539 } while (errno == EINTR);
1541 ret = translate_err(-errno);
1543 #endif
1545 if (ret == -ENOTSUP) {
1546 s->has_write_zeroes = false;
1548 return ret;
1551 static int handle_aiocb_write_zeroes(void *opaque)
1553 RawPosixAIOData *aiocb = opaque;
1554 #if defined(CONFIG_FALLOCATE) || defined(CONFIG_XFS)
1555 BDRVRawState *s = aiocb->bs->opaque;
1556 #endif
1557 #ifdef CONFIG_FALLOCATE
1558 int64_t len;
1559 #endif
1561 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1562 return handle_aiocb_write_zeroes_block(aiocb);
1565 #ifdef CONFIG_XFS
1566 if (s->is_xfs) {
1567 return xfs_write_zeroes(s, aiocb->aio_offset, aiocb->aio_nbytes);
1569 #endif
1571 #ifdef CONFIG_FALLOCATE_ZERO_RANGE
1572 if (s->has_write_zeroes) {
1573 int ret = do_fallocate(s->fd, FALLOC_FL_ZERO_RANGE,
1574 aiocb->aio_offset, aiocb->aio_nbytes);
1575 if (ret == 0 || ret != -ENOTSUP) {
1576 return ret;
1578 s->has_write_zeroes = false;
1580 #endif
1582 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1583 if (s->has_discard && s->has_fallocate) {
1584 int ret = do_fallocate(s->fd,
1585 FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1586 aiocb->aio_offset, aiocb->aio_nbytes);
1587 if (ret == 0) {
1588 ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1589 if (ret == 0 || ret != -ENOTSUP) {
1590 return ret;
1592 s->has_fallocate = false;
1593 } else if (ret != -ENOTSUP) {
1594 return ret;
1595 } else {
1596 s->has_discard = false;
1599 #endif
1601 #ifdef CONFIG_FALLOCATE
1602 /* Last resort: we are trying to extend the file with zeroed data. This
1603 * can be done via fallocate(fd, 0) */
1604 len = bdrv_getlength(aiocb->bs);
1605 if (s->has_fallocate && len >= 0 && aiocb->aio_offset >= len) {
1606 int ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1607 if (ret == 0 || ret != -ENOTSUP) {
1608 return ret;
1610 s->has_fallocate = false;
1612 #endif
1614 return -ENOTSUP;
1617 static int handle_aiocb_write_zeroes_unmap(void *opaque)
1619 RawPosixAIOData *aiocb = opaque;
1620 BDRVRawState *s G_GNUC_UNUSED = aiocb->bs->opaque;
1621 int ret;
1623 /* First try to write zeros and unmap at the same time */
1625 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1626 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1627 aiocb->aio_offset, aiocb->aio_nbytes);
1628 if (ret != -ENOTSUP) {
1629 return ret;
1631 #endif
1633 #ifdef CONFIG_XFS
1634 if (s->is_xfs) {
1635 /* xfs_discard() guarantees that the discarded area reads as all-zero
1636 * afterwards, so we can use it here. */
1637 return xfs_discard(s, aiocb->aio_offset, aiocb->aio_nbytes);
1639 #endif
1641 /* If we couldn't manage to unmap while guaranteed that the area reads as
1642 * all-zero afterwards, just write zeroes without unmapping */
1643 ret = handle_aiocb_write_zeroes(aiocb);
1644 return ret;
1647 #ifndef HAVE_COPY_FILE_RANGE
1648 static off_t copy_file_range(int in_fd, off_t *in_off, int out_fd,
1649 off_t *out_off, size_t len, unsigned int flags)
1651 #ifdef __NR_copy_file_range
1652 return syscall(__NR_copy_file_range, in_fd, in_off, out_fd,
1653 out_off, len, flags);
1654 #else
1655 errno = ENOSYS;
1656 return -1;
1657 #endif
1659 #endif
1661 static int handle_aiocb_copy_range(void *opaque)
1663 RawPosixAIOData *aiocb = opaque;
1664 uint64_t bytes = aiocb->aio_nbytes;
1665 off_t in_off = aiocb->aio_offset;
1666 off_t out_off = aiocb->copy_range.aio_offset2;
1668 while (bytes) {
1669 ssize_t ret = copy_file_range(aiocb->aio_fildes, &in_off,
1670 aiocb->copy_range.aio_fd2, &out_off,
1671 bytes, 0);
1672 trace_file_copy_file_range(aiocb->bs, aiocb->aio_fildes, in_off,
1673 aiocb->copy_range.aio_fd2, out_off, bytes,
1674 0, ret);
1675 if (ret == 0) {
1676 /* No progress (e.g. when beyond EOF), let the caller fall back to
1677 * buffer I/O. */
1678 return -ENOSPC;
1680 if (ret < 0) {
1681 switch (errno) {
1682 case ENOSYS:
1683 return -ENOTSUP;
1684 case EINTR:
1685 continue;
1686 default:
1687 return -errno;
1690 bytes -= ret;
1692 return 0;
1695 static int handle_aiocb_discard(void *opaque)
1697 RawPosixAIOData *aiocb = opaque;
1698 int ret = -EOPNOTSUPP;
1699 BDRVRawState *s = aiocb->bs->opaque;
1701 if (!s->has_discard) {
1702 return -ENOTSUP;
1705 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1706 #ifdef BLKDISCARD
1707 do {
1708 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1709 if (ioctl(aiocb->aio_fildes, BLKDISCARD, range) == 0) {
1710 return 0;
1712 } while (errno == EINTR);
1714 ret = -errno;
1715 #endif
1716 } else {
1717 #ifdef CONFIG_XFS
1718 if (s->is_xfs) {
1719 return xfs_discard(s, aiocb->aio_offset, aiocb->aio_nbytes);
1721 #endif
1723 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1724 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1725 aiocb->aio_offset, aiocb->aio_nbytes);
1726 #endif
1729 ret = translate_err(ret);
1730 if (ret == -ENOTSUP) {
1731 s->has_discard = false;
1733 return ret;
1736 static int handle_aiocb_truncate(void *opaque)
1738 RawPosixAIOData *aiocb = opaque;
1739 int result = 0;
1740 int64_t current_length = 0;
1741 char *buf = NULL;
1742 struct stat st;
1743 int fd = aiocb->aio_fildes;
1744 int64_t offset = aiocb->aio_offset;
1745 PreallocMode prealloc = aiocb->truncate.prealloc;
1746 Error **errp = aiocb->truncate.errp;
1748 if (fstat(fd, &st) < 0) {
1749 result = -errno;
1750 error_setg_errno(errp, -result, "Could not stat file");
1751 return result;
1754 current_length = st.st_size;
1755 if (current_length > offset && prealloc != PREALLOC_MODE_OFF) {
1756 error_setg(errp, "Cannot use preallocation for shrinking files");
1757 return -ENOTSUP;
1760 switch (prealloc) {
1761 #ifdef CONFIG_POSIX_FALLOCATE
1762 case PREALLOC_MODE_FALLOC:
1764 * Truncating before posix_fallocate() makes it about twice slower on
1765 * file systems that do not support fallocate(), trying to check if a
1766 * block is allocated before allocating it, so don't do that here.
1768 if (offset != current_length) {
1769 result = -posix_fallocate(fd, current_length,
1770 offset - current_length);
1771 if (result != 0) {
1772 /* posix_fallocate() doesn't set errno. */
1773 error_setg_errno(errp, -result,
1774 "Could not preallocate new data");
1776 } else {
1777 result = 0;
1779 goto out;
1780 #endif
1781 case PREALLOC_MODE_FULL:
1783 int64_t num = 0, left = offset - current_length;
1784 off_t seek_result;
1787 * Knowing the final size from the beginning could allow the file
1788 * system driver to do less allocations and possibly avoid
1789 * fragmentation of the file.
1791 if (ftruncate(fd, offset) != 0) {
1792 result = -errno;
1793 error_setg_errno(errp, -result, "Could not resize file");
1794 goto out;
1797 buf = g_malloc0(65536);
1799 seek_result = lseek(fd, current_length, SEEK_SET);
1800 if (seek_result < 0) {
1801 result = -errno;
1802 error_setg_errno(errp, -result,
1803 "Failed to seek to the old end of file");
1804 goto out;
1807 while (left > 0) {
1808 num = MIN(left, 65536);
1809 result = write(fd, buf, num);
1810 if (result < 0) {
1811 if (errno == EINTR) {
1812 continue;
1814 result = -errno;
1815 error_setg_errno(errp, -result,
1816 "Could not write zeros for preallocation");
1817 goto out;
1819 left -= result;
1821 if (result >= 0) {
1822 result = fsync(fd);
1823 if (result < 0) {
1824 result = -errno;
1825 error_setg_errno(errp, -result,
1826 "Could not flush file to disk");
1827 goto out;
1830 goto out;
1832 case PREALLOC_MODE_OFF:
1833 if (ftruncate(fd, offset) != 0) {
1834 result = -errno;
1835 error_setg_errno(errp, -result, "Could not resize file");
1837 return result;
1838 default:
1839 result = -ENOTSUP;
1840 error_setg(errp, "Unsupported preallocation mode: %s",
1841 PreallocMode_str(prealloc));
1842 return result;
1845 out:
1846 if (result < 0) {
1847 if (ftruncate(fd, current_length) < 0) {
1848 error_report("Failed to restore old file length: %s",
1849 strerror(errno));
1853 g_free(buf);
1854 return result;
1857 static int coroutine_fn raw_thread_pool_submit(BlockDriverState *bs,
1858 ThreadPoolFunc func, void *arg)
1860 /* @bs can be NULL, bdrv_get_aio_context() returns the main context then */
1861 ThreadPool *pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
1862 return thread_pool_submit_co(pool, func, arg);
1865 static int coroutine_fn raw_co_prw(BlockDriverState *bs, uint64_t offset,
1866 uint64_t bytes, QEMUIOVector *qiov, int type)
1868 BDRVRawState *s = bs->opaque;
1869 RawPosixAIOData acb;
1871 if (fd_open(bs) < 0)
1872 return -EIO;
1875 * Check if the underlying device requires requests to be aligned,
1876 * and if the request we are trying to submit is aligned or not.
1877 * If this is the case tell the low-level driver that it needs
1878 * to copy the buffer.
1880 if (s->needs_alignment) {
1881 if (!bdrv_qiov_is_aligned(bs, qiov)) {
1882 type |= QEMU_AIO_MISALIGNED;
1883 #ifdef CONFIG_LINUX_AIO
1884 } else if (s->use_linux_aio) {
1885 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1886 assert(qiov->size == bytes);
1887 return laio_co_submit(bs, aio, s->fd, offset, qiov, type);
1888 #endif
1892 acb = (RawPosixAIOData) {
1893 .bs = bs,
1894 .aio_fildes = s->fd,
1895 .aio_type = type,
1896 .aio_offset = offset,
1897 .aio_nbytes = bytes,
1898 .io = {
1899 .iov = qiov->iov,
1900 .niov = qiov->niov,
1904 assert(qiov->size == bytes);
1905 return raw_thread_pool_submit(bs, handle_aiocb_rw, &acb);
1908 static int coroutine_fn raw_co_preadv(BlockDriverState *bs, uint64_t offset,
1909 uint64_t bytes, QEMUIOVector *qiov,
1910 int flags)
1912 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_READ);
1915 static int coroutine_fn raw_co_pwritev(BlockDriverState *bs, uint64_t offset,
1916 uint64_t bytes, QEMUIOVector *qiov,
1917 int flags)
1919 assert(flags == 0);
1920 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_WRITE);
1923 static void raw_aio_plug(BlockDriverState *bs)
1925 #ifdef CONFIG_LINUX_AIO
1926 BDRVRawState *s = bs->opaque;
1927 if (s->use_linux_aio) {
1928 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1929 laio_io_plug(bs, aio);
1931 #endif
1934 static void raw_aio_unplug(BlockDriverState *bs)
1936 #ifdef CONFIG_LINUX_AIO
1937 BDRVRawState *s = bs->opaque;
1938 if (s->use_linux_aio) {
1939 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1940 laio_io_unplug(bs, aio);
1942 #endif
1945 static int raw_co_flush_to_disk(BlockDriverState *bs)
1947 BDRVRawState *s = bs->opaque;
1948 RawPosixAIOData acb;
1949 int ret;
1951 ret = fd_open(bs);
1952 if (ret < 0) {
1953 return ret;
1956 acb = (RawPosixAIOData) {
1957 .bs = bs,
1958 .aio_fildes = s->fd,
1959 .aio_type = QEMU_AIO_FLUSH,
1962 return raw_thread_pool_submit(bs, handle_aiocb_flush, &acb);
1965 static void raw_aio_attach_aio_context(BlockDriverState *bs,
1966 AioContext *new_context)
1968 #ifdef CONFIG_LINUX_AIO
1969 BDRVRawState *s = bs->opaque;
1970 if (s->use_linux_aio) {
1971 Error *local_err;
1972 if (!aio_setup_linux_aio(new_context, &local_err)) {
1973 error_reportf_err(local_err, "Unable to use native AIO, "
1974 "falling back to thread pool: ");
1975 s->use_linux_aio = false;
1978 #endif
1981 static void raw_close(BlockDriverState *bs)
1983 BDRVRawState *s = bs->opaque;
1985 if (s->fd >= 0) {
1986 qemu_close(s->fd);
1987 s->fd = -1;
1992 * Truncates the given regular file @fd to @offset and, when growing, fills the
1993 * new space according to @prealloc.
1995 * Returns: 0 on success, -errno on failure.
1997 static int coroutine_fn
1998 raw_regular_truncate(BlockDriverState *bs, int fd, int64_t offset,
1999 PreallocMode prealloc, Error **errp)
2001 RawPosixAIOData acb;
2003 acb = (RawPosixAIOData) {
2004 .bs = bs,
2005 .aio_fildes = fd,
2006 .aio_type = QEMU_AIO_TRUNCATE,
2007 .aio_offset = offset,
2008 .truncate = {
2009 .prealloc = prealloc,
2010 .errp = errp,
2014 return raw_thread_pool_submit(bs, handle_aiocb_truncate, &acb);
2017 static int coroutine_fn raw_co_truncate(BlockDriverState *bs, int64_t offset,
2018 PreallocMode prealloc, Error **errp)
2020 BDRVRawState *s = bs->opaque;
2021 struct stat st;
2022 int ret;
2024 if (fstat(s->fd, &st)) {
2025 ret = -errno;
2026 error_setg_errno(errp, -ret, "Failed to fstat() the file");
2027 return ret;
2030 if (S_ISREG(st.st_mode)) {
2031 return raw_regular_truncate(bs, s->fd, offset, prealloc, errp);
2034 if (prealloc != PREALLOC_MODE_OFF) {
2035 error_setg(errp, "Preallocation mode '%s' unsupported for this "
2036 "non-regular file", PreallocMode_str(prealloc));
2037 return -ENOTSUP;
2040 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2041 if (offset > raw_getlength(bs)) {
2042 error_setg(errp, "Cannot grow device files");
2043 return -EINVAL;
2045 } else {
2046 error_setg(errp, "Resizing this file is not supported");
2047 return -ENOTSUP;
2050 return 0;
2053 #ifdef __OpenBSD__
2054 static int64_t raw_getlength(BlockDriverState *bs)
2056 BDRVRawState *s = bs->opaque;
2057 int fd = s->fd;
2058 struct stat st;
2060 if (fstat(fd, &st))
2061 return -errno;
2062 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2063 struct disklabel dl;
2065 if (ioctl(fd, DIOCGDINFO, &dl))
2066 return -errno;
2067 return (uint64_t)dl.d_secsize *
2068 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2069 } else
2070 return st.st_size;
2072 #elif defined(__NetBSD__)
2073 static int64_t raw_getlength(BlockDriverState *bs)
2075 BDRVRawState *s = bs->opaque;
2076 int fd = s->fd;
2077 struct stat st;
2079 if (fstat(fd, &st))
2080 return -errno;
2081 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2082 struct dkwedge_info dkw;
2084 if (ioctl(fd, DIOCGWEDGEINFO, &dkw) != -1) {
2085 return dkw.dkw_size * 512;
2086 } else {
2087 struct disklabel dl;
2089 if (ioctl(fd, DIOCGDINFO, &dl))
2090 return -errno;
2091 return (uint64_t)dl.d_secsize *
2092 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2094 } else
2095 return st.st_size;
2097 #elif defined(__sun__)
2098 static int64_t raw_getlength(BlockDriverState *bs)
2100 BDRVRawState *s = bs->opaque;
2101 struct dk_minfo minfo;
2102 int ret;
2103 int64_t size;
2105 ret = fd_open(bs);
2106 if (ret < 0) {
2107 return ret;
2111 * Use the DKIOCGMEDIAINFO ioctl to read the size.
2113 ret = ioctl(s->fd, DKIOCGMEDIAINFO, &minfo);
2114 if (ret != -1) {
2115 return minfo.dki_lbsize * minfo.dki_capacity;
2119 * There are reports that lseek on some devices fails, but
2120 * irc discussion said that contingency on contingency was overkill.
2122 size = lseek(s->fd, 0, SEEK_END);
2123 if (size < 0) {
2124 return -errno;
2126 return size;
2128 #elif defined(CONFIG_BSD)
2129 static int64_t raw_getlength(BlockDriverState *bs)
2131 BDRVRawState *s = bs->opaque;
2132 int fd = s->fd;
2133 int64_t size;
2134 struct stat sb;
2135 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2136 int reopened = 0;
2137 #endif
2138 int ret;
2140 ret = fd_open(bs);
2141 if (ret < 0)
2142 return ret;
2144 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2145 again:
2146 #endif
2147 if (!fstat(fd, &sb) && (S_IFCHR & sb.st_mode)) {
2148 #ifdef DIOCGMEDIASIZE
2149 if (ioctl(fd, DIOCGMEDIASIZE, (off_t *)&size))
2150 #elif defined(DIOCGPART)
2152 struct partinfo pi;
2153 if (ioctl(fd, DIOCGPART, &pi) == 0)
2154 size = pi.media_size;
2155 else
2156 size = 0;
2158 if (size == 0)
2159 #endif
2160 #if defined(__APPLE__) && defined(__MACH__)
2162 uint64_t sectors = 0;
2163 uint32_t sector_size = 0;
2165 if (ioctl(fd, DKIOCGETBLOCKCOUNT, &sectors) == 0
2166 && ioctl(fd, DKIOCGETBLOCKSIZE, &sector_size) == 0) {
2167 size = sectors * sector_size;
2168 } else {
2169 size = lseek(fd, 0LL, SEEK_END);
2170 if (size < 0) {
2171 return -errno;
2175 #else
2176 size = lseek(fd, 0LL, SEEK_END);
2177 if (size < 0) {
2178 return -errno;
2180 #endif
2181 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
2182 switch(s->type) {
2183 case FTYPE_CD:
2184 /* XXX FreeBSD acd returns UINT_MAX sectors for an empty drive */
2185 if (size == 2048LL * (unsigned)-1)
2186 size = 0;
2187 /* XXX no disc? maybe we need to reopen... */
2188 if (size <= 0 && !reopened && cdrom_reopen(bs) >= 0) {
2189 reopened = 1;
2190 goto again;
2193 #endif
2194 } else {
2195 size = lseek(fd, 0, SEEK_END);
2196 if (size < 0) {
2197 return -errno;
2200 return size;
2202 #else
2203 static int64_t raw_getlength(BlockDriverState *bs)
2205 BDRVRawState *s = bs->opaque;
2206 int ret;
2207 int64_t size;
2209 ret = fd_open(bs);
2210 if (ret < 0) {
2211 return ret;
2214 size = lseek(s->fd, 0, SEEK_END);
2215 if (size < 0) {
2216 return -errno;
2218 return size;
2220 #endif
2222 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
2224 struct stat st;
2225 BDRVRawState *s = bs->opaque;
2227 if (fstat(s->fd, &st) < 0) {
2228 return -errno;
2230 return (int64_t)st.st_blocks * 512;
2233 static int coroutine_fn
2234 raw_co_create(BlockdevCreateOptions *options, Error **errp)
2236 BlockdevCreateOptionsFile *file_opts;
2237 Error *local_err = NULL;
2238 int fd;
2239 uint64_t perm, shared;
2240 int result = 0;
2242 /* Validate options and set default values */
2243 assert(options->driver == BLOCKDEV_DRIVER_FILE);
2244 file_opts = &options->u.file;
2246 if (!file_opts->has_nocow) {
2247 file_opts->nocow = false;
2249 if (!file_opts->has_preallocation) {
2250 file_opts->preallocation = PREALLOC_MODE_OFF;
2253 /* Create file */
2254 fd = qemu_open(file_opts->filename, O_RDWR | O_CREAT | O_BINARY, 0644);
2255 if (fd < 0) {
2256 result = -errno;
2257 error_setg_errno(errp, -result, "Could not create file");
2258 goto out;
2261 /* Take permissions: We want to discard everything, so we need
2262 * BLK_PERM_WRITE; and truncation to the desired size requires
2263 * BLK_PERM_RESIZE.
2264 * On the other hand, we cannot share the RESIZE permission
2265 * because we promise that after this function, the file has the
2266 * size given in the options. If someone else were to resize it
2267 * concurrently, we could not guarantee that.
2268 * Note that after this function, we can no longer guarantee that
2269 * the file is not touched by a third party, so it may be resized
2270 * then. */
2271 perm = BLK_PERM_WRITE | BLK_PERM_RESIZE;
2272 shared = BLK_PERM_ALL & ~BLK_PERM_RESIZE;
2274 /* Step one: Take locks */
2275 result = raw_apply_lock_bytes(NULL, fd, perm, ~shared, false, errp);
2276 if (result < 0) {
2277 goto out_close;
2280 /* Step two: Check that nobody else has taken conflicting locks */
2281 result = raw_check_lock_bytes(fd, perm, shared, errp);
2282 if (result < 0) {
2283 error_append_hint(errp,
2284 "Is another process using the image [%s]?\n",
2285 file_opts->filename);
2286 goto out_unlock;
2289 /* Clear the file by truncating it to 0 */
2290 result = raw_regular_truncate(NULL, fd, 0, PREALLOC_MODE_OFF, errp);
2291 if (result < 0) {
2292 goto out_unlock;
2295 if (file_opts->nocow) {
2296 #ifdef __linux__
2297 /* Set NOCOW flag to solve performance issue on fs like btrfs.
2298 * This is an optimisation. The FS_IOC_SETFLAGS ioctl return value
2299 * will be ignored since any failure of this operation should not
2300 * block the left work.
2302 int attr;
2303 if (ioctl(fd, FS_IOC_GETFLAGS, &attr) == 0) {
2304 attr |= FS_NOCOW_FL;
2305 ioctl(fd, FS_IOC_SETFLAGS, &attr);
2307 #endif
2310 /* Resize and potentially preallocate the file to the desired
2311 * final size */
2312 result = raw_regular_truncate(NULL, fd, file_opts->size,
2313 file_opts->preallocation, errp);
2314 if (result < 0) {
2315 goto out_unlock;
2318 out_unlock:
2319 raw_apply_lock_bytes(NULL, fd, 0, 0, true, &local_err);
2320 if (local_err) {
2321 /* The above call should not fail, and if it does, that does
2322 * not mean the whole creation operation has failed. So
2323 * report it the user for their convenience, but do not report
2324 * it to the caller. */
2325 warn_report_err(local_err);
2328 out_close:
2329 if (qemu_close(fd) != 0 && result == 0) {
2330 result = -errno;
2331 error_setg_errno(errp, -result, "Could not close the new file");
2333 out:
2334 return result;
2337 static int coroutine_fn raw_co_create_opts(const char *filename, QemuOpts *opts,
2338 Error **errp)
2340 BlockdevCreateOptions options;
2341 int64_t total_size = 0;
2342 bool nocow = false;
2343 PreallocMode prealloc;
2344 char *buf = NULL;
2345 Error *local_err = NULL;
2347 /* Skip file: protocol prefix */
2348 strstart(filename, "file:", &filename);
2350 /* Read out options */
2351 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2352 BDRV_SECTOR_SIZE);
2353 nocow = qemu_opt_get_bool(opts, BLOCK_OPT_NOCOW, false);
2354 buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
2355 prealloc = qapi_enum_parse(&PreallocMode_lookup, buf,
2356 PREALLOC_MODE_OFF, &local_err);
2357 g_free(buf);
2358 if (local_err) {
2359 error_propagate(errp, local_err);
2360 return -EINVAL;
2363 options = (BlockdevCreateOptions) {
2364 .driver = BLOCKDEV_DRIVER_FILE,
2365 .u.file = {
2366 .filename = (char *) filename,
2367 .size = total_size,
2368 .has_preallocation = true,
2369 .preallocation = prealloc,
2370 .has_nocow = true,
2371 .nocow = nocow,
2374 return raw_co_create(&options, errp);
2378 * Find allocation range in @bs around offset @start.
2379 * May change underlying file descriptor's file offset.
2380 * If @start is not in a hole, store @start in @data, and the
2381 * beginning of the next hole in @hole, and return 0.
2382 * If @start is in a non-trailing hole, store @start in @hole and the
2383 * beginning of the next non-hole in @data, and return 0.
2384 * If @start is in a trailing hole or beyond EOF, return -ENXIO.
2385 * If we can't find out, return a negative errno other than -ENXIO.
2387 static int find_allocation(BlockDriverState *bs, off_t start,
2388 off_t *data, off_t *hole)
2390 #if defined SEEK_HOLE && defined SEEK_DATA
2391 BDRVRawState *s = bs->opaque;
2392 off_t offs;
2395 * SEEK_DATA cases:
2396 * D1. offs == start: start is in data
2397 * D2. offs > start: start is in a hole, next data at offs
2398 * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
2399 * or start is beyond EOF
2400 * If the latter happens, the file has been truncated behind
2401 * our back since we opened it. All bets are off then.
2402 * Treating like a trailing hole is simplest.
2403 * D4. offs < 0, errno != ENXIO: we learned nothing
2405 offs = lseek(s->fd, start, SEEK_DATA);
2406 if (offs < 0) {
2407 return -errno; /* D3 or D4 */
2410 if (offs < start) {
2411 /* This is not a valid return by lseek(). We are safe to just return
2412 * -EIO in this case, and we'll treat it like D4. */
2413 return -EIO;
2416 if (offs > start) {
2417 /* D2: in hole, next data at offs */
2418 *hole = start;
2419 *data = offs;
2420 return 0;
2423 /* D1: in data, end not yet known */
2426 * SEEK_HOLE cases:
2427 * H1. offs == start: start is in a hole
2428 * If this happens here, a hole has been dug behind our back
2429 * since the previous lseek().
2430 * H2. offs > start: either start is in data, next hole at offs,
2431 * or start is in trailing hole, EOF at offs
2432 * Linux treats trailing holes like any other hole: offs ==
2433 * start. Solaris seeks to EOF instead: offs > start (blech).
2434 * If that happens here, a hole has been dug behind our back
2435 * since the previous lseek().
2436 * H3. offs < 0, errno = ENXIO: start is beyond EOF
2437 * If this happens, the file has been truncated behind our
2438 * back since we opened it. Treat it like a trailing hole.
2439 * H4. offs < 0, errno != ENXIO: we learned nothing
2440 * Pretend we know nothing at all, i.e. "forget" about D1.
2442 offs = lseek(s->fd, start, SEEK_HOLE);
2443 if (offs < 0) {
2444 return -errno; /* D1 and (H3 or H4) */
2447 if (offs < start) {
2448 /* This is not a valid return by lseek(). We are safe to just return
2449 * -EIO in this case, and we'll treat it like H4. */
2450 return -EIO;
2453 if (offs > start) {
2455 * D1 and H2: either in data, next hole at offs, or it was in
2456 * data but is now in a trailing hole. In the latter case,
2457 * all bets are off. Treating it as if it there was data all
2458 * the way to EOF is safe, so simply do that.
2460 *data = start;
2461 *hole = offs;
2462 return 0;
2465 /* D1 and H1 */
2466 return -EBUSY;
2467 #else
2468 return -ENOTSUP;
2469 #endif
2473 * Returns the allocation status of the specified offset.
2475 * The block layer guarantees 'offset' and 'bytes' are within bounds.
2477 * 'pnum' is set to the number of bytes (including and immediately following
2478 * the specified offset) that are known to be in the same
2479 * allocated/unallocated state.
2481 * 'bytes' is the max value 'pnum' should be set to.
2483 static int coroutine_fn raw_co_block_status(BlockDriverState *bs,
2484 bool want_zero,
2485 int64_t offset,
2486 int64_t bytes, int64_t *pnum,
2487 int64_t *map,
2488 BlockDriverState **file)
2490 off_t data = 0, hole = 0;
2491 int ret;
2493 assert(QEMU_IS_ALIGNED(offset | bytes, bs->bl.request_alignment));
2495 ret = fd_open(bs);
2496 if (ret < 0) {
2497 return ret;
2500 if (!want_zero) {
2501 *pnum = bytes;
2502 *map = offset;
2503 *file = bs;
2504 return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
2507 ret = find_allocation(bs, offset, &data, &hole);
2508 if (ret == -ENXIO) {
2509 /* Trailing hole */
2510 *pnum = bytes;
2511 ret = BDRV_BLOCK_ZERO;
2512 } else if (ret < 0) {
2513 /* No info available, so pretend there are no holes */
2514 *pnum = bytes;
2515 ret = BDRV_BLOCK_DATA;
2516 } else if (data == offset) {
2517 /* On a data extent, compute bytes to the end of the extent,
2518 * possibly including a partial sector at EOF. */
2519 *pnum = MIN(bytes, hole - offset);
2522 * We are not allowed to return partial sectors, though, so
2523 * round up if necessary.
2525 if (!QEMU_IS_ALIGNED(*pnum, bs->bl.request_alignment)) {
2526 int64_t file_length = raw_getlength(bs);
2527 if (file_length > 0) {
2528 /* Ignore errors, this is just a safeguard */
2529 assert(hole == file_length);
2531 *pnum = ROUND_UP(*pnum, bs->bl.request_alignment);
2534 ret = BDRV_BLOCK_DATA;
2535 } else {
2536 /* On a hole, compute bytes to the beginning of the next extent. */
2537 assert(hole == offset);
2538 *pnum = MIN(bytes, data - offset);
2539 ret = BDRV_BLOCK_ZERO;
2541 *map = offset;
2542 *file = bs;
2543 return ret | BDRV_BLOCK_OFFSET_VALID;
2546 #if defined(__linux__)
2547 /* Verify that the file is not in the page cache */
2548 static void check_cache_dropped(BlockDriverState *bs, Error **errp)
2550 const size_t window_size = 128 * 1024 * 1024;
2551 BDRVRawState *s = bs->opaque;
2552 void *window = NULL;
2553 size_t length = 0;
2554 unsigned char *vec;
2555 size_t page_size;
2556 off_t offset;
2557 off_t end;
2559 /* mincore(2) page status information requires 1 byte per page */
2560 page_size = sysconf(_SC_PAGESIZE);
2561 vec = g_malloc(DIV_ROUND_UP(window_size, page_size));
2563 end = raw_getlength(bs);
2565 for (offset = 0; offset < end; offset += window_size) {
2566 void *new_window;
2567 size_t new_length;
2568 size_t vec_end;
2569 size_t i;
2570 int ret;
2572 /* Unmap previous window if size has changed */
2573 new_length = MIN(end - offset, window_size);
2574 if (new_length != length) {
2575 munmap(window, length);
2576 window = NULL;
2577 length = 0;
2580 new_window = mmap(window, new_length, PROT_NONE, MAP_PRIVATE,
2581 s->fd, offset);
2582 if (new_window == MAP_FAILED) {
2583 error_setg_errno(errp, errno, "mmap failed");
2584 break;
2587 window = new_window;
2588 length = new_length;
2590 ret = mincore(window, length, vec);
2591 if (ret < 0) {
2592 error_setg_errno(errp, errno, "mincore failed");
2593 break;
2596 vec_end = DIV_ROUND_UP(length, page_size);
2597 for (i = 0; i < vec_end; i++) {
2598 if (vec[i] & 0x1) {
2599 error_setg(errp, "page cache still in use!");
2600 break;
2605 if (window) {
2606 munmap(window, length);
2609 g_free(vec);
2611 #endif /* __linux__ */
2613 static void coroutine_fn raw_co_invalidate_cache(BlockDriverState *bs,
2614 Error **errp)
2616 BDRVRawState *s = bs->opaque;
2617 int ret;
2619 ret = fd_open(bs);
2620 if (ret < 0) {
2621 error_setg_errno(errp, -ret, "The file descriptor is not open");
2622 return;
2625 if (!s->drop_cache) {
2626 return;
2629 if (s->open_flags & O_DIRECT) {
2630 return; /* No host kernel page cache */
2633 #if defined(__linux__)
2634 /* This sets the scene for the next syscall... */
2635 ret = bdrv_co_flush(bs);
2636 if (ret < 0) {
2637 error_setg_errno(errp, -ret, "flush failed");
2638 return;
2641 /* Linux does not invalidate pages that are dirty, locked, or mmapped by a
2642 * process. These limitations are okay because we just fsynced the file,
2643 * we don't use mmap, and the file should not be in use by other processes.
2645 ret = posix_fadvise(s->fd, 0, 0, POSIX_FADV_DONTNEED);
2646 if (ret != 0) { /* the return value is a positive errno */
2647 error_setg_errno(errp, ret, "fadvise failed");
2648 return;
2651 if (s->check_cache_dropped) {
2652 check_cache_dropped(bs, errp);
2654 #else /* __linux__ */
2655 /* Do nothing. Live migration to a remote host with cache.direct=off is
2656 * unsupported on other host operating systems. Cache consistency issues
2657 * may occur but no error is reported here, partly because that's the
2658 * historical behavior and partly because it's hard to differentiate valid
2659 * configurations that should not cause errors.
2661 #endif /* !__linux__ */
2664 static coroutine_fn int
2665 raw_do_pdiscard(BlockDriverState *bs, int64_t offset, int bytes, bool blkdev)
2667 BDRVRawState *s = bs->opaque;
2668 RawPosixAIOData acb;
2670 acb = (RawPosixAIOData) {
2671 .bs = bs,
2672 .aio_fildes = s->fd,
2673 .aio_type = QEMU_AIO_DISCARD,
2674 .aio_offset = offset,
2675 .aio_nbytes = bytes,
2678 if (blkdev) {
2679 acb.aio_type |= QEMU_AIO_BLKDEV;
2682 return raw_thread_pool_submit(bs, handle_aiocb_discard, &acb);
2685 static coroutine_fn int
2686 raw_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
2688 return raw_do_pdiscard(bs, offset, bytes, false);
2691 static int coroutine_fn
2692 raw_do_pwrite_zeroes(BlockDriverState *bs, int64_t offset, int bytes,
2693 BdrvRequestFlags flags, bool blkdev)
2695 BDRVRawState *s = bs->opaque;
2696 RawPosixAIOData acb;
2697 ThreadPoolFunc *handler;
2699 acb = (RawPosixAIOData) {
2700 .bs = bs,
2701 .aio_fildes = s->fd,
2702 .aio_type = QEMU_AIO_WRITE_ZEROES,
2703 .aio_offset = offset,
2704 .aio_nbytes = bytes,
2707 if (blkdev) {
2708 acb.aio_type |= QEMU_AIO_BLKDEV;
2710 if (flags & BDRV_REQ_NO_FALLBACK) {
2711 acb.aio_type |= QEMU_AIO_NO_FALLBACK;
2714 if (flags & BDRV_REQ_MAY_UNMAP) {
2715 acb.aio_type |= QEMU_AIO_DISCARD;
2716 handler = handle_aiocb_write_zeroes_unmap;
2717 } else {
2718 handler = handle_aiocb_write_zeroes;
2721 return raw_thread_pool_submit(bs, handler, &acb);
2724 static int coroutine_fn raw_co_pwrite_zeroes(
2725 BlockDriverState *bs, int64_t offset,
2726 int bytes, BdrvRequestFlags flags)
2728 return raw_do_pwrite_zeroes(bs, offset, bytes, flags, false);
2731 static int raw_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2733 BDRVRawState *s = bs->opaque;
2735 bdi->unallocated_blocks_are_zero = s->discard_zeroes;
2736 return 0;
2739 static QemuOptsList raw_create_opts = {
2740 .name = "raw-create-opts",
2741 .head = QTAILQ_HEAD_INITIALIZER(raw_create_opts.head),
2742 .desc = {
2744 .name = BLOCK_OPT_SIZE,
2745 .type = QEMU_OPT_SIZE,
2746 .help = "Virtual disk size"
2749 .name = BLOCK_OPT_NOCOW,
2750 .type = QEMU_OPT_BOOL,
2751 .help = "Turn off copy-on-write (valid only on btrfs)"
2754 .name = BLOCK_OPT_PREALLOC,
2755 .type = QEMU_OPT_STRING,
2756 .help = "Preallocation mode (allowed values: off"
2757 #ifdef CONFIG_POSIX_FALLOCATE
2758 ", falloc"
2759 #endif
2760 ", full)"
2762 { /* end of list */ }
2766 static int raw_check_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared,
2767 Error **errp)
2769 BDRVRawState *s = bs->opaque;
2770 BDRVRawReopenState *rs = NULL;
2771 int open_flags;
2772 int ret;
2774 if (s->perm_change_fd) {
2776 * In the context of reopen, this function may be called several times
2777 * (directly and recursively while change permissions of the parent).
2778 * This is even true for children that don't inherit from the original
2779 * reopen node, so s->reopen_state is not set.
2781 * Ignore all but the first call.
2783 return 0;
2786 if (s->reopen_state) {
2787 /* We already have a new file descriptor to set permissions for */
2788 assert(s->reopen_state->perm == perm);
2789 assert(s->reopen_state->shared_perm == shared);
2790 rs = s->reopen_state->opaque;
2791 s->perm_change_fd = rs->fd;
2792 s->perm_change_flags = rs->open_flags;
2793 } else {
2794 /* We may need a new fd if auto-read-only switches the mode */
2795 ret = raw_reconfigure_getfd(bs, bs->open_flags, &open_flags, perm,
2796 false, errp);
2797 if (ret < 0) {
2798 return ret;
2799 } else if (ret != s->fd) {
2800 s->perm_change_fd = ret;
2801 s->perm_change_flags = open_flags;
2805 /* Prepare permissions on old fd to avoid conflicts between old and new,
2806 * but keep everything locked that new will need. */
2807 ret = raw_handle_perm_lock(bs, RAW_PL_PREPARE, perm, shared, errp);
2808 if (ret < 0) {
2809 goto fail;
2812 /* Copy locks to the new fd */
2813 if (s->perm_change_fd) {
2814 ret = raw_apply_lock_bytes(NULL, s->perm_change_fd, perm, ~shared,
2815 false, errp);
2816 if (ret < 0) {
2817 raw_handle_perm_lock(bs, RAW_PL_ABORT, 0, 0, NULL);
2818 goto fail;
2821 return 0;
2823 fail:
2824 if (s->perm_change_fd && !s->reopen_state) {
2825 qemu_close(s->perm_change_fd);
2827 s->perm_change_fd = 0;
2828 return ret;
2831 static void raw_set_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared)
2833 BDRVRawState *s = bs->opaque;
2835 /* For reopen, we have already switched to the new fd (.bdrv_set_perm is
2836 * called after .bdrv_reopen_commit) */
2837 if (s->perm_change_fd && s->fd != s->perm_change_fd) {
2838 qemu_close(s->fd);
2839 s->fd = s->perm_change_fd;
2840 s->open_flags = s->perm_change_flags;
2842 s->perm_change_fd = 0;
2844 raw_handle_perm_lock(bs, RAW_PL_COMMIT, perm, shared, NULL);
2845 s->perm = perm;
2846 s->shared_perm = shared;
2849 static void raw_abort_perm_update(BlockDriverState *bs)
2851 BDRVRawState *s = bs->opaque;
2853 /* For reopen, .bdrv_reopen_abort is called afterwards and will close
2854 * the file descriptor. */
2855 if (s->perm_change_fd && !s->reopen_state) {
2856 qemu_close(s->perm_change_fd);
2858 s->perm_change_fd = 0;
2860 raw_handle_perm_lock(bs, RAW_PL_ABORT, 0, 0, NULL);
2863 static int coroutine_fn raw_co_copy_range_from(
2864 BlockDriverState *bs, BdrvChild *src, uint64_t src_offset,
2865 BdrvChild *dst, uint64_t dst_offset, uint64_t bytes,
2866 BdrvRequestFlags read_flags, BdrvRequestFlags write_flags)
2868 return bdrv_co_copy_range_to(src, src_offset, dst, dst_offset, bytes,
2869 read_flags, write_flags);
2872 static int coroutine_fn raw_co_copy_range_to(BlockDriverState *bs,
2873 BdrvChild *src,
2874 uint64_t src_offset,
2875 BdrvChild *dst,
2876 uint64_t dst_offset,
2877 uint64_t bytes,
2878 BdrvRequestFlags read_flags,
2879 BdrvRequestFlags write_flags)
2881 RawPosixAIOData acb;
2882 BDRVRawState *s = bs->opaque;
2883 BDRVRawState *src_s;
2885 assert(dst->bs == bs);
2886 if (src->bs->drv->bdrv_co_copy_range_to != raw_co_copy_range_to) {
2887 return -ENOTSUP;
2890 src_s = src->bs->opaque;
2891 if (fd_open(src->bs) < 0 || fd_open(dst->bs) < 0) {
2892 return -EIO;
2895 acb = (RawPosixAIOData) {
2896 .bs = bs,
2897 .aio_type = QEMU_AIO_COPY_RANGE,
2898 .aio_fildes = src_s->fd,
2899 .aio_offset = src_offset,
2900 .aio_nbytes = bytes,
2901 .copy_range = {
2902 .aio_fd2 = s->fd,
2903 .aio_offset2 = dst_offset,
2907 return raw_thread_pool_submit(bs, handle_aiocb_copy_range, &acb);
2910 BlockDriver bdrv_file = {
2911 .format_name = "file",
2912 .protocol_name = "file",
2913 .instance_size = sizeof(BDRVRawState),
2914 .bdrv_needs_filename = true,
2915 .bdrv_probe = NULL, /* no probe for protocols */
2916 .bdrv_parse_filename = raw_parse_filename,
2917 .bdrv_file_open = raw_open,
2918 .bdrv_reopen_prepare = raw_reopen_prepare,
2919 .bdrv_reopen_commit = raw_reopen_commit,
2920 .bdrv_reopen_abort = raw_reopen_abort,
2921 .bdrv_close = raw_close,
2922 .bdrv_co_create = raw_co_create,
2923 .bdrv_co_create_opts = raw_co_create_opts,
2924 .bdrv_has_zero_init = bdrv_has_zero_init_1,
2925 .bdrv_co_block_status = raw_co_block_status,
2926 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
2927 .bdrv_co_pwrite_zeroes = raw_co_pwrite_zeroes,
2929 .bdrv_co_preadv = raw_co_preadv,
2930 .bdrv_co_pwritev = raw_co_pwritev,
2931 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
2932 .bdrv_co_pdiscard = raw_co_pdiscard,
2933 .bdrv_co_copy_range_from = raw_co_copy_range_from,
2934 .bdrv_co_copy_range_to = raw_co_copy_range_to,
2935 .bdrv_refresh_limits = raw_refresh_limits,
2936 .bdrv_io_plug = raw_aio_plug,
2937 .bdrv_io_unplug = raw_aio_unplug,
2938 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
2940 .bdrv_co_truncate = raw_co_truncate,
2941 .bdrv_getlength = raw_getlength,
2942 .bdrv_get_info = raw_get_info,
2943 .bdrv_get_allocated_file_size
2944 = raw_get_allocated_file_size,
2945 .bdrv_check_perm = raw_check_perm,
2946 .bdrv_set_perm = raw_set_perm,
2947 .bdrv_abort_perm_update = raw_abort_perm_update,
2948 .create_opts = &raw_create_opts,
2949 .mutable_opts = mutable_opts,
2952 /***********************************************/
2953 /* host device */
2955 #if defined(__APPLE__) && defined(__MACH__)
2956 static kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
2957 CFIndex maxPathSize, int flags);
2958 static char *FindEjectableOpticalMedia(io_iterator_t *mediaIterator)
2960 kern_return_t kernResult = KERN_FAILURE;
2961 mach_port_t masterPort;
2962 CFMutableDictionaryRef classesToMatch;
2963 const char *matching_array[] = {kIODVDMediaClass, kIOCDMediaClass};
2964 char *mediaType = NULL;
2966 kernResult = IOMasterPort( MACH_PORT_NULL, &masterPort );
2967 if ( KERN_SUCCESS != kernResult ) {
2968 printf( "IOMasterPort returned %d\n", kernResult );
2971 int index;
2972 for (index = 0; index < ARRAY_SIZE(matching_array); index++) {
2973 classesToMatch = IOServiceMatching(matching_array[index]);
2974 if (classesToMatch == NULL) {
2975 error_report("IOServiceMatching returned NULL for %s",
2976 matching_array[index]);
2977 continue;
2979 CFDictionarySetValue(classesToMatch, CFSTR(kIOMediaEjectableKey),
2980 kCFBooleanTrue);
2981 kernResult = IOServiceGetMatchingServices(masterPort, classesToMatch,
2982 mediaIterator);
2983 if (kernResult != KERN_SUCCESS) {
2984 error_report("Note: IOServiceGetMatchingServices returned %d",
2985 kernResult);
2986 continue;
2989 /* If a match was found, leave the loop */
2990 if (*mediaIterator != 0) {
2991 trace_file_FindEjectableOpticalMedia(matching_array[index]);
2992 mediaType = g_strdup(matching_array[index]);
2993 break;
2996 return mediaType;
2999 kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
3000 CFIndex maxPathSize, int flags)
3002 io_object_t nextMedia;
3003 kern_return_t kernResult = KERN_FAILURE;
3004 *bsdPath = '\0';
3005 nextMedia = IOIteratorNext( mediaIterator );
3006 if ( nextMedia )
3008 CFTypeRef bsdPathAsCFString;
3009 bsdPathAsCFString = IORegistryEntryCreateCFProperty( nextMedia, CFSTR( kIOBSDNameKey ), kCFAllocatorDefault, 0 );
3010 if ( bsdPathAsCFString ) {
3011 size_t devPathLength;
3012 strcpy( bsdPath, _PATH_DEV );
3013 if (flags & BDRV_O_NOCACHE) {
3014 strcat(bsdPath, "r");
3016 devPathLength = strlen( bsdPath );
3017 if ( CFStringGetCString( bsdPathAsCFString, bsdPath + devPathLength, maxPathSize - devPathLength, kCFStringEncodingASCII ) ) {
3018 kernResult = KERN_SUCCESS;
3020 CFRelease( bsdPathAsCFString );
3022 IOObjectRelease( nextMedia );
3025 return kernResult;
3028 /* Sets up a real cdrom for use in QEMU */
3029 static bool setup_cdrom(char *bsd_path, Error **errp)
3031 int index, num_of_test_partitions = 2, fd;
3032 char test_partition[MAXPATHLEN];
3033 bool partition_found = false;
3035 /* look for a working partition */
3036 for (index = 0; index < num_of_test_partitions; index++) {
3037 snprintf(test_partition, sizeof(test_partition), "%ss%d", bsd_path,
3038 index);
3039 fd = qemu_open(test_partition, O_RDONLY | O_BINARY | O_LARGEFILE);
3040 if (fd >= 0) {
3041 partition_found = true;
3042 qemu_close(fd);
3043 break;
3047 /* if a working partition on the device was not found */
3048 if (partition_found == false) {
3049 error_setg(errp, "Failed to find a working partition on disc");
3050 } else {
3051 trace_file_setup_cdrom(test_partition);
3052 pstrcpy(bsd_path, MAXPATHLEN, test_partition);
3054 return partition_found;
3057 /* Prints directions on mounting and unmounting a device */
3058 static void print_unmounting_directions(const char *file_name)
3060 error_report("If device %s is mounted on the desktop, unmount"
3061 " it first before using it in QEMU", file_name);
3062 error_report("Command to unmount device: diskutil unmountDisk %s",
3063 file_name);
3064 error_report("Command to mount device: diskutil mountDisk %s", file_name);
3067 #endif /* defined(__APPLE__) && defined(__MACH__) */
3069 static int hdev_probe_device(const char *filename)
3071 struct stat st;
3073 /* allow a dedicated CD-ROM driver to match with a higher priority */
3074 if (strstart(filename, "/dev/cdrom", NULL))
3075 return 50;
3077 if (stat(filename, &st) >= 0 &&
3078 (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
3079 return 100;
3082 return 0;
3085 static int check_hdev_writable(BDRVRawState *s)
3087 #if defined(BLKROGET)
3088 /* Linux block devices can be configured "read-only" using blockdev(8).
3089 * This is independent of device node permissions and therefore open(2)
3090 * with O_RDWR succeeds. Actual writes fail with EPERM.
3092 * bdrv_open() is supposed to fail if the disk is read-only. Explicitly
3093 * check for read-only block devices so that Linux block devices behave
3094 * properly.
3096 struct stat st;
3097 int readonly = 0;
3099 if (fstat(s->fd, &st)) {
3100 return -errno;
3103 if (!S_ISBLK(st.st_mode)) {
3104 return 0;
3107 if (ioctl(s->fd, BLKROGET, &readonly) < 0) {
3108 return -errno;
3111 if (readonly) {
3112 return -EACCES;
3114 #endif /* defined(BLKROGET) */
3115 return 0;
3118 static void hdev_parse_filename(const char *filename, QDict *options,
3119 Error **errp)
3121 bdrv_parse_filename_strip_prefix(filename, "host_device:", options);
3124 static bool hdev_is_sg(BlockDriverState *bs)
3127 #if defined(__linux__)
3129 BDRVRawState *s = bs->opaque;
3130 struct stat st;
3131 struct sg_scsi_id scsiid;
3132 int sg_version;
3133 int ret;
3135 if (stat(bs->filename, &st) < 0 || !S_ISCHR(st.st_mode)) {
3136 return false;
3139 ret = ioctl(s->fd, SG_GET_VERSION_NUM, &sg_version);
3140 if (ret < 0) {
3141 return false;
3144 ret = ioctl(s->fd, SG_GET_SCSI_ID, &scsiid);
3145 if (ret >= 0) {
3146 trace_file_hdev_is_sg(scsiid.scsi_type, sg_version);
3147 return true;
3150 #endif
3152 return false;
3155 static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
3156 Error **errp)
3158 BDRVRawState *s = bs->opaque;
3159 Error *local_err = NULL;
3160 int ret;
3162 #if defined(__APPLE__) && defined(__MACH__)
3164 * Caution: while qdict_get_str() is fine, getting non-string types
3165 * would require more care. When @options come from -blockdev or
3166 * blockdev_add, its members are typed according to the QAPI
3167 * schema, but when they come from -drive, they're all QString.
3169 const char *filename = qdict_get_str(options, "filename");
3170 char bsd_path[MAXPATHLEN] = "";
3171 bool error_occurred = false;
3173 /* If using a real cdrom */
3174 if (strcmp(filename, "/dev/cdrom") == 0) {
3175 char *mediaType = NULL;
3176 kern_return_t ret_val;
3177 io_iterator_t mediaIterator = 0;
3179 mediaType = FindEjectableOpticalMedia(&mediaIterator);
3180 if (mediaType == NULL) {
3181 error_setg(errp, "Please make sure your CD/DVD is in the optical"
3182 " drive");
3183 error_occurred = true;
3184 goto hdev_open_Mac_error;
3187 ret_val = GetBSDPath(mediaIterator, bsd_path, sizeof(bsd_path), flags);
3188 if (ret_val != KERN_SUCCESS) {
3189 error_setg(errp, "Could not get BSD path for optical drive");
3190 error_occurred = true;
3191 goto hdev_open_Mac_error;
3194 /* If a real optical drive was not found */
3195 if (bsd_path[0] == '\0') {
3196 error_setg(errp, "Failed to obtain bsd path for optical drive");
3197 error_occurred = true;
3198 goto hdev_open_Mac_error;
3201 /* If using a cdrom disc and finding a partition on the disc failed */
3202 if (strncmp(mediaType, kIOCDMediaClass, 9) == 0 &&
3203 setup_cdrom(bsd_path, errp) == false) {
3204 print_unmounting_directions(bsd_path);
3205 error_occurred = true;
3206 goto hdev_open_Mac_error;
3209 qdict_put_str(options, "filename", bsd_path);
3211 hdev_open_Mac_error:
3212 g_free(mediaType);
3213 if (mediaIterator) {
3214 IOObjectRelease(mediaIterator);
3216 if (error_occurred) {
3217 return -ENOENT;
3220 #endif /* defined(__APPLE__) && defined(__MACH__) */
3222 s->type = FTYPE_FILE;
3224 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3225 if (ret < 0) {
3226 error_propagate(errp, local_err);
3227 #if defined(__APPLE__) && defined(__MACH__)
3228 if (*bsd_path) {
3229 filename = bsd_path;
3231 /* if a physical device experienced an error while being opened */
3232 if (strncmp(filename, "/dev/", 5) == 0) {
3233 print_unmounting_directions(filename);
3235 #endif /* defined(__APPLE__) && defined(__MACH__) */
3236 return ret;
3239 /* Since this does ioctl the device must be already opened */
3240 bs->sg = hdev_is_sg(bs);
3242 if (flags & BDRV_O_RDWR) {
3243 ret = check_hdev_writable(s);
3244 if (ret < 0) {
3245 raw_close(bs);
3246 error_setg_errno(errp, -ret, "The device is not writable");
3247 return ret;
3251 return ret;
3254 #if defined(__linux__)
3255 static int coroutine_fn
3256 hdev_co_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
3258 BDRVRawState *s = bs->opaque;
3259 RawPosixAIOData acb;
3260 int ret;
3262 ret = fd_open(bs);
3263 if (ret < 0) {
3264 return ret;
3267 if (req == SG_IO && s->pr_mgr) {
3268 struct sg_io_hdr *io_hdr = buf;
3269 if (io_hdr->cmdp[0] == PERSISTENT_RESERVE_OUT ||
3270 io_hdr->cmdp[0] == PERSISTENT_RESERVE_IN) {
3271 return pr_manager_execute(s->pr_mgr, bdrv_get_aio_context(bs),
3272 s->fd, io_hdr);
3276 acb = (RawPosixAIOData) {
3277 .bs = bs,
3278 .aio_type = QEMU_AIO_IOCTL,
3279 .aio_fildes = s->fd,
3280 .aio_offset = 0,
3281 .ioctl = {
3282 .buf = buf,
3283 .cmd = req,
3287 return raw_thread_pool_submit(bs, handle_aiocb_ioctl, &acb);
3289 #endif /* linux */
3291 static int fd_open(BlockDriverState *bs)
3293 BDRVRawState *s = bs->opaque;
3295 /* this is just to ensure s->fd is sane (its called by io ops) */
3296 if (s->fd >= 0)
3297 return 0;
3298 return -EIO;
3301 static coroutine_fn int
3302 hdev_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
3304 int ret;
3306 ret = fd_open(bs);
3307 if (ret < 0) {
3308 return ret;
3310 return raw_do_pdiscard(bs, offset, bytes, true);
3313 static coroutine_fn int hdev_co_pwrite_zeroes(BlockDriverState *bs,
3314 int64_t offset, int bytes, BdrvRequestFlags flags)
3316 int rc;
3318 rc = fd_open(bs);
3319 if (rc < 0) {
3320 return rc;
3323 return raw_do_pwrite_zeroes(bs, offset, bytes, flags, true);
3326 static int coroutine_fn hdev_co_create_opts(const char *filename, QemuOpts *opts,
3327 Error **errp)
3329 int fd;
3330 int ret = 0;
3331 struct stat stat_buf;
3332 int64_t total_size = 0;
3333 bool has_prefix;
3335 /* This function is used by both protocol block drivers and therefore either
3336 * of these prefixes may be given.
3337 * The return value has to be stored somewhere, otherwise this is an error
3338 * due to -Werror=unused-value. */
3339 has_prefix =
3340 strstart(filename, "host_device:", &filename) ||
3341 strstart(filename, "host_cdrom:" , &filename);
3343 (void)has_prefix;
3345 ret = raw_normalize_devicepath(&filename, errp);
3346 if (ret < 0) {
3347 return ret;
3350 /* Read out options */
3351 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
3352 BDRV_SECTOR_SIZE);
3354 fd = qemu_open(filename, O_WRONLY | O_BINARY);
3355 if (fd < 0) {
3356 ret = -errno;
3357 error_setg_errno(errp, -ret, "Could not open device");
3358 return ret;
3361 if (fstat(fd, &stat_buf) < 0) {
3362 ret = -errno;
3363 error_setg_errno(errp, -ret, "Could not stat device");
3364 } else if (!S_ISBLK(stat_buf.st_mode) && !S_ISCHR(stat_buf.st_mode)) {
3365 error_setg(errp,
3366 "The given file is neither a block nor a character device");
3367 ret = -ENODEV;
3368 } else if (lseek(fd, 0, SEEK_END) < total_size) {
3369 error_setg(errp, "Device is too small");
3370 ret = -ENOSPC;
3373 if (!ret && total_size) {
3374 uint8_t buf[BDRV_SECTOR_SIZE] = { 0 };
3375 int64_t zero_size = MIN(BDRV_SECTOR_SIZE, total_size);
3376 if (lseek(fd, 0, SEEK_SET) == -1) {
3377 ret = -errno;
3378 } else {
3379 ret = qemu_write_full(fd, buf, zero_size);
3380 ret = ret == zero_size ? 0 : -errno;
3383 qemu_close(fd);
3384 return ret;
3387 static BlockDriver bdrv_host_device = {
3388 .format_name = "host_device",
3389 .protocol_name = "host_device",
3390 .instance_size = sizeof(BDRVRawState),
3391 .bdrv_needs_filename = true,
3392 .bdrv_probe_device = hdev_probe_device,
3393 .bdrv_parse_filename = hdev_parse_filename,
3394 .bdrv_file_open = hdev_open,
3395 .bdrv_close = raw_close,
3396 .bdrv_reopen_prepare = raw_reopen_prepare,
3397 .bdrv_reopen_commit = raw_reopen_commit,
3398 .bdrv_reopen_abort = raw_reopen_abort,
3399 .bdrv_co_create_opts = hdev_co_create_opts,
3400 .create_opts = &raw_create_opts,
3401 .mutable_opts = mutable_opts,
3402 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3403 .bdrv_co_pwrite_zeroes = hdev_co_pwrite_zeroes,
3405 .bdrv_co_preadv = raw_co_preadv,
3406 .bdrv_co_pwritev = raw_co_pwritev,
3407 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3408 .bdrv_co_pdiscard = hdev_co_pdiscard,
3409 .bdrv_co_copy_range_from = raw_co_copy_range_from,
3410 .bdrv_co_copy_range_to = raw_co_copy_range_to,
3411 .bdrv_refresh_limits = raw_refresh_limits,
3412 .bdrv_io_plug = raw_aio_plug,
3413 .bdrv_io_unplug = raw_aio_unplug,
3414 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3416 .bdrv_co_truncate = raw_co_truncate,
3417 .bdrv_getlength = raw_getlength,
3418 .bdrv_get_info = raw_get_info,
3419 .bdrv_get_allocated_file_size
3420 = raw_get_allocated_file_size,
3421 .bdrv_check_perm = raw_check_perm,
3422 .bdrv_set_perm = raw_set_perm,
3423 .bdrv_abort_perm_update = raw_abort_perm_update,
3424 .bdrv_probe_blocksizes = hdev_probe_blocksizes,
3425 .bdrv_probe_geometry = hdev_probe_geometry,
3427 /* generic scsi device */
3428 #ifdef __linux__
3429 .bdrv_co_ioctl = hdev_co_ioctl,
3430 #endif
3433 #if defined(__linux__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3434 static void cdrom_parse_filename(const char *filename, QDict *options,
3435 Error **errp)
3437 bdrv_parse_filename_strip_prefix(filename, "host_cdrom:", options);
3439 #endif
3441 #ifdef __linux__
3442 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3443 Error **errp)
3445 BDRVRawState *s = bs->opaque;
3447 s->type = FTYPE_CD;
3449 /* open will not fail even if no CD is inserted, so add O_NONBLOCK */
3450 return raw_open_common(bs, options, flags, O_NONBLOCK, true, errp);
3453 static int cdrom_probe_device(const char *filename)
3455 int fd, ret;
3456 int prio = 0;
3457 struct stat st;
3459 fd = qemu_open(filename, O_RDONLY | O_NONBLOCK);
3460 if (fd < 0) {
3461 goto out;
3463 ret = fstat(fd, &st);
3464 if (ret == -1 || !S_ISBLK(st.st_mode)) {
3465 goto outc;
3468 /* Attempt to detect via a CDROM specific ioctl */
3469 ret = ioctl(fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3470 if (ret >= 0)
3471 prio = 100;
3473 outc:
3474 qemu_close(fd);
3475 out:
3476 return prio;
3479 static bool cdrom_is_inserted(BlockDriverState *bs)
3481 BDRVRawState *s = bs->opaque;
3482 int ret;
3484 ret = ioctl(s->fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3485 return ret == CDS_DISC_OK;
3488 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3490 BDRVRawState *s = bs->opaque;
3492 if (eject_flag) {
3493 if (ioctl(s->fd, CDROMEJECT, NULL) < 0)
3494 perror("CDROMEJECT");
3495 } else {
3496 if (ioctl(s->fd, CDROMCLOSETRAY, NULL) < 0)
3497 perror("CDROMEJECT");
3501 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3503 BDRVRawState *s = bs->opaque;
3505 if (ioctl(s->fd, CDROM_LOCKDOOR, locked) < 0) {
3507 * Note: an error can happen if the distribution automatically
3508 * mounts the CD-ROM
3510 /* perror("CDROM_LOCKDOOR"); */
3514 static BlockDriver bdrv_host_cdrom = {
3515 .format_name = "host_cdrom",
3516 .protocol_name = "host_cdrom",
3517 .instance_size = sizeof(BDRVRawState),
3518 .bdrv_needs_filename = true,
3519 .bdrv_probe_device = cdrom_probe_device,
3520 .bdrv_parse_filename = cdrom_parse_filename,
3521 .bdrv_file_open = cdrom_open,
3522 .bdrv_close = raw_close,
3523 .bdrv_reopen_prepare = raw_reopen_prepare,
3524 .bdrv_reopen_commit = raw_reopen_commit,
3525 .bdrv_reopen_abort = raw_reopen_abort,
3526 .bdrv_co_create_opts = hdev_co_create_opts,
3527 .create_opts = &raw_create_opts,
3528 .mutable_opts = mutable_opts,
3529 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3532 .bdrv_co_preadv = raw_co_preadv,
3533 .bdrv_co_pwritev = raw_co_pwritev,
3534 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3535 .bdrv_refresh_limits = raw_refresh_limits,
3536 .bdrv_io_plug = raw_aio_plug,
3537 .bdrv_io_unplug = raw_aio_unplug,
3538 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3540 .bdrv_co_truncate = raw_co_truncate,
3541 .bdrv_getlength = raw_getlength,
3542 .has_variable_length = true,
3543 .bdrv_get_allocated_file_size
3544 = raw_get_allocated_file_size,
3546 /* removable device support */
3547 .bdrv_is_inserted = cdrom_is_inserted,
3548 .bdrv_eject = cdrom_eject,
3549 .bdrv_lock_medium = cdrom_lock_medium,
3551 /* generic scsi device */
3552 .bdrv_co_ioctl = hdev_co_ioctl,
3554 #endif /* __linux__ */
3556 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
3557 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3558 Error **errp)
3560 BDRVRawState *s = bs->opaque;
3561 Error *local_err = NULL;
3562 int ret;
3564 s->type = FTYPE_CD;
3566 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3567 if (ret) {
3568 error_propagate(errp, local_err);
3569 return ret;
3572 /* make sure the door isn't locked at this time */
3573 ioctl(s->fd, CDIOCALLOW);
3574 return 0;
3577 static int cdrom_probe_device(const char *filename)
3579 if (strstart(filename, "/dev/cd", NULL) ||
3580 strstart(filename, "/dev/acd", NULL))
3581 return 100;
3582 return 0;
3585 static int cdrom_reopen(BlockDriverState *bs)
3587 BDRVRawState *s = bs->opaque;
3588 int fd;
3591 * Force reread of possibly changed/newly loaded disc,
3592 * FreeBSD seems to not notice sometimes...
3594 if (s->fd >= 0)
3595 qemu_close(s->fd);
3596 fd = qemu_open(bs->filename, s->open_flags, 0644);
3597 if (fd < 0) {
3598 s->fd = -1;
3599 return -EIO;
3601 s->fd = fd;
3603 /* make sure the door isn't locked at this time */
3604 ioctl(s->fd, CDIOCALLOW);
3605 return 0;
3608 static bool cdrom_is_inserted(BlockDriverState *bs)
3610 return raw_getlength(bs) > 0;
3613 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3615 BDRVRawState *s = bs->opaque;
3617 if (s->fd < 0)
3618 return;
3620 (void) ioctl(s->fd, CDIOCALLOW);
3622 if (eject_flag) {
3623 if (ioctl(s->fd, CDIOCEJECT) < 0)
3624 perror("CDIOCEJECT");
3625 } else {
3626 if (ioctl(s->fd, CDIOCCLOSE) < 0)
3627 perror("CDIOCCLOSE");
3630 cdrom_reopen(bs);
3633 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3635 BDRVRawState *s = bs->opaque;
3637 if (s->fd < 0)
3638 return;
3639 if (ioctl(s->fd, (locked ? CDIOCPREVENT : CDIOCALLOW)) < 0) {
3641 * Note: an error can happen if the distribution automatically
3642 * mounts the CD-ROM
3644 /* perror("CDROM_LOCKDOOR"); */
3648 static BlockDriver bdrv_host_cdrom = {
3649 .format_name = "host_cdrom",
3650 .protocol_name = "host_cdrom",
3651 .instance_size = sizeof(BDRVRawState),
3652 .bdrv_needs_filename = true,
3653 .bdrv_probe_device = cdrom_probe_device,
3654 .bdrv_parse_filename = cdrom_parse_filename,
3655 .bdrv_file_open = cdrom_open,
3656 .bdrv_close = raw_close,
3657 .bdrv_reopen_prepare = raw_reopen_prepare,
3658 .bdrv_reopen_commit = raw_reopen_commit,
3659 .bdrv_reopen_abort = raw_reopen_abort,
3660 .bdrv_co_create_opts = hdev_co_create_opts,
3661 .create_opts = &raw_create_opts,
3662 .mutable_opts = mutable_opts,
3664 .bdrv_co_preadv = raw_co_preadv,
3665 .bdrv_co_pwritev = raw_co_pwritev,
3666 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3667 .bdrv_refresh_limits = raw_refresh_limits,
3668 .bdrv_io_plug = raw_aio_plug,
3669 .bdrv_io_unplug = raw_aio_unplug,
3670 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3672 .bdrv_co_truncate = raw_co_truncate,
3673 .bdrv_getlength = raw_getlength,
3674 .has_variable_length = true,
3675 .bdrv_get_allocated_file_size
3676 = raw_get_allocated_file_size,
3678 /* removable device support */
3679 .bdrv_is_inserted = cdrom_is_inserted,
3680 .bdrv_eject = cdrom_eject,
3681 .bdrv_lock_medium = cdrom_lock_medium,
3683 #endif /* __FreeBSD__ */
3685 static void bdrv_file_init(void)
3688 * Register all the drivers. Note that order is important, the driver
3689 * registered last will get probed first.
3691 bdrv_register(&bdrv_file);
3692 bdrv_register(&bdrv_host_device);
3693 #ifdef __linux__
3694 bdrv_register(&bdrv_host_cdrom);
3695 #endif
3696 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3697 bdrv_register(&bdrv_host_cdrom);
3698 #endif
3701 block_init(bdrv_file_init);