net: stellaris_enet: convert SysBus init method to a realize method
[qemu/ar7.git] / block / file-posix.c
blob2da3a763555c4d603dfe8303e56c9540f324913c
1 /*
2 * Block driver for RAW files (posix)
4 * Copyright (c) 2006 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
27 #include "qemu/cutils.h"
28 #include "qemu/error-report.h"
29 #include "block/block_int.h"
30 #include "qemu/module.h"
31 #include "qemu/option.h"
32 #include "trace.h"
33 #include "block/thread-pool.h"
34 #include "qemu/iov.h"
35 #include "block/raw-aio.h"
36 #include "qapi/qmp/qdict.h"
37 #include "qapi/qmp/qstring.h"
39 #include "scsi/pr-manager.h"
40 #include "scsi/constants.h"
42 #if defined(__APPLE__) && (__MACH__)
43 #include <paths.h>
44 #include <sys/param.h>
45 #include <IOKit/IOKitLib.h>
46 #include <IOKit/IOBSD.h>
47 #include <IOKit/storage/IOMediaBSDClient.h>
48 #include <IOKit/storage/IOMedia.h>
49 #include <IOKit/storage/IOCDMedia.h>
50 //#include <IOKit/storage/IOCDTypes.h>
51 #include <IOKit/storage/IODVDMedia.h>
52 #include <CoreFoundation/CoreFoundation.h>
53 #endif
55 #ifdef __sun__
56 #define _POSIX_PTHREAD_SEMANTICS 1
57 #include <sys/dkio.h>
58 #endif
59 #ifdef __linux__
60 #include <sys/ioctl.h>
61 #include <sys/param.h>
62 #include <sys/syscall.h>
63 #include <linux/cdrom.h>
64 #include <linux/fd.h>
65 #include <linux/fs.h>
66 #include <linux/hdreg.h>
67 #include <scsi/sg.h>
68 #ifdef __s390__
69 #include <asm/dasd.h>
70 #endif
71 #ifndef FS_NOCOW_FL
72 #define FS_NOCOW_FL 0x00800000 /* Do not cow file */
73 #endif
74 #endif
75 #if defined(CONFIG_FALLOCATE_PUNCH_HOLE) || defined(CONFIG_FALLOCATE_ZERO_RANGE)
76 #include <linux/falloc.h>
77 #endif
78 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
79 #include <sys/disk.h>
80 #include <sys/cdio.h>
81 #endif
83 #ifdef __OpenBSD__
84 #include <sys/ioctl.h>
85 #include <sys/disklabel.h>
86 #include <sys/dkio.h>
87 #endif
89 #ifdef __NetBSD__
90 #include <sys/ioctl.h>
91 #include <sys/disklabel.h>
92 #include <sys/dkio.h>
93 #include <sys/disk.h>
94 #endif
96 #ifdef __DragonFly__
97 #include <sys/ioctl.h>
98 #include <sys/diskslice.h>
99 #endif
101 #ifdef CONFIG_XFS
102 #include <xfs/xfs.h>
103 #endif
105 //#define DEBUG_BLOCK
107 #ifdef DEBUG_BLOCK
108 # define DEBUG_BLOCK_PRINT 1
109 #else
110 # define DEBUG_BLOCK_PRINT 0
111 #endif
112 #define DPRINTF(fmt, ...) \
113 do { \
114 if (DEBUG_BLOCK_PRINT) { \
115 printf(fmt, ## __VA_ARGS__); \
117 } while (0)
119 /* OS X does not have O_DSYNC */
120 #ifndef O_DSYNC
121 #ifdef O_SYNC
122 #define O_DSYNC O_SYNC
123 #elif defined(O_FSYNC)
124 #define O_DSYNC O_FSYNC
125 #endif
126 #endif
128 /* Approximate O_DIRECT with O_DSYNC if O_DIRECT isn't available */
129 #ifndef O_DIRECT
130 #define O_DIRECT O_DSYNC
131 #endif
133 #define FTYPE_FILE 0
134 #define FTYPE_CD 1
136 #define MAX_BLOCKSIZE 4096
138 /* Posix file locking bytes. Libvirt takes byte 0, we start from higher bytes,
139 * leaving a few more bytes for its future use. */
140 #define RAW_LOCK_PERM_BASE 100
141 #define RAW_LOCK_SHARED_BASE 200
143 typedef struct BDRVRawState {
144 int fd;
145 int lock_fd;
146 bool use_lock;
147 int type;
148 int open_flags;
149 size_t buf_align;
151 /* The current permissions. */
152 uint64_t perm;
153 uint64_t shared_perm;
155 #ifdef CONFIG_XFS
156 bool is_xfs:1;
157 #endif
158 bool has_discard:1;
159 bool has_write_zeroes:1;
160 bool discard_zeroes:1;
161 bool use_linux_aio:1;
162 bool page_cache_inconsistent:1;
163 bool has_fallocate;
164 bool needs_alignment;
165 bool check_cache_dropped;
167 PRManager *pr_mgr;
168 } BDRVRawState;
170 typedef struct BDRVRawReopenState {
171 int fd;
172 int open_flags;
173 bool check_cache_dropped;
174 } BDRVRawReopenState;
176 static int fd_open(BlockDriverState *bs);
177 static int64_t raw_getlength(BlockDriverState *bs);
179 typedef struct RawPosixAIOData {
180 BlockDriverState *bs;
181 int aio_fildes;
182 union {
183 struct iovec *aio_iov;
184 void *aio_ioctl_buf;
186 int aio_niov;
187 uint64_t aio_nbytes;
188 #define aio_ioctl_cmd aio_nbytes /* for QEMU_AIO_IOCTL */
189 off_t aio_offset;
190 int aio_type;
191 union {
192 struct {
193 int aio_fd2;
194 off_t aio_offset2;
196 struct {
197 PreallocMode prealloc;
198 Error **errp;
201 } RawPosixAIOData;
203 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
204 static int cdrom_reopen(BlockDriverState *bs);
205 #endif
207 #if defined(__NetBSD__)
208 static int raw_normalize_devicepath(const char **filename)
210 static char namebuf[PATH_MAX];
211 const char *dp, *fname;
212 struct stat sb;
214 fname = *filename;
215 dp = strrchr(fname, '/');
216 if (lstat(fname, &sb) < 0) {
217 fprintf(stderr, "%s: stat failed: %s\n",
218 fname, strerror(errno));
219 return -errno;
222 if (!S_ISBLK(sb.st_mode)) {
223 return 0;
226 if (dp == NULL) {
227 snprintf(namebuf, PATH_MAX, "r%s", fname);
228 } else {
229 snprintf(namebuf, PATH_MAX, "%.*s/r%s",
230 (int)(dp - fname), fname, dp + 1);
232 fprintf(stderr, "%s is a block device", fname);
233 *filename = namebuf;
234 fprintf(stderr, ", using %s\n", *filename);
236 return 0;
238 #else
239 static int raw_normalize_devicepath(const char **filename)
241 return 0;
243 #endif
246 * Get logical block size via ioctl. On success store it in @sector_size_p.
248 static int probe_logical_blocksize(int fd, unsigned int *sector_size_p)
250 unsigned int sector_size;
251 bool success = false;
252 int i;
254 errno = ENOTSUP;
255 static const unsigned long ioctl_list[] = {
256 #ifdef BLKSSZGET
257 BLKSSZGET,
258 #endif
259 #ifdef DKIOCGETBLOCKSIZE
260 DKIOCGETBLOCKSIZE,
261 #endif
262 #ifdef DIOCGSECTORSIZE
263 DIOCGSECTORSIZE,
264 #endif
267 /* Try a few ioctls to get the right size */
268 for (i = 0; i < (int)ARRAY_SIZE(ioctl_list); i++) {
269 if (ioctl(fd, ioctl_list[i], &sector_size) >= 0) {
270 *sector_size_p = sector_size;
271 success = true;
275 return success ? 0 : -errno;
279 * Get physical block size of @fd.
280 * On success, store it in @blk_size and return 0.
281 * On failure, return -errno.
283 static int probe_physical_blocksize(int fd, unsigned int *blk_size)
285 #ifdef BLKPBSZGET
286 if (ioctl(fd, BLKPBSZGET, blk_size) < 0) {
287 return -errno;
289 return 0;
290 #else
291 return -ENOTSUP;
292 #endif
295 /* Check if read is allowed with given memory buffer and length.
297 * This function is used to check O_DIRECT memory buffer and request alignment.
299 static bool raw_is_io_aligned(int fd, void *buf, size_t len)
301 ssize_t ret = pread(fd, buf, len, 0);
303 if (ret >= 0) {
304 return true;
307 #ifdef __linux__
308 /* The Linux kernel returns EINVAL for misaligned O_DIRECT reads. Ignore
309 * other errors (e.g. real I/O error), which could happen on a failed
310 * drive, since we only care about probing alignment.
312 if (errno != EINVAL) {
313 return true;
315 #endif
317 return false;
320 static void raw_probe_alignment(BlockDriverState *bs, int fd, Error **errp)
322 BDRVRawState *s = bs->opaque;
323 char *buf;
324 size_t max_align = MAX(MAX_BLOCKSIZE, getpagesize());
326 /* For SCSI generic devices the alignment is not really used.
327 With buffered I/O, we don't have any restrictions. */
328 if (bdrv_is_sg(bs) || !s->needs_alignment) {
329 bs->bl.request_alignment = 1;
330 s->buf_align = 1;
331 return;
334 bs->bl.request_alignment = 0;
335 s->buf_align = 0;
336 /* Let's try to use the logical blocksize for the alignment. */
337 if (probe_logical_blocksize(fd, &bs->bl.request_alignment) < 0) {
338 bs->bl.request_alignment = 0;
340 #ifdef CONFIG_XFS
341 if (s->is_xfs) {
342 struct dioattr da;
343 if (xfsctl(NULL, fd, XFS_IOC_DIOINFO, &da) >= 0) {
344 bs->bl.request_alignment = da.d_miniosz;
345 /* The kernel returns wrong information for d_mem */
346 /* s->buf_align = da.d_mem; */
349 #endif
351 /* If we could not get the sizes so far, we can only guess them */
352 if (!s->buf_align) {
353 size_t align;
354 buf = qemu_memalign(max_align, 2 * max_align);
355 for (align = 512; align <= max_align; align <<= 1) {
356 if (raw_is_io_aligned(fd, buf + align, max_align)) {
357 s->buf_align = align;
358 break;
361 qemu_vfree(buf);
364 if (!bs->bl.request_alignment) {
365 size_t align;
366 buf = qemu_memalign(s->buf_align, max_align);
367 for (align = 512; align <= max_align; align <<= 1) {
368 if (raw_is_io_aligned(fd, buf, align)) {
369 bs->bl.request_alignment = align;
370 break;
373 qemu_vfree(buf);
376 if (!s->buf_align || !bs->bl.request_alignment) {
377 error_setg(errp, "Could not find working O_DIRECT alignment");
378 error_append_hint(errp, "Try cache.direct=off\n");
382 static void raw_parse_flags(int bdrv_flags, int *open_flags)
384 assert(open_flags != NULL);
386 *open_flags |= O_BINARY;
387 *open_flags &= ~O_ACCMODE;
388 if (bdrv_flags & BDRV_O_RDWR) {
389 *open_flags |= O_RDWR;
390 } else {
391 *open_flags |= O_RDONLY;
394 /* Use O_DSYNC for write-through caching, no flags for write-back caching,
395 * and O_DIRECT for no caching. */
396 if ((bdrv_flags & BDRV_O_NOCACHE)) {
397 *open_flags |= O_DIRECT;
401 static void raw_parse_filename(const char *filename, QDict *options,
402 Error **errp)
404 bdrv_parse_filename_strip_prefix(filename, "file:", options);
407 static QemuOptsList raw_runtime_opts = {
408 .name = "raw",
409 .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
410 .desc = {
412 .name = "filename",
413 .type = QEMU_OPT_STRING,
414 .help = "File name of the image",
417 .name = "aio",
418 .type = QEMU_OPT_STRING,
419 .help = "host AIO implementation (threads, native)",
422 .name = "locking",
423 .type = QEMU_OPT_STRING,
424 .help = "file locking mode (on/off/auto, default: auto)",
427 .name = "pr-manager",
428 .type = QEMU_OPT_STRING,
429 .help = "id of persistent reservation manager object (default: none)",
432 .name = "x-check-cache-dropped",
433 .type = QEMU_OPT_BOOL,
434 .help = "check that page cache was dropped on live migration (default: off)"
436 { /* end of list */ }
440 static int raw_open_common(BlockDriverState *bs, QDict *options,
441 int bdrv_flags, int open_flags,
442 bool device, Error **errp)
444 BDRVRawState *s = bs->opaque;
445 QemuOpts *opts;
446 Error *local_err = NULL;
447 const char *filename = NULL;
448 const char *str;
449 BlockdevAioOptions aio, aio_default;
450 int fd, ret;
451 struct stat st;
452 OnOffAuto locking;
454 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
455 qemu_opts_absorb_qdict(opts, options, &local_err);
456 if (local_err) {
457 error_propagate(errp, local_err);
458 ret = -EINVAL;
459 goto fail;
462 filename = qemu_opt_get(opts, "filename");
464 ret = raw_normalize_devicepath(&filename);
465 if (ret != 0) {
466 error_setg_errno(errp, -ret, "Could not normalize device path");
467 goto fail;
470 aio_default = (bdrv_flags & BDRV_O_NATIVE_AIO)
471 ? BLOCKDEV_AIO_OPTIONS_NATIVE
472 : BLOCKDEV_AIO_OPTIONS_THREADS;
473 aio = qapi_enum_parse(&BlockdevAioOptions_lookup,
474 qemu_opt_get(opts, "aio"),
475 aio_default, &local_err);
476 if (local_err) {
477 error_propagate(errp, local_err);
478 ret = -EINVAL;
479 goto fail;
481 s->use_linux_aio = (aio == BLOCKDEV_AIO_OPTIONS_NATIVE);
483 locking = qapi_enum_parse(&OnOffAuto_lookup,
484 qemu_opt_get(opts, "locking"),
485 ON_OFF_AUTO_AUTO, &local_err);
486 if (local_err) {
487 error_propagate(errp, local_err);
488 ret = -EINVAL;
489 goto fail;
491 switch (locking) {
492 case ON_OFF_AUTO_ON:
493 s->use_lock = true;
494 if (!qemu_has_ofd_lock()) {
495 fprintf(stderr,
496 "File lock requested but OFD locking syscall is "
497 "unavailable, falling back to POSIX file locks.\n"
498 "Due to the implementation, locks can be lost "
499 "unexpectedly.\n");
501 break;
502 case ON_OFF_AUTO_OFF:
503 s->use_lock = false;
504 break;
505 case ON_OFF_AUTO_AUTO:
506 s->use_lock = qemu_has_ofd_lock();
507 break;
508 default:
509 abort();
512 str = qemu_opt_get(opts, "pr-manager");
513 if (str) {
514 s->pr_mgr = pr_manager_lookup(str, &local_err);
515 if (local_err) {
516 error_propagate(errp, local_err);
517 ret = -EINVAL;
518 goto fail;
522 s->check_cache_dropped = qemu_opt_get_bool(opts, "x-check-cache-dropped",
523 false);
525 s->open_flags = open_flags;
526 raw_parse_flags(bdrv_flags, &s->open_flags);
528 s->fd = -1;
529 fd = qemu_open(filename, s->open_flags, 0644);
530 if (fd < 0) {
531 ret = -errno;
532 error_setg_errno(errp, errno, "Could not open '%s'", filename);
533 if (ret == -EROFS) {
534 ret = -EACCES;
536 goto fail;
538 s->fd = fd;
540 s->lock_fd = -1;
541 if (s->use_lock) {
542 fd = qemu_open(filename, s->open_flags);
543 if (fd < 0) {
544 ret = -errno;
545 error_setg_errno(errp, errno, "Could not open '%s' for locking",
546 filename);
547 qemu_close(s->fd);
548 goto fail;
550 s->lock_fd = fd;
552 s->perm = 0;
553 s->shared_perm = BLK_PERM_ALL;
555 #ifdef CONFIG_LINUX_AIO
556 /* Currently Linux does AIO only for files opened with O_DIRECT */
557 if (s->use_linux_aio) {
558 if (!(s->open_flags & O_DIRECT)) {
559 error_setg(errp, "aio=native was specified, but it requires "
560 "cache.direct=on, which was not specified.");
561 ret = -EINVAL;
562 goto fail;
564 if (!aio_setup_linux_aio(bdrv_get_aio_context(bs), errp)) {
565 error_prepend(errp, "Unable to use native AIO: ");
566 goto fail;
569 #else
570 if (s->use_linux_aio) {
571 error_setg(errp, "aio=native was specified, but is not supported "
572 "in this build.");
573 ret = -EINVAL;
574 goto fail;
576 #endif /* !defined(CONFIG_LINUX_AIO) */
578 s->has_discard = true;
579 s->has_write_zeroes = true;
580 if ((bs->open_flags & BDRV_O_NOCACHE) != 0) {
581 s->needs_alignment = true;
584 if (fstat(s->fd, &st) < 0) {
585 ret = -errno;
586 error_setg_errno(errp, errno, "Could not stat file");
587 goto fail;
590 if (!device) {
591 if (S_ISBLK(st.st_mode)) {
592 warn_report("Opening a block device as a file using the '%s' "
593 "driver is deprecated", bs->drv->format_name);
594 } else if (S_ISCHR(st.st_mode)) {
595 warn_report("Opening a character device as a file using the '%s' "
596 "driver is deprecated", bs->drv->format_name);
597 } else if (!S_ISREG(st.st_mode)) {
598 error_setg(errp, "A regular file was expected by the '%s' driver, "
599 "but something else was given", bs->drv->format_name);
600 ret = -EINVAL;
601 goto fail;
602 } else {
603 s->discard_zeroes = true;
604 s->has_fallocate = true;
606 } else {
607 if (!(S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
608 error_setg(errp, "'%s' driver expects either "
609 "a character or block device", bs->drv->format_name);
610 ret = -EINVAL;
611 goto fail;
615 if (S_ISBLK(st.st_mode)) {
616 #ifdef BLKDISCARDZEROES
617 unsigned int arg;
618 if (ioctl(s->fd, BLKDISCARDZEROES, &arg) == 0 && arg) {
619 s->discard_zeroes = true;
621 #endif
622 #ifdef __linux__
623 /* On Linux 3.10, BLKDISCARD leaves stale data in the page cache. Do
624 * not rely on the contents of discarded blocks unless using O_DIRECT.
625 * Same for BLKZEROOUT.
627 if (!(bs->open_flags & BDRV_O_NOCACHE)) {
628 s->discard_zeroes = false;
629 s->has_write_zeroes = false;
631 #endif
633 #ifdef __FreeBSD__
634 if (S_ISCHR(st.st_mode)) {
636 * The file is a char device (disk), which on FreeBSD isn't behind
637 * a pager, so force all requests to be aligned. This is needed
638 * so QEMU makes sure all IO operations on the device are aligned
639 * to sector size, or else FreeBSD will reject them with EINVAL.
641 s->needs_alignment = true;
643 #endif
645 #ifdef CONFIG_XFS
646 if (platform_test_xfs_fd(s->fd)) {
647 s->is_xfs = true;
649 #endif
651 bs->supported_zero_flags = BDRV_REQ_MAY_UNMAP;
652 ret = 0;
653 fail:
654 if (filename && (bdrv_flags & BDRV_O_TEMPORARY)) {
655 unlink(filename);
657 qemu_opts_del(opts);
658 return ret;
661 static int raw_open(BlockDriverState *bs, QDict *options, int flags,
662 Error **errp)
664 BDRVRawState *s = bs->opaque;
666 s->type = FTYPE_FILE;
667 return raw_open_common(bs, options, flags, 0, false, errp);
670 typedef enum {
671 RAW_PL_PREPARE,
672 RAW_PL_COMMIT,
673 RAW_PL_ABORT,
674 } RawPermLockOp;
676 #define PERM_FOREACH(i) \
677 for ((i) = 0; (1ULL << (i)) <= BLK_PERM_ALL; i++)
679 /* Lock bytes indicated by @perm_lock_bits and @shared_perm_lock_bits in the
680 * file; if @unlock == true, also unlock the unneeded bytes.
681 * @shared_perm_lock_bits is the mask of all permissions that are NOT shared.
683 static int raw_apply_lock_bytes(int fd,
684 uint64_t perm_lock_bits,
685 uint64_t shared_perm_lock_bits,
686 bool unlock, Error **errp)
688 int ret;
689 int i;
691 PERM_FOREACH(i) {
692 int off = RAW_LOCK_PERM_BASE + i;
693 if (perm_lock_bits & (1ULL << i)) {
694 ret = qemu_lock_fd(fd, off, 1, false);
695 if (ret) {
696 error_setg(errp, "Failed to lock byte %d", off);
697 return ret;
699 } else if (unlock) {
700 ret = qemu_unlock_fd(fd, off, 1);
701 if (ret) {
702 error_setg(errp, "Failed to unlock byte %d", off);
703 return ret;
707 PERM_FOREACH(i) {
708 int off = RAW_LOCK_SHARED_BASE + i;
709 if (shared_perm_lock_bits & (1ULL << i)) {
710 ret = qemu_lock_fd(fd, off, 1, false);
711 if (ret) {
712 error_setg(errp, "Failed to lock byte %d", off);
713 return ret;
715 } else if (unlock) {
716 ret = qemu_unlock_fd(fd, off, 1);
717 if (ret) {
718 error_setg(errp, "Failed to unlock byte %d", off);
719 return ret;
723 return 0;
726 /* Check "unshared" bytes implied by @perm and ~@shared_perm in the file. */
727 static int raw_check_lock_bytes(int fd, uint64_t perm, uint64_t shared_perm,
728 Error **errp)
730 int ret;
731 int i;
733 PERM_FOREACH(i) {
734 int off = RAW_LOCK_SHARED_BASE + i;
735 uint64_t p = 1ULL << i;
736 if (perm & p) {
737 ret = qemu_lock_fd_test(fd, off, 1, true);
738 if (ret) {
739 char *perm_name = bdrv_perm_names(p);
740 error_setg(errp,
741 "Failed to get \"%s\" lock",
742 perm_name);
743 g_free(perm_name);
744 return ret;
748 PERM_FOREACH(i) {
749 int off = RAW_LOCK_PERM_BASE + i;
750 uint64_t p = 1ULL << i;
751 if (!(shared_perm & p)) {
752 ret = qemu_lock_fd_test(fd, off, 1, true);
753 if (ret) {
754 char *perm_name = bdrv_perm_names(p);
755 error_setg(errp,
756 "Failed to get shared \"%s\" lock",
757 perm_name);
758 g_free(perm_name);
759 return ret;
763 return 0;
766 static int raw_handle_perm_lock(BlockDriverState *bs,
767 RawPermLockOp op,
768 uint64_t new_perm, uint64_t new_shared,
769 Error **errp)
771 BDRVRawState *s = bs->opaque;
772 int ret = 0;
773 Error *local_err = NULL;
775 if (!s->use_lock) {
776 return 0;
779 if (bdrv_get_flags(bs) & BDRV_O_INACTIVE) {
780 return 0;
783 assert(s->lock_fd > 0);
785 switch (op) {
786 case RAW_PL_PREPARE:
787 ret = raw_apply_lock_bytes(s->lock_fd, s->perm | new_perm,
788 ~s->shared_perm | ~new_shared,
789 false, errp);
790 if (!ret) {
791 ret = raw_check_lock_bytes(s->lock_fd, new_perm, new_shared, errp);
792 if (!ret) {
793 return 0;
795 error_append_hint(errp,
796 "Is another process using the image [%s]?\n",
797 bs->filename);
799 op = RAW_PL_ABORT;
800 /* fall through to unlock bytes. */
801 case RAW_PL_ABORT:
802 raw_apply_lock_bytes(s->lock_fd, s->perm, ~s->shared_perm,
803 true, &local_err);
804 if (local_err) {
805 /* Theoretically the above call only unlocks bytes and it cannot
806 * fail. Something weird happened, report it.
808 error_report_err(local_err);
810 break;
811 case RAW_PL_COMMIT:
812 raw_apply_lock_bytes(s->lock_fd, new_perm, ~new_shared,
813 true, &local_err);
814 if (local_err) {
815 /* Theoretically the above call only unlocks bytes and it cannot
816 * fail. Something weird happened, report it.
818 error_report_err(local_err);
820 break;
822 return ret;
825 static int raw_reopen_prepare(BDRVReopenState *state,
826 BlockReopenQueue *queue, Error **errp)
828 BDRVRawState *s;
829 BDRVRawReopenState *rs;
830 QemuOpts *opts;
831 int ret = 0;
832 Error *local_err = NULL;
834 assert(state != NULL);
835 assert(state->bs != NULL);
837 s = state->bs->opaque;
839 state->opaque = g_new0(BDRVRawReopenState, 1);
840 rs = state->opaque;
841 rs->fd = -1;
843 /* Handle options changes */
844 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
845 qemu_opts_absorb_qdict(opts, state->options, &local_err);
846 if (local_err) {
847 error_propagate(errp, local_err);
848 ret = -EINVAL;
849 goto out;
852 rs->check_cache_dropped =
853 qemu_opt_get_bool_del(opts, "x-check-cache-dropped", false);
855 /* This driver's reopen function doesn't currently allow changing
856 * other options, so let's put them back in the original QDict and
857 * bdrv_reopen_prepare() will detect changes and complain. */
858 qemu_opts_to_qdict(opts, state->options);
860 if (s->type == FTYPE_CD) {
861 rs->open_flags |= O_NONBLOCK;
864 raw_parse_flags(state->flags, &rs->open_flags);
866 int fcntl_flags = O_APPEND | O_NONBLOCK;
867 #ifdef O_NOATIME
868 fcntl_flags |= O_NOATIME;
869 #endif
871 #ifdef O_ASYNC
872 /* Not all operating systems have O_ASYNC, and those that don't
873 * will not let us track the state into rs->open_flags (typically
874 * you achieve the same effect with an ioctl, for example I_SETSIG
875 * on Solaris). But we do not use O_ASYNC, so that's fine.
877 assert((s->open_flags & O_ASYNC) == 0);
878 #endif
880 if ((rs->open_flags & ~fcntl_flags) == (s->open_flags & ~fcntl_flags)) {
881 /* dup the original fd */
882 rs->fd = qemu_dup(s->fd);
883 if (rs->fd >= 0) {
884 ret = fcntl_setfl(rs->fd, rs->open_flags);
885 if (ret) {
886 qemu_close(rs->fd);
887 rs->fd = -1;
892 /* If we cannot use fcntl, or fcntl failed, fall back to qemu_open() */
893 if (rs->fd == -1) {
894 const char *normalized_filename = state->bs->filename;
895 ret = raw_normalize_devicepath(&normalized_filename);
896 if (ret < 0) {
897 error_setg_errno(errp, -ret, "Could not normalize device path");
898 } else {
899 assert(!(rs->open_flags & O_CREAT));
900 rs->fd = qemu_open(normalized_filename, rs->open_flags);
901 if (rs->fd == -1) {
902 error_setg_errno(errp, errno, "Could not reopen file");
903 ret = -1;
908 /* Fail already reopen_prepare() if we can't get a working O_DIRECT
909 * alignment with the new fd. */
910 if (rs->fd != -1) {
911 raw_probe_alignment(state->bs, rs->fd, &local_err);
912 if (local_err) {
913 qemu_close(rs->fd);
914 rs->fd = -1;
915 error_propagate(errp, local_err);
916 ret = -EINVAL;
920 out:
921 qemu_opts_del(opts);
922 return ret;
925 static void raw_reopen_commit(BDRVReopenState *state)
927 BDRVRawReopenState *rs = state->opaque;
928 BDRVRawState *s = state->bs->opaque;
930 s->check_cache_dropped = rs->check_cache_dropped;
931 s->open_flags = rs->open_flags;
933 qemu_close(s->fd);
934 s->fd = rs->fd;
936 g_free(state->opaque);
937 state->opaque = NULL;
941 static void raw_reopen_abort(BDRVReopenState *state)
943 BDRVRawReopenState *rs = state->opaque;
945 /* nothing to do if NULL, we didn't get far enough */
946 if (rs == NULL) {
947 return;
950 if (rs->fd >= 0) {
951 qemu_close(rs->fd);
952 rs->fd = -1;
954 g_free(state->opaque);
955 state->opaque = NULL;
958 static int hdev_get_max_transfer_length(BlockDriverState *bs, int fd)
960 #ifdef BLKSECTGET
961 int max_bytes = 0;
962 short max_sectors = 0;
963 if (bs->sg && ioctl(fd, BLKSECTGET, &max_bytes) == 0) {
964 return max_bytes;
965 } else if (!bs->sg && ioctl(fd, BLKSECTGET, &max_sectors) == 0) {
966 return max_sectors << BDRV_SECTOR_BITS;
967 } else {
968 return -errno;
970 #else
971 return -ENOSYS;
972 #endif
975 static int hdev_get_max_segments(const struct stat *st)
977 #ifdef CONFIG_LINUX
978 char buf[32];
979 const char *end;
980 char *sysfspath;
981 int ret;
982 int fd = -1;
983 long max_segments;
985 sysfspath = g_strdup_printf("/sys/dev/block/%u:%u/queue/max_segments",
986 major(st->st_rdev), minor(st->st_rdev));
987 fd = open(sysfspath, O_RDONLY);
988 if (fd == -1) {
989 ret = -errno;
990 goto out;
992 do {
993 ret = read(fd, buf, sizeof(buf) - 1);
994 } while (ret == -1 && errno == EINTR);
995 if (ret < 0) {
996 ret = -errno;
997 goto out;
998 } else if (ret == 0) {
999 ret = -EIO;
1000 goto out;
1002 buf[ret] = 0;
1003 /* The file is ended with '\n', pass 'end' to accept that. */
1004 ret = qemu_strtol(buf, &end, 10, &max_segments);
1005 if (ret == 0 && end && *end == '\n') {
1006 ret = max_segments;
1009 out:
1010 if (fd != -1) {
1011 close(fd);
1013 g_free(sysfspath);
1014 return ret;
1015 #else
1016 return -ENOTSUP;
1017 #endif
1020 static void raw_refresh_limits(BlockDriverState *bs, Error **errp)
1022 BDRVRawState *s = bs->opaque;
1023 struct stat st;
1025 if (!fstat(s->fd, &st)) {
1026 if (S_ISBLK(st.st_mode) || S_ISCHR(st.st_mode)) {
1027 int ret = hdev_get_max_transfer_length(bs, s->fd);
1028 if (ret > 0 && ret <= BDRV_REQUEST_MAX_BYTES) {
1029 bs->bl.max_transfer = pow2floor(ret);
1031 ret = hdev_get_max_segments(&st);
1032 if (ret > 0) {
1033 bs->bl.max_transfer = MIN(bs->bl.max_transfer,
1034 ret * getpagesize());
1039 raw_probe_alignment(bs, s->fd, errp);
1040 bs->bl.min_mem_alignment = s->buf_align;
1041 bs->bl.opt_mem_alignment = MAX(s->buf_align, getpagesize());
1044 static int check_for_dasd(int fd)
1046 #ifdef BIODASDINFO2
1047 struct dasd_information2_t info = {0};
1049 return ioctl(fd, BIODASDINFO2, &info);
1050 #else
1051 return -1;
1052 #endif
1056 * Try to get @bs's logical and physical block size.
1057 * On success, store them in @bsz and return zero.
1058 * On failure, return negative errno.
1060 static int hdev_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz)
1062 BDRVRawState *s = bs->opaque;
1063 int ret;
1065 /* If DASD, get blocksizes */
1066 if (check_for_dasd(s->fd) < 0) {
1067 return -ENOTSUP;
1069 ret = probe_logical_blocksize(s->fd, &bsz->log);
1070 if (ret < 0) {
1071 return ret;
1073 return probe_physical_blocksize(s->fd, &bsz->phys);
1077 * Try to get @bs's geometry: cyls, heads, sectors.
1078 * On success, store them in @geo and return 0.
1079 * On failure return -errno.
1080 * (Allows block driver to assign default geometry values that guest sees)
1082 #ifdef __linux__
1083 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1085 BDRVRawState *s = bs->opaque;
1086 struct hd_geometry ioctl_geo = {0};
1088 /* If DASD, get its geometry */
1089 if (check_for_dasd(s->fd) < 0) {
1090 return -ENOTSUP;
1092 if (ioctl(s->fd, HDIO_GETGEO, &ioctl_geo) < 0) {
1093 return -errno;
1095 /* HDIO_GETGEO may return success even though geo contains zeros
1096 (e.g. certain multipath setups) */
1097 if (!ioctl_geo.heads || !ioctl_geo.sectors || !ioctl_geo.cylinders) {
1098 return -ENOTSUP;
1100 /* Do not return a geometry for partition */
1101 if (ioctl_geo.start != 0) {
1102 return -ENOTSUP;
1104 geo->heads = ioctl_geo.heads;
1105 geo->sectors = ioctl_geo.sectors;
1106 geo->cylinders = ioctl_geo.cylinders;
1108 return 0;
1110 #else /* __linux__ */
1111 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1113 return -ENOTSUP;
1115 #endif
1117 static ssize_t handle_aiocb_ioctl(RawPosixAIOData *aiocb)
1119 int ret;
1121 ret = ioctl(aiocb->aio_fildes, aiocb->aio_ioctl_cmd, aiocb->aio_ioctl_buf);
1122 if (ret == -1) {
1123 return -errno;
1126 return 0;
1129 static ssize_t handle_aiocb_flush(RawPosixAIOData *aiocb)
1131 BDRVRawState *s = aiocb->bs->opaque;
1132 int ret;
1134 if (s->page_cache_inconsistent) {
1135 return -EIO;
1138 ret = qemu_fdatasync(aiocb->aio_fildes);
1139 if (ret == -1) {
1140 /* There is no clear definition of the semantics of a failing fsync(),
1141 * so we may have to assume the worst. The sad truth is that this
1142 * assumption is correct for Linux. Some pages are now probably marked
1143 * clean in the page cache even though they are inconsistent with the
1144 * on-disk contents. The next fdatasync() call would succeed, but no
1145 * further writeback attempt will be made. We can't get back to a state
1146 * in which we know what is on disk (we would have to rewrite
1147 * everything that was touched since the last fdatasync() at least), so
1148 * make bdrv_flush() fail permanently. Given that the behaviour isn't
1149 * really defined, I have little hope that other OSes are doing better.
1151 * Obviously, this doesn't affect O_DIRECT, which bypasses the page
1152 * cache. */
1153 if ((s->open_flags & O_DIRECT) == 0) {
1154 s->page_cache_inconsistent = true;
1156 return -errno;
1158 return 0;
1161 #ifdef CONFIG_PREADV
1163 static bool preadv_present = true;
1165 static ssize_t
1166 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1168 return preadv(fd, iov, nr_iov, offset);
1171 static ssize_t
1172 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1174 return pwritev(fd, iov, nr_iov, offset);
1177 #else
1179 static bool preadv_present = false;
1181 static ssize_t
1182 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1184 return -ENOSYS;
1187 static ssize_t
1188 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1190 return -ENOSYS;
1193 #endif
1195 static ssize_t handle_aiocb_rw_vector(RawPosixAIOData *aiocb)
1197 ssize_t len;
1199 do {
1200 if (aiocb->aio_type & QEMU_AIO_WRITE)
1201 len = qemu_pwritev(aiocb->aio_fildes,
1202 aiocb->aio_iov,
1203 aiocb->aio_niov,
1204 aiocb->aio_offset);
1205 else
1206 len = qemu_preadv(aiocb->aio_fildes,
1207 aiocb->aio_iov,
1208 aiocb->aio_niov,
1209 aiocb->aio_offset);
1210 } while (len == -1 && errno == EINTR);
1212 if (len == -1) {
1213 return -errno;
1215 return len;
1219 * Read/writes the data to/from a given linear buffer.
1221 * Returns the number of bytes handles or -errno in case of an error. Short
1222 * reads are only returned if the end of the file is reached.
1224 static ssize_t handle_aiocb_rw_linear(RawPosixAIOData *aiocb, char *buf)
1226 ssize_t offset = 0;
1227 ssize_t len;
1229 while (offset < aiocb->aio_nbytes) {
1230 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1231 len = pwrite(aiocb->aio_fildes,
1232 (const char *)buf + offset,
1233 aiocb->aio_nbytes - offset,
1234 aiocb->aio_offset + offset);
1235 } else {
1236 len = pread(aiocb->aio_fildes,
1237 buf + offset,
1238 aiocb->aio_nbytes - offset,
1239 aiocb->aio_offset + offset);
1241 if (len == -1 && errno == EINTR) {
1242 continue;
1243 } else if (len == -1 && errno == EINVAL &&
1244 (aiocb->bs->open_flags & BDRV_O_NOCACHE) &&
1245 !(aiocb->aio_type & QEMU_AIO_WRITE) &&
1246 offset > 0) {
1247 /* O_DIRECT pread() may fail with EINVAL when offset is unaligned
1248 * after a short read. Assume that O_DIRECT short reads only occur
1249 * at EOF. Therefore this is a short read, not an I/O error.
1251 break;
1252 } else if (len == -1) {
1253 offset = -errno;
1254 break;
1255 } else if (len == 0) {
1256 break;
1258 offset += len;
1261 return offset;
1264 static ssize_t handle_aiocb_rw(RawPosixAIOData *aiocb)
1266 ssize_t nbytes;
1267 char *buf;
1269 if (!(aiocb->aio_type & QEMU_AIO_MISALIGNED)) {
1271 * If there is just a single buffer, and it is properly aligned
1272 * we can just use plain pread/pwrite without any problems.
1274 if (aiocb->aio_niov == 1) {
1275 return handle_aiocb_rw_linear(aiocb, aiocb->aio_iov->iov_base);
1278 * We have more than one iovec, and all are properly aligned.
1280 * Try preadv/pwritev first and fall back to linearizing the
1281 * buffer if it's not supported.
1283 if (preadv_present) {
1284 nbytes = handle_aiocb_rw_vector(aiocb);
1285 if (nbytes == aiocb->aio_nbytes ||
1286 (nbytes < 0 && nbytes != -ENOSYS)) {
1287 return nbytes;
1289 preadv_present = false;
1293 * XXX(hch): short read/write. no easy way to handle the reminder
1294 * using these interfaces. For now retry using plain
1295 * pread/pwrite?
1300 * Ok, we have to do it the hard way, copy all segments into
1301 * a single aligned buffer.
1303 buf = qemu_try_blockalign(aiocb->bs, aiocb->aio_nbytes);
1304 if (buf == NULL) {
1305 return -ENOMEM;
1308 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1309 char *p = buf;
1310 int i;
1312 for (i = 0; i < aiocb->aio_niov; ++i) {
1313 memcpy(p, aiocb->aio_iov[i].iov_base, aiocb->aio_iov[i].iov_len);
1314 p += aiocb->aio_iov[i].iov_len;
1316 assert(p - buf == aiocb->aio_nbytes);
1319 nbytes = handle_aiocb_rw_linear(aiocb, buf);
1320 if (!(aiocb->aio_type & QEMU_AIO_WRITE)) {
1321 char *p = buf;
1322 size_t count = aiocb->aio_nbytes, copy;
1323 int i;
1325 for (i = 0; i < aiocb->aio_niov && count; ++i) {
1326 copy = count;
1327 if (copy > aiocb->aio_iov[i].iov_len) {
1328 copy = aiocb->aio_iov[i].iov_len;
1330 memcpy(aiocb->aio_iov[i].iov_base, p, copy);
1331 assert(count >= copy);
1332 p += copy;
1333 count -= copy;
1335 assert(count == 0);
1337 qemu_vfree(buf);
1339 return nbytes;
1342 #ifdef CONFIG_XFS
1343 static int xfs_write_zeroes(BDRVRawState *s, int64_t offset, uint64_t bytes)
1345 struct xfs_flock64 fl;
1346 int err;
1348 memset(&fl, 0, sizeof(fl));
1349 fl.l_whence = SEEK_SET;
1350 fl.l_start = offset;
1351 fl.l_len = bytes;
1353 if (xfsctl(NULL, s->fd, XFS_IOC_ZERO_RANGE, &fl) < 0) {
1354 err = errno;
1355 DPRINTF("cannot write zero range (%s)\n", strerror(errno));
1356 return -err;
1359 return 0;
1362 static int xfs_discard(BDRVRawState *s, int64_t offset, uint64_t bytes)
1364 struct xfs_flock64 fl;
1365 int err;
1367 memset(&fl, 0, sizeof(fl));
1368 fl.l_whence = SEEK_SET;
1369 fl.l_start = offset;
1370 fl.l_len = bytes;
1372 if (xfsctl(NULL, s->fd, XFS_IOC_UNRESVSP64, &fl) < 0) {
1373 err = errno;
1374 DPRINTF("cannot punch hole (%s)\n", strerror(errno));
1375 return -err;
1378 return 0;
1380 #endif
1382 static int translate_err(int err)
1384 if (err == -ENODEV || err == -ENOSYS || err == -EOPNOTSUPP ||
1385 err == -ENOTTY) {
1386 err = -ENOTSUP;
1388 return err;
1391 #ifdef CONFIG_FALLOCATE
1392 static int do_fallocate(int fd, int mode, off_t offset, off_t len)
1394 do {
1395 if (fallocate(fd, mode, offset, len) == 0) {
1396 return 0;
1398 } while (errno == EINTR);
1399 return translate_err(-errno);
1401 #endif
1403 static ssize_t handle_aiocb_write_zeroes_block(RawPosixAIOData *aiocb)
1405 int ret = -ENOTSUP;
1406 BDRVRawState *s = aiocb->bs->opaque;
1408 if (!s->has_write_zeroes) {
1409 return -ENOTSUP;
1412 #ifdef BLKZEROOUT
1413 do {
1414 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1415 if (ioctl(aiocb->aio_fildes, BLKZEROOUT, range) == 0) {
1416 return 0;
1418 } while (errno == EINTR);
1420 ret = translate_err(-errno);
1421 #endif
1423 if (ret == -ENOTSUP) {
1424 s->has_write_zeroes = false;
1426 return ret;
1429 static ssize_t handle_aiocb_write_zeroes(RawPosixAIOData *aiocb)
1431 #if defined(CONFIG_FALLOCATE) || defined(CONFIG_XFS)
1432 BDRVRawState *s = aiocb->bs->opaque;
1433 #endif
1434 #ifdef CONFIG_FALLOCATE
1435 int64_t len;
1436 #endif
1438 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1439 return handle_aiocb_write_zeroes_block(aiocb);
1442 #ifdef CONFIG_XFS
1443 if (s->is_xfs) {
1444 return xfs_write_zeroes(s, aiocb->aio_offset, aiocb->aio_nbytes);
1446 #endif
1448 #ifdef CONFIG_FALLOCATE_ZERO_RANGE
1449 if (s->has_write_zeroes) {
1450 int ret = do_fallocate(s->fd, FALLOC_FL_ZERO_RANGE,
1451 aiocb->aio_offset, aiocb->aio_nbytes);
1452 if (ret == 0 || ret != -ENOTSUP) {
1453 return ret;
1455 s->has_write_zeroes = false;
1457 #endif
1459 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1460 if (s->has_discard && s->has_fallocate) {
1461 int ret = do_fallocate(s->fd,
1462 FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1463 aiocb->aio_offset, aiocb->aio_nbytes);
1464 if (ret == 0) {
1465 ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1466 if (ret == 0 || ret != -ENOTSUP) {
1467 return ret;
1469 s->has_fallocate = false;
1470 } else if (ret != -ENOTSUP) {
1471 return ret;
1472 } else {
1473 s->has_discard = false;
1476 #endif
1478 #ifdef CONFIG_FALLOCATE
1479 /* Last resort: we are trying to extend the file with zeroed data. This
1480 * can be done via fallocate(fd, 0) */
1481 len = bdrv_getlength(aiocb->bs);
1482 if (s->has_fallocate && len >= 0 && aiocb->aio_offset >= len) {
1483 int ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1484 if (ret == 0 || ret != -ENOTSUP) {
1485 return ret;
1487 s->has_fallocate = false;
1489 #endif
1491 return -ENOTSUP;
1494 static ssize_t handle_aiocb_write_zeroes_unmap(RawPosixAIOData *aiocb)
1496 BDRVRawState *s G_GNUC_UNUSED = aiocb->bs->opaque;
1497 int ret;
1499 /* First try to write zeros and unmap at the same time */
1501 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1502 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1503 aiocb->aio_offset, aiocb->aio_nbytes);
1504 if (ret != -ENOTSUP) {
1505 return ret;
1507 #endif
1509 #ifdef CONFIG_XFS
1510 if (s->is_xfs) {
1511 /* xfs_discard() guarantees that the discarded area reads as all-zero
1512 * afterwards, so we can use it here. */
1513 return xfs_discard(s, aiocb->aio_offset, aiocb->aio_nbytes);
1515 #endif
1517 /* If we couldn't manage to unmap while guaranteed that the area reads as
1518 * all-zero afterwards, just write zeroes without unmapping */
1519 ret = handle_aiocb_write_zeroes(aiocb);
1520 return ret;
1523 #ifndef HAVE_COPY_FILE_RANGE
1524 static off_t copy_file_range(int in_fd, off_t *in_off, int out_fd,
1525 off_t *out_off, size_t len, unsigned int flags)
1527 #ifdef __NR_copy_file_range
1528 return syscall(__NR_copy_file_range, in_fd, in_off, out_fd,
1529 out_off, len, flags);
1530 #else
1531 errno = ENOSYS;
1532 return -1;
1533 #endif
1535 #endif
1537 static ssize_t handle_aiocb_copy_range(RawPosixAIOData *aiocb)
1539 uint64_t bytes = aiocb->aio_nbytes;
1540 off_t in_off = aiocb->aio_offset;
1541 off_t out_off = aiocb->aio_offset2;
1543 while (bytes) {
1544 ssize_t ret = copy_file_range(aiocb->aio_fildes, &in_off,
1545 aiocb->aio_fd2, &out_off,
1546 bytes, 0);
1547 trace_file_copy_file_range(aiocb->bs, aiocb->aio_fildes, in_off,
1548 aiocb->aio_fd2, out_off, bytes, 0, ret);
1549 if (ret == 0) {
1550 /* No progress (e.g. when beyond EOF), let the caller fall back to
1551 * buffer I/O. */
1552 return -ENOSPC;
1554 if (ret < 0) {
1555 switch (errno) {
1556 case ENOSYS:
1557 return -ENOTSUP;
1558 case EINTR:
1559 continue;
1560 default:
1561 return -errno;
1564 bytes -= ret;
1566 return 0;
1569 static ssize_t handle_aiocb_discard(RawPosixAIOData *aiocb)
1571 int ret = -EOPNOTSUPP;
1572 BDRVRawState *s = aiocb->bs->opaque;
1574 if (!s->has_discard) {
1575 return -ENOTSUP;
1578 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1579 #ifdef BLKDISCARD
1580 do {
1581 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1582 if (ioctl(aiocb->aio_fildes, BLKDISCARD, range) == 0) {
1583 return 0;
1585 } while (errno == EINTR);
1587 ret = -errno;
1588 #endif
1589 } else {
1590 #ifdef CONFIG_XFS
1591 if (s->is_xfs) {
1592 return xfs_discard(s, aiocb->aio_offset, aiocb->aio_nbytes);
1594 #endif
1596 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1597 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1598 aiocb->aio_offset, aiocb->aio_nbytes);
1599 #endif
1602 ret = translate_err(ret);
1603 if (ret == -ENOTSUP) {
1604 s->has_discard = false;
1606 return ret;
1609 static int handle_aiocb_truncate(RawPosixAIOData *aiocb)
1611 int result = 0;
1612 int64_t current_length = 0;
1613 char *buf = NULL;
1614 struct stat st;
1615 int fd = aiocb->aio_fildes;
1616 int64_t offset = aiocb->aio_offset;
1617 Error **errp = aiocb->errp;
1619 if (fstat(fd, &st) < 0) {
1620 result = -errno;
1621 error_setg_errno(errp, -result, "Could not stat file");
1622 return result;
1625 current_length = st.st_size;
1626 if (current_length > offset && aiocb->prealloc != PREALLOC_MODE_OFF) {
1627 error_setg(errp, "Cannot use preallocation for shrinking files");
1628 return -ENOTSUP;
1631 switch (aiocb->prealloc) {
1632 #ifdef CONFIG_POSIX_FALLOCATE
1633 case PREALLOC_MODE_FALLOC:
1635 * Truncating before posix_fallocate() makes it about twice slower on
1636 * file systems that do not support fallocate(), trying to check if a
1637 * block is allocated before allocating it, so don't do that here.
1639 if (offset != current_length) {
1640 result = -posix_fallocate(fd, current_length,
1641 offset - current_length);
1642 if (result != 0) {
1643 /* posix_fallocate() doesn't set errno. */
1644 error_setg_errno(errp, -result,
1645 "Could not preallocate new data");
1647 } else {
1648 result = 0;
1650 goto out;
1651 #endif
1652 case PREALLOC_MODE_FULL:
1654 int64_t num = 0, left = offset - current_length;
1655 off_t seek_result;
1658 * Knowing the final size from the beginning could allow the file
1659 * system driver to do less allocations and possibly avoid
1660 * fragmentation of the file.
1662 if (ftruncate(fd, offset) != 0) {
1663 result = -errno;
1664 error_setg_errno(errp, -result, "Could not resize file");
1665 goto out;
1668 buf = g_malloc0(65536);
1670 seek_result = lseek(fd, current_length, SEEK_SET);
1671 if (seek_result < 0) {
1672 result = -errno;
1673 error_setg_errno(errp, -result,
1674 "Failed to seek to the old end of file");
1675 goto out;
1678 while (left > 0) {
1679 num = MIN(left, 65536);
1680 result = write(fd, buf, num);
1681 if (result < 0) {
1682 if (errno == EINTR) {
1683 continue;
1685 result = -errno;
1686 error_setg_errno(errp, -result,
1687 "Could not write zeros for preallocation");
1688 goto out;
1690 left -= result;
1692 if (result >= 0) {
1693 result = fsync(fd);
1694 if (result < 0) {
1695 result = -errno;
1696 error_setg_errno(errp, -result,
1697 "Could not flush file to disk");
1698 goto out;
1701 goto out;
1703 case PREALLOC_MODE_OFF:
1704 if (ftruncate(fd, offset) != 0) {
1705 result = -errno;
1706 error_setg_errno(errp, -result, "Could not resize file");
1708 return result;
1709 default:
1710 result = -ENOTSUP;
1711 error_setg(errp, "Unsupported preallocation mode: %s",
1712 PreallocMode_str(aiocb->prealloc));
1713 return result;
1716 out:
1717 if (result < 0) {
1718 if (ftruncate(fd, current_length) < 0) {
1719 error_report("Failed to restore old file length: %s",
1720 strerror(errno));
1724 g_free(buf);
1725 return result;
1728 static int aio_worker(void *arg)
1730 RawPosixAIOData *aiocb = arg;
1731 ssize_t ret = 0;
1733 switch (aiocb->aio_type & QEMU_AIO_TYPE_MASK) {
1734 case QEMU_AIO_READ:
1735 ret = handle_aiocb_rw(aiocb);
1736 if (ret >= 0 && ret < aiocb->aio_nbytes) {
1737 iov_memset(aiocb->aio_iov, aiocb->aio_niov, ret,
1738 0, aiocb->aio_nbytes - ret);
1740 ret = aiocb->aio_nbytes;
1742 if (ret == aiocb->aio_nbytes) {
1743 ret = 0;
1744 } else if (ret >= 0 && ret < aiocb->aio_nbytes) {
1745 ret = -EINVAL;
1747 break;
1748 case QEMU_AIO_WRITE:
1749 ret = handle_aiocb_rw(aiocb);
1750 if (ret == aiocb->aio_nbytes) {
1751 ret = 0;
1752 } else if (ret >= 0 && ret < aiocb->aio_nbytes) {
1753 ret = -EINVAL;
1755 break;
1756 case QEMU_AIO_FLUSH:
1757 ret = handle_aiocb_flush(aiocb);
1758 break;
1759 case QEMU_AIO_IOCTL:
1760 ret = handle_aiocb_ioctl(aiocb);
1761 break;
1762 case QEMU_AIO_DISCARD:
1763 ret = handle_aiocb_discard(aiocb);
1764 break;
1765 case QEMU_AIO_WRITE_ZEROES:
1766 ret = handle_aiocb_write_zeroes(aiocb);
1767 break;
1768 case QEMU_AIO_WRITE_ZEROES | QEMU_AIO_DISCARD:
1769 ret = handle_aiocb_write_zeroes_unmap(aiocb);
1770 break;
1771 case QEMU_AIO_COPY_RANGE:
1772 ret = handle_aiocb_copy_range(aiocb);
1773 break;
1774 case QEMU_AIO_TRUNCATE:
1775 ret = handle_aiocb_truncate(aiocb);
1776 break;
1777 default:
1778 fprintf(stderr, "invalid aio request (0x%x)\n", aiocb->aio_type);
1779 ret = -EINVAL;
1780 break;
1783 g_free(aiocb);
1784 return ret;
1787 static int paio_submit_co_full(BlockDriverState *bs, int fd,
1788 int64_t offset, int fd2, int64_t offset2,
1789 QEMUIOVector *qiov,
1790 int bytes, int type)
1792 RawPosixAIOData *acb = g_new(RawPosixAIOData, 1);
1793 ThreadPool *pool;
1795 acb->bs = bs;
1796 acb->aio_type = type;
1797 acb->aio_fildes = fd;
1798 acb->aio_fd2 = fd2;
1799 acb->aio_offset2 = offset2;
1801 acb->aio_nbytes = bytes;
1802 acb->aio_offset = offset;
1804 if (qiov) {
1805 acb->aio_iov = qiov->iov;
1806 acb->aio_niov = qiov->niov;
1807 assert(qiov->size == bytes);
1810 trace_file_paio_submit_co(offset, bytes, type);
1811 pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
1812 return thread_pool_submit_co(pool, aio_worker, acb);
1815 static inline int paio_submit_co(BlockDriverState *bs, int fd,
1816 int64_t offset, QEMUIOVector *qiov,
1817 int bytes, int type)
1819 return paio_submit_co_full(bs, fd, offset, -1, 0, qiov, bytes, type);
1822 static int coroutine_fn raw_co_prw(BlockDriverState *bs, uint64_t offset,
1823 uint64_t bytes, QEMUIOVector *qiov, int type)
1825 BDRVRawState *s = bs->opaque;
1827 if (fd_open(bs) < 0)
1828 return -EIO;
1831 * Check if the underlying device requires requests to be aligned,
1832 * and if the request we are trying to submit is aligned or not.
1833 * If this is the case tell the low-level driver that it needs
1834 * to copy the buffer.
1836 if (s->needs_alignment) {
1837 if (!bdrv_qiov_is_aligned(bs, qiov)) {
1838 type |= QEMU_AIO_MISALIGNED;
1839 #ifdef CONFIG_LINUX_AIO
1840 } else if (s->use_linux_aio) {
1841 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1842 assert(qiov->size == bytes);
1843 return laio_co_submit(bs, aio, s->fd, offset, qiov, type);
1844 #endif
1848 return paio_submit_co(bs, s->fd, offset, qiov, bytes, type);
1851 static int coroutine_fn raw_co_preadv(BlockDriverState *bs, uint64_t offset,
1852 uint64_t bytes, QEMUIOVector *qiov,
1853 int flags)
1855 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_READ);
1858 static int coroutine_fn raw_co_pwritev(BlockDriverState *bs, uint64_t offset,
1859 uint64_t bytes, QEMUIOVector *qiov,
1860 int flags)
1862 assert(flags == 0);
1863 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_WRITE);
1866 static void raw_aio_plug(BlockDriverState *bs)
1868 #ifdef CONFIG_LINUX_AIO
1869 BDRVRawState *s = bs->opaque;
1870 if (s->use_linux_aio) {
1871 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1872 laio_io_plug(bs, aio);
1874 #endif
1877 static void raw_aio_unplug(BlockDriverState *bs)
1879 #ifdef CONFIG_LINUX_AIO
1880 BDRVRawState *s = bs->opaque;
1881 if (s->use_linux_aio) {
1882 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1883 laio_io_unplug(bs, aio);
1885 #endif
1888 static int raw_co_flush_to_disk(BlockDriverState *bs)
1890 BDRVRawState *s = bs->opaque;
1891 int ret;
1893 ret = fd_open(bs);
1894 if (ret < 0) {
1895 return ret;
1898 return paio_submit_co(bs, s->fd, 0, NULL, 0, QEMU_AIO_FLUSH);
1901 static void raw_aio_attach_aio_context(BlockDriverState *bs,
1902 AioContext *new_context)
1904 #ifdef CONFIG_LINUX_AIO
1905 BDRVRawState *s = bs->opaque;
1906 if (s->use_linux_aio) {
1907 Error *local_err;
1908 if (!aio_setup_linux_aio(new_context, &local_err)) {
1909 error_reportf_err(local_err, "Unable to use native AIO, "
1910 "falling back to thread pool: ");
1911 s->use_linux_aio = false;
1914 #endif
1917 static void raw_close(BlockDriverState *bs)
1919 BDRVRawState *s = bs->opaque;
1921 if (s->fd >= 0) {
1922 qemu_close(s->fd);
1923 s->fd = -1;
1925 if (s->lock_fd >= 0) {
1926 qemu_close(s->lock_fd);
1927 s->lock_fd = -1;
1932 * Truncates the given regular file @fd to @offset and, when growing, fills the
1933 * new space according to @prealloc.
1935 * Returns: 0 on success, -errno on failure.
1937 static int coroutine_fn
1938 raw_regular_truncate(BlockDriverState *bs, int fd, int64_t offset,
1939 PreallocMode prealloc, Error **errp)
1941 RawPosixAIOData *acb = g_new(RawPosixAIOData, 1);
1942 ThreadPool *pool;
1944 *acb = (RawPosixAIOData) {
1945 .bs = bs,
1946 .aio_fildes = fd,
1947 .aio_type = QEMU_AIO_TRUNCATE,
1948 .aio_offset = offset,
1949 .prealloc = prealloc,
1950 .errp = errp,
1953 /* @bs can be NULL, bdrv_get_aio_context() returns the main context then */
1954 pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
1955 return thread_pool_submit_co(pool, aio_worker, acb);
1958 static int coroutine_fn raw_co_truncate(BlockDriverState *bs, int64_t offset,
1959 PreallocMode prealloc, Error **errp)
1961 BDRVRawState *s = bs->opaque;
1962 struct stat st;
1963 int ret;
1965 if (fstat(s->fd, &st)) {
1966 ret = -errno;
1967 error_setg_errno(errp, -ret, "Failed to fstat() the file");
1968 return ret;
1971 if (S_ISREG(st.st_mode)) {
1972 return raw_regular_truncate(bs, s->fd, offset, prealloc, errp);
1975 if (prealloc != PREALLOC_MODE_OFF) {
1976 error_setg(errp, "Preallocation mode '%s' unsupported for this "
1977 "non-regular file", PreallocMode_str(prealloc));
1978 return -ENOTSUP;
1981 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
1982 if (offset > raw_getlength(bs)) {
1983 error_setg(errp, "Cannot grow device files");
1984 return -EINVAL;
1986 } else {
1987 error_setg(errp, "Resizing this file is not supported");
1988 return -ENOTSUP;
1991 return 0;
1994 #ifdef __OpenBSD__
1995 static int64_t raw_getlength(BlockDriverState *bs)
1997 BDRVRawState *s = bs->opaque;
1998 int fd = s->fd;
1999 struct stat st;
2001 if (fstat(fd, &st))
2002 return -errno;
2003 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2004 struct disklabel dl;
2006 if (ioctl(fd, DIOCGDINFO, &dl))
2007 return -errno;
2008 return (uint64_t)dl.d_secsize *
2009 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2010 } else
2011 return st.st_size;
2013 #elif defined(__NetBSD__)
2014 static int64_t raw_getlength(BlockDriverState *bs)
2016 BDRVRawState *s = bs->opaque;
2017 int fd = s->fd;
2018 struct stat st;
2020 if (fstat(fd, &st))
2021 return -errno;
2022 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2023 struct dkwedge_info dkw;
2025 if (ioctl(fd, DIOCGWEDGEINFO, &dkw) != -1) {
2026 return dkw.dkw_size * 512;
2027 } else {
2028 struct disklabel dl;
2030 if (ioctl(fd, DIOCGDINFO, &dl))
2031 return -errno;
2032 return (uint64_t)dl.d_secsize *
2033 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2035 } else
2036 return st.st_size;
2038 #elif defined(__sun__)
2039 static int64_t raw_getlength(BlockDriverState *bs)
2041 BDRVRawState *s = bs->opaque;
2042 struct dk_minfo minfo;
2043 int ret;
2044 int64_t size;
2046 ret = fd_open(bs);
2047 if (ret < 0) {
2048 return ret;
2052 * Use the DKIOCGMEDIAINFO ioctl to read the size.
2054 ret = ioctl(s->fd, DKIOCGMEDIAINFO, &minfo);
2055 if (ret != -1) {
2056 return minfo.dki_lbsize * minfo.dki_capacity;
2060 * There are reports that lseek on some devices fails, but
2061 * irc discussion said that contingency on contingency was overkill.
2063 size = lseek(s->fd, 0, SEEK_END);
2064 if (size < 0) {
2065 return -errno;
2067 return size;
2069 #elif defined(CONFIG_BSD)
2070 static int64_t raw_getlength(BlockDriverState *bs)
2072 BDRVRawState *s = bs->opaque;
2073 int fd = s->fd;
2074 int64_t size;
2075 struct stat sb;
2076 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2077 int reopened = 0;
2078 #endif
2079 int ret;
2081 ret = fd_open(bs);
2082 if (ret < 0)
2083 return ret;
2085 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2086 again:
2087 #endif
2088 if (!fstat(fd, &sb) && (S_IFCHR & sb.st_mode)) {
2089 #ifdef DIOCGMEDIASIZE
2090 if (ioctl(fd, DIOCGMEDIASIZE, (off_t *)&size))
2091 #elif defined(DIOCGPART)
2093 struct partinfo pi;
2094 if (ioctl(fd, DIOCGPART, &pi) == 0)
2095 size = pi.media_size;
2096 else
2097 size = 0;
2099 if (size == 0)
2100 #endif
2101 #if defined(__APPLE__) && defined(__MACH__)
2103 uint64_t sectors = 0;
2104 uint32_t sector_size = 0;
2106 if (ioctl(fd, DKIOCGETBLOCKCOUNT, &sectors) == 0
2107 && ioctl(fd, DKIOCGETBLOCKSIZE, &sector_size) == 0) {
2108 size = sectors * sector_size;
2109 } else {
2110 size = lseek(fd, 0LL, SEEK_END);
2111 if (size < 0) {
2112 return -errno;
2116 #else
2117 size = lseek(fd, 0LL, SEEK_END);
2118 if (size < 0) {
2119 return -errno;
2121 #endif
2122 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
2123 switch(s->type) {
2124 case FTYPE_CD:
2125 /* XXX FreeBSD acd returns UINT_MAX sectors for an empty drive */
2126 if (size == 2048LL * (unsigned)-1)
2127 size = 0;
2128 /* XXX no disc? maybe we need to reopen... */
2129 if (size <= 0 && !reopened && cdrom_reopen(bs) >= 0) {
2130 reopened = 1;
2131 goto again;
2134 #endif
2135 } else {
2136 size = lseek(fd, 0, SEEK_END);
2137 if (size < 0) {
2138 return -errno;
2141 return size;
2143 #else
2144 static int64_t raw_getlength(BlockDriverState *bs)
2146 BDRVRawState *s = bs->opaque;
2147 int ret;
2148 int64_t size;
2150 ret = fd_open(bs);
2151 if (ret < 0) {
2152 return ret;
2155 size = lseek(s->fd, 0, SEEK_END);
2156 if (size < 0) {
2157 return -errno;
2159 return size;
2161 #endif
2163 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
2165 struct stat st;
2166 BDRVRawState *s = bs->opaque;
2168 if (fstat(s->fd, &st) < 0) {
2169 return -errno;
2171 return (int64_t)st.st_blocks * 512;
2174 static int coroutine_fn
2175 raw_co_create(BlockdevCreateOptions *options, Error **errp)
2177 BlockdevCreateOptionsFile *file_opts;
2178 Error *local_err = NULL;
2179 int fd;
2180 uint64_t perm, shared;
2181 int result = 0;
2183 /* Validate options and set default values */
2184 assert(options->driver == BLOCKDEV_DRIVER_FILE);
2185 file_opts = &options->u.file;
2187 if (!file_opts->has_nocow) {
2188 file_opts->nocow = false;
2190 if (!file_opts->has_preallocation) {
2191 file_opts->preallocation = PREALLOC_MODE_OFF;
2194 /* Create file */
2195 fd = qemu_open(file_opts->filename, O_RDWR | O_CREAT | O_BINARY, 0644);
2196 if (fd < 0) {
2197 result = -errno;
2198 error_setg_errno(errp, -result, "Could not create file");
2199 goto out;
2202 /* Take permissions: We want to discard everything, so we need
2203 * BLK_PERM_WRITE; and truncation to the desired size requires
2204 * BLK_PERM_RESIZE.
2205 * On the other hand, we cannot share the RESIZE permission
2206 * because we promise that after this function, the file has the
2207 * size given in the options. If someone else were to resize it
2208 * concurrently, we could not guarantee that.
2209 * Note that after this function, we can no longer guarantee that
2210 * the file is not touched by a third party, so it may be resized
2211 * then. */
2212 perm = BLK_PERM_WRITE | BLK_PERM_RESIZE;
2213 shared = BLK_PERM_ALL & ~BLK_PERM_RESIZE;
2215 /* Step one: Take locks */
2216 result = raw_apply_lock_bytes(fd, perm, ~shared, false, errp);
2217 if (result < 0) {
2218 goto out_close;
2221 /* Step two: Check that nobody else has taken conflicting locks */
2222 result = raw_check_lock_bytes(fd, perm, shared, errp);
2223 if (result < 0) {
2224 error_append_hint(errp,
2225 "Is another process using the image [%s]?\n",
2226 file_opts->filename);
2227 goto out_unlock;
2230 /* Clear the file by truncating it to 0 */
2231 result = raw_regular_truncate(NULL, fd, 0, PREALLOC_MODE_OFF, errp);
2232 if (result < 0) {
2233 goto out_unlock;
2236 if (file_opts->nocow) {
2237 #ifdef __linux__
2238 /* Set NOCOW flag to solve performance issue on fs like btrfs.
2239 * This is an optimisation. The FS_IOC_SETFLAGS ioctl return value
2240 * will be ignored since any failure of this operation should not
2241 * block the left work.
2243 int attr;
2244 if (ioctl(fd, FS_IOC_GETFLAGS, &attr) == 0) {
2245 attr |= FS_NOCOW_FL;
2246 ioctl(fd, FS_IOC_SETFLAGS, &attr);
2248 #endif
2251 /* Resize and potentially preallocate the file to the desired
2252 * final size */
2253 result = raw_regular_truncate(NULL, fd, file_opts->size,
2254 file_opts->preallocation, errp);
2255 if (result < 0) {
2256 goto out_unlock;
2259 out_unlock:
2260 raw_apply_lock_bytes(fd, 0, 0, true, &local_err);
2261 if (local_err) {
2262 /* The above call should not fail, and if it does, that does
2263 * not mean the whole creation operation has failed. So
2264 * report it the user for their convenience, but do not report
2265 * it to the caller. */
2266 error_report_err(local_err);
2269 out_close:
2270 if (qemu_close(fd) != 0 && result == 0) {
2271 result = -errno;
2272 error_setg_errno(errp, -result, "Could not close the new file");
2274 out:
2275 return result;
2278 static int coroutine_fn raw_co_create_opts(const char *filename, QemuOpts *opts,
2279 Error **errp)
2281 BlockdevCreateOptions options;
2282 int64_t total_size = 0;
2283 bool nocow = false;
2284 PreallocMode prealloc;
2285 char *buf = NULL;
2286 Error *local_err = NULL;
2288 /* Skip file: protocol prefix */
2289 strstart(filename, "file:", &filename);
2291 /* Read out options */
2292 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2293 BDRV_SECTOR_SIZE);
2294 nocow = qemu_opt_get_bool(opts, BLOCK_OPT_NOCOW, false);
2295 buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
2296 prealloc = qapi_enum_parse(&PreallocMode_lookup, buf,
2297 PREALLOC_MODE_OFF, &local_err);
2298 g_free(buf);
2299 if (local_err) {
2300 error_propagate(errp, local_err);
2301 return -EINVAL;
2304 options = (BlockdevCreateOptions) {
2305 .driver = BLOCKDEV_DRIVER_FILE,
2306 .u.file = {
2307 .filename = (char *) filename,
2308 .size = total_size,
2309 .has_preallocation = true,
2310 .preallocation = prealloc,
2311 .has_nocow = true,
2312 .nocow = nocow,
2315 return raw_co_create(&options, errp);
2319 * Find allocation range in @bs around offset @start.
2320 * May change underlying file descriptor's file offset.
2321 * If @start is not in a hole, store @start in @data, and the
2322 * beginning of the next hole in @hole, and return 0.
2323 * If @start is in a non-trailing hole, store @start in @hole and the
2324 * beginning of the next non-hole in @data, and return 0.
2325 * If @start is in a trailing hole or beyond EOF, return -ENXIO.
2326 * If we can't find out, return a negative errno other than -ENXIO.
2328 static int find_allocation(BlockDriverState *bs, off_t start,
2329 off_t *data, off_t *hole)
2331 #if defined SEEK_HOLE && defined SEEK_DATA
2332 BDRVRawState *s = bs->opaque;
2333 off_t offs;
2336 * SEEK_DATA cases:
2337 * D1. offs == start: start is in data
2338 * D2. offs > start: start is in a hole, next data at offs
2339 * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
2340 * or start is beyond EOF
2341 * If the latter happens, the file has been truncated behind
2342 * our back since we opened it. All bets are off then.
2343 * Treating like a trailing hole is simplest.
2344 * D4. offs < 0, errno != ENXIO: we learned nothing
2346 offs = lseek(s->fd, start, SEEK_DATA);
2347 if (offs < 0) {
2348 return -errno; /* D3 or D4 */
2351 if (offs < start) {
2352 /* This is not a valid return by lseek(). We are safe to just return
2353 * -EIO in this case, and we'll treat it like D4. */
2354 return -EIO;
2357 if (offs > start) {
2358 /* D2: in hole, next data at offs */
2359 *hole = start;
2360 *data = offs;
2361 return 0;
2364 /* D1: in data, end not yet known */
2367 * SEEK_HOLE cases:
2368 * H1. offs == start: start is in a hole
2369 * If this happens here, a hole has been dug behind our back
2370 * since the previous lseek().
2371 * H2. offs > start: either start is in data, next hole at offs,
2372 * or start is in trailing hole, EOF at offs
2373 * Linux treats trailing holes like any other hole: offs ==
2374 * start. Solaris seeks to EOF instead: offs > start (blech).
2375 * If that happens here, a hole has been dug behind our back
2376 * since the previous lseek().
2377 * H3. offs < 0, errno = ENXIO: start is beyond EOF
2378 * If this happens, the file has been truncated behind our
2379 * back since we opened it. Treat it like a trailing hole.
2380 * H4. offs < 0, errno != ENXIO: we learned nothing
2381 * Pretend we know nothing at all, i.e. "forget" about D1.
2383 offs = lseek(s->fd, start, SEEK_HOLE);
2384 if (offs < 0) {
2385 return -errno; /* D1 and (H3 or H4) */
2388 if (offs < start) {
2389 /* This is not a valid return by lseek(). We are safe to just return
2390 * -EIO in this case, and we'll treat it like H4. */
2391 return -EIO;
2394 if (offs > start) {
2396 * D1 and H2: either in data, next hole at offs, or it was in
2397 * data but is now in a trailing hole. In the latter case,
2398 * all bets are off. Treating it as if it there was data all
2399 * the way to EOF is safe, so simply do that.
2401 *data = start;
2402 *hole = offs;
2403 return 0;
2406 /* D1 and H1 */
2407 return -EBUSY;
2408 #else
2409 return -ENOTSUP;
2410 #endif
2414 * Returns the allocation status of the specified offset.
2416 * The block layer guarantees 'offset' and 'bytes' are within bounds.
2418 * 'pnum' is set to the number of bytes (including and immediately following
2419 * the specified offset) that are known to be in the same
2420 * allocated/unallocated state.
2422 * 'bytes' is the max value 'pnum' should be set to.
2424 static int coroutine_fn raw_co_block_status(BlockDriverState *bs,
2425 bool want_zero,
2426 int64_t offset,
2427 int64_t bytes, int64_t *pnum,
2428 int64_t *map,
2429 BlockDriverState **file)
2431 off_t data = 0, hole = 0;
2432 int ret;
2434 ret = fd_open(bs);
2435 if (ret < 0) {
2436 return ret;
2439 if (!want_zero) {
2440 *pnum = bytes;
2441 *map = offset;
2442 *file = bs;
2443 return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
2446 ret = find_allocation(bs, offset, &data, &hole);
2447 if (ret == -ENXIO) {
2448 /* Trailing hole */
2449 *pnum = bytes;
2450 ret = BDRV_BLOCK_ZERO;
2451 } else if (ret < 0) {
2452 /* No info available, so pretend there are no holes */
2453 *pnum = bytes;
2454 ret = BDRV_BLOCK_DATA;
2455 } else if (data == offset) {
2456 /* On a data extent, compute bytes to the end of the extent,
2457 * possibly including a partial sector at EOF. */
2458 *pnum = MIN(bytes, hole - offset);
2459 ret = BDRV_BLOCK_DATA;
2460 } else {
2461 /* On a hole, compute bytes to the beginning of the next extent. */
2462 assert(hole == offset);
2463 *pnum = MIN(bytes, data - offset);
2464 ret = BDRV_BLOCK_ZERO;
2466 *map = offset;
2467 *file = bs;
2468 return ret | BDRV_BLOCK_OFFSET_VALID;
2471 #if defined(__linux__)
2472 /* Verify that the file is not in the page cache */
2473 static void check_cache_dropped(BlockDriverState *bs, Error **errp)
2475 const size_t window_size = 128 * 1024 * 1024;
2476 BDRVRawState *s = bs->opaque;
2477 void *window = NULL;
2478 size_t length = 0;
2479 unsigned char *vec;
2480 size_t page_size;
2481 off_t offset;
2482 off_t end;
2484 /* mincore(2) page status information requires 1 byte per page */
2485 page_size = sysconf(_SC_PAGESIZE);
2486 vec = g_malloc(DIV_ROUND_UP(window_size, page_size));
2488 end = raw_getlength(bs);
2490 for (offset = 0; offset < end; offset += window_size) {
2491 void *new_window;
2492 size_t new_length;
2493 size_t vec_end;
2494 size_t i;
2495 int ret;
2497 /* Unmap previous window if size has changed */
2498 new_length = MIN(end - offset, window_size);
2499 if (new_length != length) {
2500 munmap(window, length);
2501 window = NULL;
2502 length = 0;
2505 new_window = mmap(window, new_length, PROT_NONE, MAP_PRIVATE,
2506 s->fd, offset);
2507 if (new_window == MAP_FAILED) {
2508 error_setg_errno(errp, errno, "mmap failed");
2509 break;
2512 window = new_window;
2513 length = new_length;
2515 ret = mincore(window, length, vec);
2516 if (ret < 0) {
2517 error_setg_errno(errp, errno, "mincore failed");
2518 break;
2521 vec_end = DIV_ROUND_UP(length, page_size);
2522 for (i = 0; i < vec_end; i++) {
2523 if (vec[i] & 0x1) {
2524 error_setg(errp, "page cache still in use!");
2525 break;
2530 if (window) {
2531 munmap(window, length);
2534 g_free(vec);
2536 #endif /* __linux__ */
2538 static void coroutine_fn raw_co_invalidate_cache(BlockDriverState *bs,
2539 Error **errp)
2541 BDRVRawState *s = bs->opaque;
2542 int ret;
2544 ret = fd_open(bs);
2545 if (ret < 0) {
2546 error_setg_errno(errp, -ret, "The file descriptor is not open");
2547 return;
2550 if (s->open_flags & O_DIRECT) {
2551 return; /* No host kernel page cache */
2554 #if defined(__linux__)
2555 /* This sets the scene for the next syscall... */
2556 ret = bdrv_co_flush(bs);
2557 if (ret < 0) {
2558 error_setg_errno(errp, -ret, "flush failed");
2559 return;
2562 /* Linux does not invalidate pages that are dirty, locked, or mmapped by a
2563 * process. These limitations are okay because we just fsynced the file,
2564 * we don't use mmap, and the file should not be in use by other processes.
2566 ret = posix_fadvise(s->fd, 0, 0, POSIX_FADV_DONTNEED);
2567 if (ret != 0) { /* the return value is a positive errno */
2568 error_setg_errno(errp, ret, "fadvise failed");
2569 return;
2572 if (s->check_cache_dropped) {
2573 check_cache_dropped(bs, errp);
2575 #else /* __linux__ */
2576 /* Do nothing. Live migration to a remote host with cache.direct=off is
2577 * unsupported on other host operating systems. Cache consistency issues
2578 * may occur but no error is reported here, partly because that's the
2579 * historical behavior and partly because it's hard to differentiate valid
2580 * configurations that should not cause errors.
2582 #endif /* !__linux__ */
2585 static coroutine_fn int
2586 raw_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
2588 BDRVRawState *s = bs->opaque;
2590 return paio_submit_co(bs, s->fd, offset, NULL, bytes, QEMU_AIO_DISCARD);
2593 static int coroutine_fn raw_co_pwrite_zeroes(
2594 BlockDriverState *bs, int64_t offset,
2595 int bytes, BdrvRequestFlags flags)
2597 BDRVRawState *s = bs->opaque;
2598 int operation = QEMU_AIO_WRITE_ZEROES;
2600 if (flags & BDRV_REQ_MAY_UNMAP) {
2601 operation |= QEMU_AIO_DISCARD;
2604 return paio_submit_co(bs, s->fd, offset, NULL, bytes, operation);
2607 static int raw_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2609 BDRVRawState *s = bs->opaque;
2611 bdi->unallocated_blocks_are_zero = s->discard_zeroes;
2612 return 0;
2615 static QemuOptsList raw_create_opts = {
2616 .name = "raw-create-opts",
2617 .head = QTAILQ_HEAD_INITIALIZER(raw_create_opts.head),
2618 .desc = {
2620 .name = BLOCK_OPT_SIZE,
2621 .type = QEMU_OPT_SIZE,
2622 .help = "Virtual disk size"
2625 .name = BLOCK_OPT_NOCOW,
2626 .type = QEMU_OPT_BOOL,
2627 .help = "Turn off copy-on-write (valid only on btrfs)"
2630 .name = BLOCK_OPT_PREALLOC,
2631 .type = QEMU_OPT_STRING,
2632 .help = "Preallocation mode (allowed values: off, falloc, full)"
2634 { /* end of list */ }
2638 static int raw_check_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared,
2639 Error **errp)
2641 return raw_handle_perm_lock(bs, RAW_PL_PREPARE, perm, shared, errp);
2644 static void raw_set_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared)
2646 BDRVRawState *s = bs->opaque;
2647 raw_handle_perm_lock(bs, RAW_PL_COMMIT, perm, shared, NULL);
2648 s->perm = perm;
2649 s->shared_perm = shared;
2652 static void raw_abort_perm_update(BlockDriverState *bs)
2654 raw_handle_perm_lock(bs, RAW_PL_ABORT, 0, 0, NULL);
2657 static int coroutine_fn raw_co_copy_range_from(
2658 BlockDriverState *bs, BdrvChild *src, uint64_t src_offset,
2659 BdrvChild *dst, uint64_t dst_offset, uint64_t bytes,
2660 BdrvRequestFlags read_flags, BdrvRequestFlags write_flags)
2662 return bdrv_co_copy_range_to(src, src_offset, dst, dst_offset, bytes,
2663 read_flags, write_flags);
2666 static int coroutine_fn raw_co_copy_range_to(BlockDriverState *bs,
2667 BdrvChild *src,
2668 uint64_t src_offset,
2669 BdrvChild *dst,
2670 uint64_t dst_offset,
2671 uint64_t bytes,
2672 BdrvRequestFlags read_flags,
2673 BdrvRequestFlags write_flags)
2675 BDRVRawState *s = bs->opaque;
2676 BDRVRawState *src_s;
2678 assert(dst->bs == bs);
2679 if (src->bs->drv->bdrv_co_copy_range_to != raw_co_copy_range_to) {
2680 return -ENOTSUP;
2683 src_s = src->bs->opaque;
2684 if (fd_open(src->bs) < 0 || fd_open(dst->bs) < 0) {
2685 return -EIO;
2687 return paio_submit_co_full(bs, src_s->fd, src_offset, s->fd, dst_offset,
2688 NULL, bytes, QEMU_AIO_COPY_RANGE);
2691 BlockDriver bdrv_file = {
2692 .format_name = "file",
2693 .protocol_name = "file",
2694 .instance_size = sizeof(BDRVRawState),
2695 .bdrv_needs_filename = true,
2696 .bdrv_probe = NULL, /* no probe for protocols */
2697 .bdrv_parse_filename = raw_parse_filename,
2698 .bdrv_file_open = raw_open,
2699 .bdrv_reopen_prepare = raw_reopen_prepare,
2700 .bdrv_reopen_commit = raw_reopen_commit,
2701 .bdrv_reopen_abort = raw_reopen_abort,
2702 .bdrv_close = raw_close,
2703 .bdrv_co_create = raw_co_create,
2704 .bdrv_co_create_opts = raw_co_create_opts,
2705 .bdrv_has_zero_init = bdrv_has_zero_init_1,
2706 .bdrv_co_block_status = raw_co_block_status,
2707 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
2708 .bdrv_co_pwrite_zeroes = raw_co_pwrite_zeroes,
2710 .bdrv_co_preadv = raw_co_preadv,
2711 .bdrv_co_pwritev = raw_co_pwritev,
2712 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
2713 .bdrv_co_pdiscard = raw_co_pdiscard,
2714 .bdrv_co_copy_range_from = raw_co_copy_range_from,
2715 .bdrv_co_copy_range_to = raw_co_copy_range_to,
2716 .bdrv_refresh_limits = raw_refresh_limits,
2717 .bdrv_io_plug = raw_aio_plug,
2718 .bdrv_io_unplug = raw_aio_unplug,
2719 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
2721 .bdrv_co_truncate = raw_co_truncate,
2722 .bdrv_getlength = raw_getlength,
2723 .bdrv_get_info = raw_get_info,
2724 .bdrv_get_allocated_file_size
2725 = raw_get_allocated_file_size,
2726 .bdrv_check_perm = raw_check_perm,
2727 .bdrv_set_perm = raw_set_perm,
2728 .bdrv_abort_perm_update = raw_abort_perm_update,
2729 .create_opts = &raw_create_opts,
2732 /***********************************************/
2733 /* host device */
2735 #if defined(__APPLE__) && defined(__MACH__)
2736 static kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
2737 CFIndex maxPathSize, int flags);
2738 static char *FindEjectableOpticalMedia(io_iterator_t *mediaIterator)
2740 kern_return_t kernResult = KERN_FAILURE;
2741 mach_port_t masterPort;
2742 CFMutableDictionaryRef classesToMatch;
2743 const char *matching_array[] = {kIODVDMediaClass, kIOCDMediaClass};
2744 char *mediaType = NULL;
2746 kernResult = IOMasterPort( MACH_PORT_NULL, &masterPort );
2747 if ( KERN_SUCCESS != kernResult ) {
2748 printf( "IOMasterPort returned %d\n", kernResult );
2751 int index;
2752 for (index = 0; index < ARRAY_SIZE(matching_array); index++) {
2753 classesToMatch = IOServiceMatching(matching_array[index]);
2754 if (classesToMatch == NULL) {
2755 error_report("IOServiceMatching returned NULL for %s",
2756 matching_array[index]);
2757 continue;
2759 CFDictionarySetValue(classesToMatch, CFSTR(kIOMediaEjectableKey),
2760 kCFBooleanTrue);
2761 kernResult = IOServiceGetMatchingServices(masterPort, classesToMatch,
2762 mediaIterator);
2763 if (kernResult != KERN_SUCCESS) {
2764 error_report("Note: IOServiceGetMatchingServices returned %d",
2765 kernResult);
2766 continue;
2769 /* If a match was found, leave the loop */
2770 if (*mediaIterator != 0) {
2771 DPRINTF("Matching using %s\n", matching_array[index]);
2772 mediaType = g_strdup(matching_array[index]);
2773 break;
2776 return mediaType;
2779 kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
2780 CFIndex maxPathSize, int flags)
2782 io_object_t nextMedia;
2783 kern_return_t kernResult = KERN_FAILURE;
2784 *bsdPath = '\0';
2785 nextMedia = IOIteratorNext( mediaIterator );
2786 if ( nextMedia )
2788 CFTypeRef bsdPathAsCFString;
2789 bsdPathAsCFString = IORegistryEntryCreateCFProperty( nextMedia, CFSTR( kIOBSDNameKey ), kCFAllocatorDefault, 0 );
2790 if ( bsdPathAsCFString ) {
2791 size_t devPathLength;
2792 strcpy( bsdPath, _PATH_DEV );
2793 if (flags & BDRV_O_NOCACHE) {
2794 strcat(bsdPath, "r");
2796 devPathLength = strlen( bsdPath );
2797 if ( CFStringGetCString( bsdPathAsCFString, bsdPath + devPathLength, maxPathSize - devPathLength, kCFStringEncodingASCII ) ) {
2798 kernResult = KERN_SUCCESS;
2800 CFRelease( bsdPathAsCFString );
2802 IOObjectRelease( nextMedia );
2805 return kernResult;
2808 /* Sets up a real cdrom for use in QEMU */
2809 static bool setup_cdrom(char *bsd_path, Error **errp)
2811 int index, num_of_test_partitions = 2, fd;
2812 char test_partition[MAXPATHLEN];
2813 bool partition_found = false;
2815 /* look for a working partition */
2816 for (index = 0; index < num_of_test_partitions; index++) {
2817 snprintf(test_partition, sizeof(test_partition), "%ss%d", bsd_path,
2818 index);
2819 fd = qemu_open(test_partition, O_RDONLY | O_BINARY | O_LARGEFILE);
2820 if (fd >= 0) {
2821 partition_found = true;
2822 qemu_close(fd);
2823 break;
2827 /* if a working partition on the device was not found */
2828 if (partition_found == false) {
2829 error_setg(errp, "Failed to find a working partition on disc");
2830 } else {
2831 DPRINTF("Using %s as optical disc\n", test_partition);
2832 pstrcpy(bsd_path, MAXPATHLEN, test_partition);
2834 return partition_found;
2837 /* Prints directions on mounting and unmounting a device */
2838 static void print_unmounting_directions(const char *file_name)
2840 error_report("If device %s is mounted on the desktop, unmount"
2841 " it first before using it in QEMU", file_name);
2842 error_report("Command to unmount device: diskutil unmountDisk %s",
2843 file_name);
2844 error_report("Command to mount device: diskutil mountDisk %s", file_name);
2847 #endif /* defined(__APPLE__) && defined(__MACH__) */
2849 static int hdev_probe_device(const char *filename)
2851 struct stat st;
2853 /* allow a dedicated CD-ROM driver to match with a higher priority */
2854 if (strstart(filename, "/dev/cdrom", NULL))
2855 return 50;
2857 if (stat(filename, &st) >= 0 &&
2858 (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
2859 return 100;
2862 return 0;
2865 static int check_hdev_writable(BDRVRawState *s)
2867 #if defined(BLKROGET)
2868 /* Linux block devices can be configured "read-only" using blockdev(8).
2869 * This is independent of device node permissions and therefore open(2)
2870 * with O_RDWR succeeds. Actual writes fail with EPERM.
2872 * bdrv_open() is supposed to fail if the disk is read-only. Explicitly
2873 * check for read-only block devices so that Linux block devices behave
2874 * properly.
2876 struct stat st;
2877 int readonly = 0;
2879 if (fstat(s->fd, &st)) {
2880 return -errno;
2883 if (!S_ISBLK(st.st_mode)) {
2884 return 0;
2887 if (ioctl(s->fd, BLKROGET, &readonly) < 0) {
2888 return -errno;
2891 if (readonly) {
2892 return -EACCES;
2894 #endif /* defined(BLKROGET) */
2895 return 0;
2898 static void hdev_parse_filename(const char *filename, QDict *options,
2899 Error **errp)
2901 bdrv_parse_filename_strip_prefix(filename, "host_device:", options);
2904 static bool hdev_is_sg(BlockDriverState *bs)
2907 #if defined(__linux__)
2909 BDRVRawState *s = bs->opaque;
2910 struct stat st;
2911 struct sg_scsi_id scsiid;
2912 int sg_version;
2913 int ret;
2915 if (stat(bs->filename, &st) < 0 || !S_ISCHR(st.st_mode)) {
2916 return false;
2919 ret = ioctl(s->fd, SG_GET_VERSION_NUM, &sg_version);
2920 if (ret < 0) {
2921 return false;
2924 ret = ioctl(s->fd, SG_GET_SCSI_ID, &scsiid);
2925 if (ret >= 0) {
2926 DPRINTF("SG device found: type=%d, version=%d\n",
2927 scsiid.scsi_type, sg_version);
2928 return true;
2931 #endif
2933 return false;
2936 static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
2937 Error **errp)
2939 BDRVRawState *s = bs->opaque;
2940 Error *local_err = NULL;
2941 int ret;
2943 #if defined(__APPLE__) && defined(__MACH__)
2945 * Caution: while qdict_get_str() is fine, getting non-string types
2946 * would require more care. When @options come from -blockdev or
2947 * blockdev_add, its members are typed according to the QAPI
2948 * schema, but when they come from -drive, they're all QString.
2950 const char *filename = qdict_get_str(options, "filename");
2951 char bsd_path[MAXPATHLEN] = "";
2952 bool error_occurred = false;
2954 /* If using a real cdrom */
2955 if (strcmp(filename, "/dev/cdrom") == 0) {
2956 char *mediaType = NULL;
2957 kern_return_t ret_val;
2958 io_iterator_t mediaIterator = 0;
2960 mediaType = FindEjectableOpticalMedia(&mediaIterator);
2961 if (mediaType == NULL) {
2962 error_setg(errp, "Please make sure your CD/DVD is in the optical"
2963 " drive");
2964 error_occurred = true;
2965 goto hdev_open_Mac_error;
2968 ret_val = GetBSDPath(mediaIterator, bsd_path, sizeof(bsd_path), flags);
2969 if (ret_val != KERN_SUCCESS) {
2970 error_setg(errp, "Could not get BSD path for optical drive");
2971 error_occurred = true;
2972 goto hdev_open_Mac_error;
2975 /* If a real optical drive was not found */
2976 if (bsd_path[0] == '\0') {
2977 error_setg(errp, "Failed to obtain bsd path for optical drive");
2978 error_occurred = true;
2979 goto hdev_open_Mac_error;
2982 /* If using a cdrom disc and finding a partition on the disc failed */
2983 if (strncmp(mediaType, kIOCDMediaClass, 9) == 0 &&
2984 setup_cdrom(bsd_path, errp) == false) {
2985 print_unmounting_directions(bsd_path);
2986 error_occurred = true;
2987 goto hdev_open_Mac_error;
2990 qdict_put_str(options, "filename", bsd_path);
2992 hdev_open_Mac_error:
2993 g_free(mediaType);
2994 if (mediaIterator) {
2995 IOObjectRelease(mediaIterator);
2997 if (error_occurred) {
2998 return -ENOENT;
3001 #endif /* defined(__APPLE__) && defined(__MACH__) */
3003 s->type = FTYPE_FILE;
3005 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3006 if (ret < 0) {
3007 error_propagate(errp, local_err);
3008 #if defined(__APPLE__) && defined(__MACH__)
3009 if (*bsd_path) {
3010 filename = bsd_path;
3012 /* if a physical device experienced an error while being opened */
3013 if (strncmp(filename, "/dev/", 5) == 0) {
3014 print_unmounting_directions(filename);
3016 #endif /* defined(__APPLE__) && defined(__MACH__) */
3017 return ret;
3020 /* Since this does ioctl the device must be already opened */
3021 bs->sg = hdev_is_sg(bs);
3023 if (flags & BDRV_O_RDWR) {
3024 ret = check_hdev_writable(s);
3025 if (ret < 0) {
3026 raw_close(bs);
3027 error_setg_errno(errp, -ret, "The device is not writable");
3028 return ret;
3032 return ret;
3035 #if defined(__linux__)
3037 static BlockAIOCB *hdev_aio_ioctl(BlockDriverState *bs,
3038 unsigned long int req, void *buf,
3039 BlockCompletionFunc *cb, void *opaque)
3041 BDRVRawState *s = bs->opaque;
3042 RawPosixAIOData *acb;
3043 ThreadPool *pool;
3045 if (fd_open(bs) < 0)
3046 return NULL;
3048 if (req == SG_IO && s->pr_mgr) {
3049 struct sg_io_hdr *io_hdr = buf;
3050 if (io_hdr->cmdp[0] == PERSISTENT_RESERVE_OUT ||
3051 io_hdr->cmdp[0] == PERSISTENT_RESERVE_IN) {
3052 return pr_manager_execute(s->pr_mgr, bdrv_get_aio_context(bs),
3053 s->fd, io_hdr, cb, opaque);
3057 acb = g_new(RawPosixAIOData, 1);
3058 acb->bs = bs;
3059 acb->aio_type = QEMU_AIO_IOCTL;
3060 acb->aio_fildes = s->fd;
3061 acb->aio_offset = 0;
3062 acb->aio_ioctl_buf = buf;
3063 acb->aio_ioctl_cmd = req;
3064 pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
3065 return thread_pool_submit_aio(pool, aio_worker, acb, cb, opaque);
3067 #endif /* linux */
3069 static int fd_open(BlockDriverState *bs)
3071 BDRVRawState *s = bs->opaque;
3073 /* this is just to ensure s->fd is sane (its called by io ops) */
3074 if (s->fd >= 0)
3075 return 0;
3076 return -EIO;
3079 static coroutine_fn int
3080 hdev_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
3082 BDRVRawState *s = bs->opaque;
3083 int ret;
3085 ret = fd_open(bs);
3086 if (ret < 0) {
3087 return ret;
3089 return paio_submit_co(bs, s->fd, offset, NULL, bytes,
3090 QEMU_AIO_DISCARD | QEMU_AIO_BLKDEV);
3093 static coroutine_fn int hdev_co_pwrite_zeroes(BlockDriverState *bs,
3094 int64_t offset, int bytes, BdrvRequestFlags flags)
3096 BDRVRawState *s = bs->opaque;
3097 int operation = QEMU_AIO_WRITE_ZEROES | QEMU_AIO_BLKDEV;
3098 int rc;
3100 rc = fd_open(bs);
3101 if (rc < 0) {
3102 return rc;
3105 if (flags & BDRV_REQ_MAY_UNMAP) {
3106 operation |= QEMU_AIO_DISCARD;
3109 return paio_submit_co(bs, s->fd, offset, NULL, bytes, operation);
3112 static int coroutine_fn hdev_co_create_opts(const char *filename, QemuOpts *opts,
3113 Error **errp)
3115 int fd;
3116 int ret = 0;
3117 struct stat stat_buf;
3118 int64_t total_size = 0;
3119 bool has_prefix;
3121 /* This function is used by both protocol block drivers and therefore either
3122 * of these prefixes may be given.
3123 * The return value has to be stored somewhere, otherwise this is an error
3124 * due to -Werror=unused-value. */
3125 has_prefix =
3126 strstart(filename, "host_device:", &filename) ||
3127 strstart(filename, "host_cdrom:" , &filename);
3129 (void)has_prefix;
3131 ret = raw_normalize_devicepath(&filename);
3132 if (ret < 0) {
3133 error_setg_errno(errp, -ret, "Could not normalize device path");
3134 return ret;
3137 /* Read out options */
3138 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
3139 BDRV_SECTOR_SIZE);
3141 fd = qemu_open(filename, O_WRONLY | O_BINARY);
3142 if (fd < 0) {
3143 ret = -errno;
3144 error_setg_errno(errp, -ret, "Could not open device");
3145 return ret;
3148 if (fstat(fd, &stat_buf) < 0) {
3149 ret = -errno;
3150 error_setg_errno(errp, -ret, "Could not stat device");
3151 } else if (!S_ISBLK(stat_buf.st_mode) && !S_ISCHR(stat_buf.st_mode)) {
3152 error_setg(errp,
3153 "The given file is neither a block nor a character device");
3154 ret = -ENODEV;
3155 } else if (lseek(fd, 0, SEEK_END) < total_size) {
3156 error_setg(errp, "Device is too small");
3157 ret = -ENOSPC;
3160 if (!ret && total_size) {
3161 uint8_t buf[BDRV_SECTOR_SIZE] = { 0 };
3162 int64_t zero_size = MIN(BDRV_SECTOR_SIZE, total_size);
3163 if (lseek(fd, 0, SEEK_SET) == -1) {
3164 ret = -errno;
3165 } else {
3166 ret = qemu_write_full(fd, buf, zero_size);
3167 ret = ret == zero_size ? 0 : -errno;
3170 qemu_close(fd);
3171 return ret;
3174 static BlockDriver bdrv_host_device = {
3175 .format_name = "host_device",
3176 .protocol_name = "host_device",
3177 .instance_size = sizeof(BDRVRawState),
3178 .bdrv_needs_filename = true,
3179 .bdrv_probe_device = hdev_probe_device,
3180 .bdrv_parse_filename = hdev_parse_filename,
3181 .bdrv_file_open = hdev_open,
3182 .bdrv_close = raw_close,
3183 .bdrv_reopen_prepare = raw_reopen_prepare,
3184 .bdrv_reopen_commit = raw_reopen_commit,
3185 .bdrv_reopen_abort = raw_reopen_abort,
3186 .bdrv_co_create_opts = hdev_co_create_opts,
3187 .create_opts = &raw_create_opts,
3188 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3189 .bdrv_co_pwrite_zeroes = hdev_co_pwrite_zeroes,
3191 .bdrv_co_preadv = raw_co_preadv,
3192 .bdrv_co_pwritev = raw_co_pwritev,
3193 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3194 .bdrv_co_pdiscard = hdev_co_pdiscard,
3195 .bdrv_co_copy_range_from = raw_co_copy_range_from,
3196 .bdrv_co_copy_range_to = raw_co_copy_range_to,
3197 .bdrv_refresh_limits = raw_refresh_limits,
3198 .bdrv_io_plug = raw_aio_plug,
3199 .bdrv_io_unplug = raw_aio_unplug,
3200 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3202 .bdrv_co_truncate = raw_co_truncate,
3203 .bdrv_getlength = raw_getlength,
3204 .bdrv_get_info = raw_get_info,
3205 .bdrv_get_allocated_file_size
3206 = raw_get_allocated_file_size,
3207 .bdrv_check_perm = raw_check_perm,
3208 .bdrv_set_perm = raw_set_perm,
3209 .bdrv_abort_perm_update = raw_abort_perm_update,
3210 .bdrv_probe_blocksizes = hdev_probe_blocksizes,
3211 .bdrv_probe_geometry = hdev_probe_geometry,
3213 /* generic scsi device */
3214 #ifdef __linux__
3215 .bdrv_aio_ioctl = hdev_aio_ioctl,
3216 #endif
3219 #if defined(__linux__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3220 static void cdrom_parse_filename(const char *filename, QDict *options,
3221 Error **errp)
3223 bdrv_parse_filename_strip_prefix(filename, "host_cdrom:", options);
3225 #endif
3227 #ifdef __linux__
3228 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3229 Error **errp)
3231 BDRVRawState *s = bs->opaque;
3233 s->type = FTYPE_CD;
3235 /* open will not fail even if no CD is inserted, so add O_NONBLOCK */
3236 return raw_open_common(bs, options, flags, O_NONBLOCK, true, errp);
3239 static int cdrom_probe_device(const char *filename)
3241 int fd, ret;
3242 int prio = 0;
3243 struct stat st;
3245 fd = qemu_open(filename, O_RDONLY | O_NONBLOCK);
3246 if (fd < 0) {
3247 goto out;
3249 ret = fstat(fd, &st);
3250 if (ret == -1 || !S_ISBLK(st.st_mode)) {
3251 goto outc;
3254 /* Attempt to detect via a CDROM specific ioctl */
3255 ret = ioctl(fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3256 if (ret >= 0)
3257 prio = 100;
3259 outc:
3260 qemu_close(fd);
3261 out:
3262 return prio;
3265 static bool cdrom_is_inserted(BlockDriverState *bs)
3267 BDRVRawState *s = bs->opaque;
3268 int ret;
3270 ret = ioctl(s->fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3271 return ret == CDS_DISC_OK;
3274 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3276 BDRVRawState *s = bs->opaque;
3278 if (eject_flag) {
3279 if (ioctl(s->fd, CDROMEJECT, NULL) < 0)
3280 perror("CDROMEJECT");
3281 } else {
3282 if (ioctl(s->fd, CDROMCLOSETRAY, NULL) < 0)
3283 perror("CDROMEJECT");
3287 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3289 BDRVRawState *s = bs->opaque;
3291 if (ioctl(s->fd, CDROM_LOCKDOOR, locked) < 0) {
3293 * Note: an error can happen if the distribution automatically
3294 * mounts the CD-ROM
3296 /* perror("CDROM_LOCKDOOR"); */
3300 static BlockDriver bdrv_host_cdrom = {
3301 .format_name = "host_cdrom",
3302 .protocol_name = "host_cdrom",
3303 .instance_size = sizeof(BDRVRawState),
3304 .bdrv_needs_filename = true,
3305 .bdrv_probe_device = cdrom_probe_device,
3306 .bdrv_parse_filename = cdrom_parse_filename,
3307 .bdrv_file_open = cdrom_open,
3308 .bdrv_close = raw_close,
3309 .bdrv_reopen_prepare = raw_reopen_prepare,
3310 .bdrv_reopen_commit = raw_reopen_commit,
3311 .bdrv_reopen_abort = raw_reopen_abort,
3312 .bdrv_co_create_opts = hdev_co_create_opts,
3313 .create_opts = &raw_create_opts,
3314 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3317 .bdrv_co_preadv = raw_co_preadv,
3318 .bdrv_co_pwritev = raw_co_pwritev,
3319 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3320 .bdrv_refresh_limits = raw_refresh_limits,
3321 .bdrv_io_plug = raw_aio_plug,
3322 .bdrv_io_unplug = raw_aio_unplug,
3323 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3325 .bdrv_co_truncate = raw_co_truncate,
3326 .bdrv_getlength = raw_getlength,
3327 .has_variable_length = true,
3328 .bdrv_get_allocated_file_size
3329 = raw_get_allocated_file_size,
3331 /* removable device support */
3332 .bdrv_is_inserted = cdrom_is_inserted,
3333 .bdrv_eject = cdrom_eject,
3334 .bdrv_lock_medium = cdrom_lock_medium,
3336 /* generic scsi device */
3337 .bdrv_aio_ioctl = hdev_aio_ioctl,
3339 #endif /* __linux__ */
3341 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
3342 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3343 Error **errp)
3345 BDRVRawState *s = bs->opaque;
3346 Error *local_err = NULL;
3347 int ret;
3349 s->type = FTYPE_CD;
3351 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3352 if (ret) {
3353 error_propagate(errp, local_err);
3354 return ret;
3357 /* make sure the door isn't locked at this time */
3358 ioctl(s->fd, CDIOCALLOW);
3359 return 0;
3362 static int cdrom_probe_device(const char *filename)
3364 if (strstart(filename, "/dev/cd", NULL) ||
3365 strstart(filename, "/dev/acd", NULL))
3366 return 100;
3367 return 0;
3370 static int cdrom_reopen(BlockDriverState *bs)
3372 BDRVRawState *s = bs->opaque;
3373 int fd;
3376 * Force reread of possibly changed/newly loaded disc,
3377 * FreeBSD seems to not notice sometimes...
3379 if (s->fd >= 0)
3380 qemu_close(s->fd);
3381 fd = qemu_open(bs->filename, s->open_flags, 0644);
3382 if (fd < 0) {
3383 s->fd = -1;
3384 return -EIO;
3386 s->fd = fd;
3388 /* make sure the door isn't locked at this time */
3389 ioctl(s->fd, CDIOCALLOW);
3390 return 0;
3393 static bool cdrom_is_inserted(BlockDriverState *bs)
3395 return raw_getlength(bs) > 0;
3398 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3400 BDRVRawState *s = bs->opaque;
3402 if (s->fd < 0)
3403 return;
3405 (void) ioctl(s->fd, CDIOCALLOW);
3407 if (eject_flag) {
3408 if (ioctl(s->fd, CDIOCEJECT) < 0)
3409 perror("CDIOCEJECT");
3410 } else {
3411 if (ioctl(s->fd, CDIOCCLOSE) < 0)
3412 perror("CDIOCCLOSE");
3415 cdrom_reopen(bs);
3418 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3420 BDRVRawState *s = bs->opaque;
3422 if (s->fd < 0)
3423 return;
3424 if (ioctl(s->fd, (locked ? CDIOCPREVENT : CDIOCALLOW)) < 0) {
3426 * Note: an error can happen if the distribution automatically
3427 * mounts the CD-ROM
3429 /* perror("CDROM_LOCKDOOR"); */
3433 static BlockDriver bdrv_host_cdrom = {
3434 .format_name = "host_cdrom",
3435 .protocol_name = "host_cdrom",
3436 .instance_size = sizeof(BDRVRawState),
3437 .bdrv_needs_filename = true,
3438 .bdrv_probe_device = cdrom_probe_device,
3439 .bdrv_parse_filename = cdrom_parse_filename,
3440 .bdrv_file_open = cdrom_open,
3441 .bdrv_close = raw_close,
3442 .bdrv_reopen_prepare = raw_reopen_prepare,
3443 .bdrv_reopen_commit = raw_reopen_commit,
3444 .bdrv_reopen_abort = raw_reopen_abort,
3445 .bdrv_co_create_opts = hdev_co_create_opts,
3446 .create_opts = &raw_create_opts,
3448 .bdrv_co_preadv = raw_co_preadv,
3449 .bdrv_co_pwritev = raw_co_pwritev,
3450 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3451 .bdrv_refresh_limits = raw_refresh_limits,
3452 .bdrv_io_plug = raw_aio_plug,
3453 .bdrv_io_unplug = raw_aio_unplug,
3454 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3456 .bdrv_co_truncate = raw_co_truncate,
3457 .bdrv_getlength = raw_getlength,
3458 .has_variable_length = true,
3459 .bdrv_get_allocated_file_size
3460 = raw_get_allocated_file_size,
3462 /* removable device support */
3463 .bdrv_is_inserted = cdrom_is_inserted,
3464 .bdrv_eject = cdrom_eject,
3465 .bdrv_lock_medium = cdrom_lock_medium,
3467 #endif /* __FreeBSD__ */
3469 static void bdrv_file_init(void)
3472 * Register all the drivers. Note that order is important, the driver
3473 * registered last will get probed first.
3475 bdrv_register(&bdrv_file);
3476 bdrv_register(&bdrv_host_device);
3477 #ifdef __linux__
3478 bdrv_register(&bdrv_host_cdrom);
3479 #endif
3480 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3481 bdrv_register(&bdrv_host_cdrom);
3482 #endif
3485 block_init(bdrv_file_init);