tpm_emulator: Translate TPM error codes to strings
[qemu/ar7.git] / block / file-posix.c
blobdf467f510b963e78dfc6bc56853a8c598ef3a3a3
1 /*
2 * Block driver for RAW files (posix)
4 * Copyright (c) 2006 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
27 #include "qemu/cutils.h"
28 #include "qemu/error-report.h"
29 #include "block/block_int.h"
30 #include "qemu/module.h"
31 #include "qemu/option.h"
32 #include "trace.h"
33 #include "block/thread-pool.h"
34 #include "qemu/iov.h"
35 #include "block/raw-aio.h"
36 #include "qapi/qmp/qdict.h"
37 #include "qapi/qmp/qstring.h"
39 #include "scsi/pr-manager.h"
40 #include "scsi/constants.h"
42 #if defined(__APPLE__) && (__MACH__)
43 #include <paths.h>
44 #include <sys/param.h>
45 #include <IOKit/IOKitLib.h>
46 #include <IOKit/IOBSD.h>
47 #include <IOKit/storage/IOMediaBSDClient.h>
48 #include <IOKit/storage/IOMedia.h>
49 #include <IOKit/storage/IOCDMedia.h>
50 //#include <IOKit/storage/IOCDTypes.h>
51 #include <IOKit/storage/IODVDMedia.h>
52 #include <CoreFoundation/CoreFoundation.h>
53 #endif
55 #ifdef __sun__
56 #define _POSIX_PTHREAD_SEMANTICS 1
57 #include <sys/dkio.h>
58 #endif
59 #ifdef __linux__
60 #include <sys/ioctl.h>
61 #include <sys/param.h>
62 #include <sys/syscall.h>
63 #include <linux/cdrom.h>
64 #include <linux/fd.h>
65 #include <linux/fs.h>
66 #include <linux/hdreg.h>
67 #include <scsi/sg.h>
68 #ifdef __s390__
69 #include <asm/dasd.h>
70 #endif
71 #ifndef FS_NOCOW_FL
72 #define FS_NOCOW_FL 0x00800000 /* Do not cow file */
73 #endif
74 #endif
75 #if defined(CONFIG_FALLOCATE_PUNCH_HOLE) || defined(CONFIG_FALLOCATE_ZERO_RANGE)
76 #include <linux/falloc.h>
77 #endif
78 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
79 #include <sys/disk.h>
80 #include <sys/cdio.h>
81 #endif
83 #ifdef __OpenBSD__
84 #include <sys/ioctl.h>
85 #include <sys/disklabel.h>
86 #include <sys/dkio.h>
87 #endif
89 #ifdef __NetBSD__
90 #include <sys/ioctl.h>
91 #include <sys/disklabel.h>
92 #include <sys/dkio.h>
93 #include <sys/disk.h>
94 #endif
96 #ifdef __DragonFly__
97 #include <sys/ioctl.h>
98 #include <sys/diskslice.h>
99 #endif
101 #ifdef CONFIG_XFS
102 #include <xfs/xfs.h>
103 #endif
105 //#define DEBUG_BLOCK
107 #ifdef DEBUG_BLOCK
108 # define DEBUG_BLOCK_PRINT 1
109 #else
110 # define DEBUG_BLOCK_PRINT 0
111 #endif
112 #define DPRINTF(fmt, ...) \
113 do { \
114 if (DEBUG_BLOCK_PRINT) { \
115 printf(fmt, ## __VA_ARGS__); \
117 } while (0)
119 /* OS X does not have O_DSYNC */
120 #ifndef O_DSYNC
121 #ifdef O_SYNC
122 #define O_DSYNC O_SYNC
123 #elif defined(O_FSYNC)
124 #define O_DSYNC O_FSYNC
125 #endif
126 #endif
128 /* Approximate O_DIRECT with O_DSYNC if O_DIRECT isn't available */
129 #ifndef O_DIRECT
130 #define O_DIRECT O_DSYNC
131 #endif
133 #define FTYPE_FILE 0
134 #define FTYPE_CD 1
136 #define MAX_BLOCKSIZE 4096
138 /* Posix file locking bytes. Libvirt takes byte 0, we start from higher bytes,
139 * leaving a few more bytes for its future use. */
140 #define RAW_LOCK_PERM_BASE 100
141 #define RAW_LOCK_SHARED_BASE 200
143 typedef struct BDRVRawState {
144 int fd;
145 bool use_lock;
146 int type;
147 int open_flags;
148 size_t buf_align;
150 /* The current permissions. */
151 uint64_t perm;
152 uint64_t shared_perm;
154 /* The perms bits whose corresponding bytes are already locked in
155 * s->fd. */
156 uint64_t locked_perm;
157 uint64_t locked_shared_perm;
159 #ifdef CONFIG_XFS
160 bool is_xfs:1;
161 #endif
162 bool has_discard:1;
163 bool has_write_zeroes:1;
164 bool discard_zeroes:1;
165 bool use_linux_aio:1;
166 bool page_cache_inconsistent:1;
167 bool has_fallocate;
168 bool needs_alignment;
169 bool check_cache_dropped;
171 PRManager *pr_mgr;
172 } BDRVRawState;
174 typedef struct BDRVRawReopenState {
175 int fd;
176 int open_flags;
177 bool check_cache_dropped;
178 } BDRVRawReopenState;
180 static int fd_open(BlockDriverState *bs);
181 static int64_t raw_getlength(BlockDriverState *bs);
183 typedef struct RawPosixAIOData {
184 BlockDriverState *bs;
185 int aio_fildes;
186 union {
187 struct iovec *aio_iov;
188 void *aio_ioctl_buf;
190 int aio_niov;
191 uint64_t aio_nbytes;
192 #define aio_ioctl_cmd aio_nbytes /* for QEMU_AIO_IOCTL */
193 off_t aio_offset;
194 int aio_type;
195 union {
196 struct {
197 int aio_fd2;
198 off_t aio_offset2;
200 struct {
201 PreallocMode prealloc;
202 Error **errp;
205 } RawPosixAIOData;
207 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
208 static int cdrom_reopen(BlockDriverState *bs);
209 #endif
211 #if defined(__NetBSD__)
212 static int raw_normalize_devicepath(const char **filename, Error **errp)
214 static char namebuf[PATH_MAX];
215 const char *dp, *fname;
216 struct stat sb;
218 fname = *filename;
219 dp = strrchr(fname, '/');
220 if (lstat(fname, &sb) < 0) {
221 error_setg_errno(errp, errno, "%s: stat failed", fname);
222 return -errno;
225 if (!S_ISBLK(sb.st_mode)) {
226 return 0;
229 if (dp == NULL) {
230 snprintf(namebuf, PATH_MAX, "r%s", fname);
231 } else {
232 snprintf(namebuf, PATH_MAX, "%.*s/r%s",
233 (int)(dp - fname), fname, dp + 1);
235 *filename = namebuf;
236 warn_report("%s is a block device, using %s", fname, *filename);
238 return 0;
240 #else
241 static int raw_normalize_devicepath(const char **filename, Error **errp)
243 return 0;
245 #endif
248 * Get logical block size via ioctl. On success store it in @sector_size_p.
250 static int probe_logical_blocksize(int fd, unsigned int *sector_size_p)
252 unsigned int sector_size;
253 bool success = false;
254 int i;
256 errno = ENOTSUP;
257 static const unsigned long ioctl_list[] = {
258 #ifdef BLKSSZGET
259 BLKSSZGET,
260 #endif
261 #ifdef DKIOCGETBLOCKSIZE
262 DKIOCGETBLOCKSIZE,
263 #endif
264 #ifdef DIOCGSECTORSIZE
265 DIOCGSECTORSIZE,
266 #endif
269 /* Try a few ioctls to get the right size */
270 for (i = 0; i < (int)ARRAY_SIZE(ioctl_list); i++) {
271 if (ioctl(fd, ioctl_list[i], &sector_size) >= 0) {
272 *sector_size_p = sector_size;
273 success = true;
277 return success ? 0 : -errno;
281 * Get physical block size of @fd.
282 * On success, store it in @blk_size and return 0.
283 * On failure, return -errno.
285 static int probe_physical_blocksize(int fd, unsigned int *blk_size)
287 #ifdef BLKPBSZGET
288 if (ioctl(fd, BLKPBSZGET, blk_size) < 0) {
289 return -errno;
291 return 0;
292 #else
293 return -ENOTSUP;
294 #endif
297 /* Check if read is allowed with given memory buffer and length.
299 * This function is used to check O_DIRECT memory buffer and request alignment.
301 static bool raw_is_io_aligned(int fd, void *buf, size_t len)
303 ssize_t ret = pread(fd, buf, len, 0);
305 if (ret >= 0) {
306 return true;
309 #ifdef __linux__
310 /* The Linux kernel returns EINVAL for misaligned O_DIRECT reads. Ignore
311 * other errors (e.g. real I/O error), which could happen on a failed
312 * drive, since we only care about probing alignment.
314 if (errno != EINVAL) {
315 return true;
317 #endif
319 return false;
322 static void raw_probe_alignment(BlockDriverState *bs, int fd, Error **errp)
324 BDRVRawState *s = bs->opaque;
325 char *buf;
326 size_t max_align = MAX(MAX_BLOCKSIZE, getpagesize());
328 /* For SCSI generic devices the alignment is not really used.
329 With buffered I/O, we don't have any restrictions. */
330 if (bdrv_is_sg(bs) || !s->needs_alignment) {
331 bs->bl.request_alignment = 1;
332 s->buf_align = 1;
333 return;
336 bs->bl.request_alignment = 0;
337 s->buf_align = 0;
338 /* Let's try to use the logical blocksize for the alignment. */
339 if (probe_logical_blocksize(fd, &bs->bl.request_alignment) < 0) {
340 bs->bl.request_alignment = 0;
342 #ifdef CONFIG_XFS
343 if (s->is_xfs) {
344 struct dioattr da;
345 if (xfsctl(NULL, fd, XFS_IOC_DIOINFO, &da) >= 0) {
346 bs->bl.request_alignment = da.d_miniosz;
347 /* The kernel returns wrong information for d_mem */
348 /* s->buf_align = da.d_mem; */
351 #endif
353 /* If we could not get the sizes so far, we can only guess them */
354 if (!s->buf_align) {
355 size_t align;
356 buf = qemu_memalign(max_align, 2 * max_align);
357 for (align = 512; align <= max_align; align <<= 1) {
358 if (raw_is_io_aligned(fd, buf + align, max_align)) {
359 s->buf_align = align;
360 break;
363 qemu_vfree(buf);
366 if (!bs->bl.request_alignment) {
367 size_t align;
368 buf = qemu_memalign(s->buf_align, max_align);
369 for (align = 512; align <= max_align; align <<= 1) {
370 if (raw_is_io_aligned(fd, buf, align)) {
371 bs->bl.request_alignment = align;
372 break;
375 qemu_vfree(buf);
378 if (!s->buf_align || !bs->bl.request_alignment) {
379 error_setg(errp, "Could not find working O_DIRECT alignment");
380 error_append_hint(errp, "Try cache.direct=off\n");
384 static void raw_parse_flags(int bdrv_flags, int *open_flags)
386 assert(open_flags != NULL);
388 *open_flags |= O_BINARY;
389 *open_flags &= ~O_ACCMODE;
390 if (bdrv_flags & BDRV_O_RDWR) {
391 *open_flags |= O_RDWR;
392 } else {
393 *open_flags |= O_RDONLY;
396 /* Use O_DSYNC for write-through caching, no flags for write-back caching,
397 * and O_DIRECT for no caching. */
398 if ((bdrv_flags & BDRV_O_NOCACHE)) {
399 *open_flags |= O_DIRECT;
403 static void raw_parse_filename(const char *filename, QDict *options,
404 Error **errp)
406 bdrv_parse_filename_strip_prefix(filename, "file:", options);
409 static QemuOptsList raw_runtime_opts = {
410 .name = "raw",
411 .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
412 .desc = {
414 .name = "filename",
415 .type = QEMU_OPT_STRING,
416 .help = "File name of the image",
419 .name = "aio",
420 .type = QEMU_OPT_STRING,
421 .help = "host AIO implementation (threads, native)",
424 .name = "locking",
425 .type = QEMU_OPT_STRING,
426 .help = "file locking mode (on/off/auto, default: auto)",
429 .name = "pr-manager",
430 .type = QEMU_OPT_STRING,
431 .help = "id of persistent reservation manager object (default: none)",
434 .name = "x-check-cache-dropped",
435 .type = QEMU_OPT_BOOL,
436 .help = "check that page cache was dropped on live migration (default: off)"
438 { /* end of list */ }
442 static int raw_open_common(BlockDriverState *bs, QDict *options,
443 int bdrv_flags, int open_flags,
444 bool device, Error **errp)
446 BDRVRawState *s = bs->opaque;
447 QemuOpts *opts;
448 Error *local_err = NULL;
449 const char *filename = NULL;
450 const char *str;
451 BlockdevAioOptions aio, aio_default;
452 int fd, ret;
453 struct stat st;
454 OnOffAuto locking;
456 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
457 qemu_opts_absorb_qdict(opts, options, &local_err);
458 if (local_err) {
459 error_propagate(errp, local_err);
460 ret = -EINVAL;
461 goto fail;
464 filename = qemu_opt_get(opts, "filename");
466 ret = raw_normalize_devicepath(&filename, errp);
467 if (ret != 0) {
468 goto fail;
471 aio_default = (bdrv_flags & BDRV_O_NATIVE_AIO)
472 ? BLOCKDEV_AIO_OPTIONS_NATIVE
473 : BLOCKDEV_AIO_OPTIONS_THREADS;
474 aio = qapi_enum_parse(&BlockdevAioOptions_lookup,
475 qemu_opt_get(opts, "aio"),
476 aio_default, &local_err);
477 if (local_err) {
478 error_propagate(errp, local_err);
479 ret = -EINVAL;
480 goto fail;
482 s->use_linux_aio = (aio == BLOCKDEV_AIO_OPTIONS_NATIVE);
484 locking = qapi_enum_parse(&OnOffAuto_lookup,
485 qemu_opt_get(opts, "locking"),
486 ON_OFF_AUTO_AUTO, &local_err);
487 if (local_err) {
488 error_propagate(errp, local_err);
489 ret = -EINVAL;
490 goto fail;
492 switch (locking) {
493 case ON_OFF_AUTO_ON:
494 s->use_lock = true;
495 if (!qemu_has_ofd_lock()) {
496 warn_report("File lock requested but OFD locking syscall is "
497 "unavailable, falling back to POSIX file locks");
498 error_printf("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 ret = fd < 0 ? -errno : 0;
532 if (ret == -EACCES || ret == -EROFS) {
533 /* Try to degrade to read-only, but if it doesn't work, still use the
534 * normal error message. */
535 if (bdrv_apply_auto_read_only(bs, NULL, NULL) == 0) {
536 bdrv_flags &= ~BDRV_O_RDWR;
537 raw_parse_flags(bdrv_flags, &s->open_flags);
538 assert(!(s->open_flags & O_CREAT));
539 fd = qemu_open(filename, s->open_flags);
540 ret = fd < 0 ? -errno : 0;
544 if (ret < 0) {
545 error_setg_errno(errp, -ret, "Could not open '%s'", filename);
546 if (ret == -EROFS) {
547 ret = -EACCES;
549 goto fail;
551 s->fd = fd;
553 s->perm = 0;
554 s->shared_perm = BLK_PERM_ALL;
556 #ifdef CONFIG_LINUX_AIO
557 /* Currently Linux does AIO only for files opened with O_DIRECT */
558 if (s->use_linux_aio) {
559 if (!(s->open_flags & O_DIRECT)) {
560 error_setg(errp, "aio=native was specified, but it requires "
561 "cache.direct=on, which was not specified.");
562 ret = -EINVAL;
563 goto fail;
565 if (!aio_setup_linux_aio(bdrv_get_aio_context(bs), errp)) {
566 error_prepend(errp, "Unable to use native AIO: ");
567 goto fail;
570 #else
571 if (s->use_linux_aio) {
572 error_setg(errp, "aio=native was specified, but is not supported "
573 "in this build.");
574 ret = -EINVAL;
575 goto fail;
577 #endif /* !defined(CONFIG_LINUX_AIO) */
579 s->has_discard = true;
580 s->has_write_zeroes = true;
581 if ((bs->open_flags & BDRV_O_NOCACHE) != 0) {
582 s->needs_alignment = true;
585 if (fstat(s->fd, &st) < 0) {
586 ret = -errno;
587 error_setg_errno(errp, errno, "Could not stat file");
588 goto fail;
591 if (!device) {
592 if (S_ISBLK(st.st_mode)) {
593 warn_report("Opening a block device as a file using the '%s' "
594 "driver is deprecated", bs->drv->format_name);
595 } else if (S_ISCHR(st.st_mode)) {
596 warn_report("Opening a character device as a file using the '%s' "
597 "driver is deprecated", bs->drv->format_name);
598 } else if (!S_ISREG(st.st_mode)) {
599 error_setg(errp, "A regular file was expected by the '%s' driver, "
600 "but something else was given", bs->drv->format_name);
601 ret = -EINVAL;
602 goto fail;
603 } else {
604 s->discard_zeroes = true;
605 s->has_fallocate = true;
607 } else {
608 if (!(S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
609 error_setg(errp, "'%s' driver expects either "
610 "a character or block device", bs->drv->format_name);
611 ret = -EINVAL;
612 goto fail;
616 if (S_ISBLK(st.st_mode)) {
617 #ifdef BLKDISCARDZEROES
618 unsigned int arg;
619 if (ioctl(s->fd, BLKDISCARDZEROES, &arg) == 0 && arg) {
620 s->discard_zeroes = true;
622 #endif
623 #ifdef __linux__
624 /* On Linux 3.10, BLKDISCARD leaves stale data in the page cache. Do
625 * not rely on the contents of discarded blocks unless using O_DIRECT.
626 * Same for BLKZEROOUT.
628 if (!(bs->open_flags & BDRV_O_NOCACHE)) {
629 s->discard_zeroes = false;
630 s->has_write_zeroes = false;
632 #endif
634 #ifdef __FreeBSD__
635 if (S_ISCHR(st.st_mode)) {
637 * The file is a char device (disk), which on FreeBSD isn't behind
638 * a pager, so force all requests to be aligned. This is needed
639 * so QEMU makes sure all IO operations on the device are aligned
640 * to sector size, or else FreeBSD will reject them with EINVAL.
642 s->needs_alignment = true;
644 #endif
646 #ifdef CONFIG_XFS
647 if (platform_test_xfs_fd(s->fd)) {
648 s->is_xfs = true;
650 #endif
652 bs->supported_zero_flags = BDRV_REQ_MAY_UNMAP;
653 ret = 0;
654 fail:
655 if (filename && (bdrv_flags & BDRV_O_TEMPORARY)) {
656 unlink(filename);
658 qemu_opts_del(opts);
659 return ret;
662 static int raw_open(BlockDriverState *bs, QDict *options, int flags,
663 Error **errp)
665 BDRVRawState *s = bs->opaque;
667 s->type = FTYPE_FILE;
668 return raw_open_common(bs, options, flags, 0, false, errp);
671 typedef enum {
672 RAW_PL_PREPARE,
673 RAW_PL_COMMIT,
674 RAW_PL_ABORT,
675 } RawPermLockOp;
677 #define PERM_FOREACH(i) \
678 for ((i) = 0; (1ULL << (i)) <= BLK_PERM_ALL; i++)
680 /* Lock bytes indicated by @perm_lock_bits and @shared_perm_lock_bits in the
681 * file; if @unlock == true, also unlock the unneeded bytes.
682 * @shared_perm_lock_bits is the mask of all permissions that are NOT shared.
684 static int raw_apply_lock_bytes(BDRVRawState *s, int fd,
685 uint64_t perm_lock_bits,
686 uint64_t shared_perm_lock_bits,
687 bool unlock, Error **errp)
689 int ret;
690 int i;
691 uint64_t locked_perm, locked_shared_perm;
693 if (s) {
694 locked_perm = s->locked_perm;
695 locked_shared_perm = s->locked_shared_perm;
696 } else {
698 * We don't have the previous bits, just lock/unlock for each of the
699 * requested bits.
701 if (unlock) {
702 locked_perm = BLK_PERM_ALL;
703 locked_shared_perm = BLK_PERM_ALL;
704 } else {
705 locked_perm = 0;
706 locked_shared_perm = 0;
710 PERM_FOREACH(i) {
711 int off = RAW_LOCK_PERM_BASE + i;
712 uint64_t bit = (1ULL << i);
713 if ((perm_lock_bits & bit) && !(locked_perm & bit)) {
714 ret = qemu_lock_fd(fd, off, 1, false);
715 if (ret) {
716 error_setg(errp, "Failed to lock byte %d", off);
717 return ret;
718 } else if (s) {
719 s->locked_perm |= bit;
721 } else if (unlock && (locked_perm & bit) && !(perm_lock_bits & bit)) {
722 ret = qemu_unlock_fd(fd, off, 1);
723 if (ret) {
724 error_setg(errp, "Failed to unlock byte %d", off);
725 return ret;
726 } else if (s) {
727 s->locked_perm &= ~bit;
731 PERM_FOREACH(i) {
732 int off = RAW_LOCK_SHARED_BASE + i;
733 uint64_t bit = (1ULL << i);
734 if ((shared_perm_lock_bits & bit) && !(locked_shared_perm & bit)) {
735 ret = qemu_lock_fd(fd, off, 1, false);
736 if (ret) {
737 error_setg(errp, "Failed to lock byte %d", off);
738 return ret;
739 } else if (s) {
740 s->locked_shared_perm |= bit;
742 } else if (unlock && (locked_shared_perm & bit) &&
743 !(shared_perm_lock_bits & bit)) {
744 ret = qemu_unlock_fd(fd, off, 1);
745 if (ret) {
746 error_setg(errp, "Failed to unlock byte %d", off);
747 return ret;
748 } else if (s) {
749 s->locked_shared_perm &= ~bit;
753 return 0;
756 /* Check "unshared" bytes implied by @perm and ~@shared_perm in the file. */
757 static int raw_check_lock_bytes(int fd, uint64_t perm, uint64_t shared_perm,
758 Error **errp)
760 int ret;
761 int i;
763 PERM_FOREACH(i) {
764 int off = RAW_LOCK_SHARED_BASE + i;
765 uint64_t p = 1ULL << i;
766 if (perm & p) {
767 ret = qemu_lock_fd_test(fd, off, 1, true);
768 if (ret) {
769 char *perm_name = bdrv_perm_names(p);
770 error_setg(errp,
771 "Failed to get \"%s\" lock",
772 perm_name);
773 g_free(perm_name);
774 return ret;
778 PERM_FOREACH(i) {
779 int off = RAW_LOCK_PERM_BASE + i;
780 uint64_t p = 1ULL << i;
781 if (!(shared_perm & p)) {
782 ret = qemu_lock_fd_test(fd, off, 1, true);
783 if (ret) {
784 char *perm_name = bdrv_perm_names(p);
785 error_setg(errp,
786 "Failed to get shared \"%s\" lock",
787 perm_name);
788 g_free(perm_name);
789 return ret;
793 return 0;
796 static int raw_handle_perm_lock(BlockDriverState *bs,
797 RawPermLockOp op,
798 uint64_t new_perm, uint64_t new_shared,
799 Error **errp)
801 BDRVRawState *s = bs->opaque;
802 int ret = 0;
803 Error *local_err = NULL;
805 if (!s->use_lock) {
806 return 0;
809 if (bdrv_get_flags(bs) & BDRV_O_INACTIVE) {
810 return 0;
813 switch (op) {
814 case RAW_PL_PREPARE:
815 ret = raw_apply_lock_bytes(s, s->fd, s->perm | new_perm,
816 ~s->shared_perm | ~new_shared,
817 false, errp);
818 if (!ret) {
819 ret = raw_check_lock_bytes(s->fd, new_perm, new_shared, errp);
820 if (!ret) {
821 return 0;
823 error_append_hint(errp,
824 "Is another process using the image [%s]?\n",
825 bs->filename);
827 op = RAW_PL_ABORT;
828 /* fall through to unlock bytes. */
829 case RAW_PL_ABORT:
830 raw_apply_lock_bytes(s, s->fd, s->perm, ~s->shared_perm,
831 true, &local_err);
832 if (local_err) {
833 /* Theoretically the above call only unlocks bytes and it cannot
834 * fail. Something weird happened, report it.
836 warn_report_err(local_err);
838 break;
839 case RAW_PL_COMMIT:
840 raw_apply_lock_bytes(s, s->fd, new_perm, ~new_shared,
841 true, &local_err);
842 if (local_err) {
843 /* Theoretically the above call only unlocks bytes and it cannot
844 * fail. Something weird happened, report it.
846 warn_report_err(local_err);
848 break;
850 return ret;
853 static int raw_reopen_prepare(BDRVReopenState *state,
854 BlockReopenQueue *queue, Error **errp)
856 BDRVRawState *s;
857 BDRVRawReopenState *rs;
858 QemuOpts *opts;
859 int ret = 0;
860 Error *local_err = NULL;
862 assert(state != NULL);
863 assert(state->bs != NULL);
865 s = state->bs->opaque;
867 state->opaque = g_new0(BDRVRawReopenState, 1);
868 rs = state->opaque;
869 rs->fd = -1;
871 /* Handle options changes */
872 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
873 qemu_opts_absorb_qdict(opts, state->options, &local_err);
874 if (local_err) {
875 error_propagate(errp, local_err);
876 ret = -EINVAL;
877 goto out;
880 rs->check_cache_dropped =
881 qemu_opt_get_bool_del(opts, "x-check-cache-dropped", false);
883 /* This driver's reopen function doesn't currently allow changing
884 * other options, so let's put them back in the original QDict and
885 * bdrv_reopen_prepare() will detect changes and complain. */
886 qemu_opts_to_qdict(opts, state->options);
888 if (s->type == FTYPE_CD) {
889 rs->open_flags |= O_NONBLOCK;
892 raw_parse_flags(state->flags, &rs->open_flags);
894 int fcntl_flags = O_APPEND | O_NONBLOCK;
895 #ifdef O_NOATIME
896 fcntl_flags |= O_NOATIME;
897 #endif
899 #ifdef O_ASYNC
900 /* Not all operating systems have O_ASYNC, and those that don't
901 * will not let us track the state into rs->open_flags (typically
902 * you achieve the same effect with an ioctl, for example I_SETSIG
903 * on Solaris). But we do not use O_ASYNC, so that's fine.
905 assert((s->open_flags & O_ASYNC) == 0);
906 #endif
908 if ((rs->open_flags & ~fcntl_flags) == (s->open_flags & ~fcntl_flags)) {
909 /* dup the original fd */
910 rs->fd = qemu_dup(s->fd);
911 if (rs->fd >= 0) {
912 ret = fcntl_setfl(rs->fd, rs->open_flags);
913 if (ret) {
914 qemu_close(rs->fd);
915 rs->fd = -1;
920 /* If we cannot use fcntl, or fcntl failed, fall back to qemu_open() */
921 if (rs->fd == -1) {
922 const char *normalized_filename = state->bs->filename;
923 ret = raw_normalize_devicepath(&normalized_filename, errp);
924 if (ret >= 0) {
925 assert(!(rs->open_flags & O_CREAT));
926 rs->fd = qemu_open(normalized_filename, rs->open_flags);
927 if (rs->fd == -1) {
928 error_setg_errno(errp, errno, "Could not reopen file");
929 ret = -1;
934 /* Fail already reopen_prepare() if we can't get a working O_DIRECT
935 * alignment with the new fd. */
936 if (rs->fd != -1) {
937 raw_probe_alignment(state->bs, rs->fd, &local_err);
938 if (local_err) {
939 qemu_close(rs->fd);
940 rs->fd = -1;
941 error_propagate(errp, local_err);
942 ret = -EINVAL;
946 out:
947 qemu_opts_del(opts);
948 return ret;
951 static void raw_reopen_commit(BDRVReopenState *state)
953 BDRVRawReopenState *rs = state->opaque;
954 BDRVRawState *s = state->bs->opaque;
955 Error *local_err = NULL;
957 s->check_cache_dropped = rs->check_cache_dropped;
958 s->open_flags = rs->open_flags;
960 /* Copy locks to the new fd before closing the old one. */
961 raw_apply_lock_bytes(NULL, rs->fd, s->locked_perm,
962 s->locked_shared_perm, false, &local_err);
963 if (local_err) {
964 /* shouldn't fail in a sane host, but report it just in case. */
965 error_report_err(local_err);
967 qemu_close(s->fd);
968 s->fd = rs->fd;
970 g_free(state->opaque);
971 state->opaque = NULL;
975 static void raw_reopen_abort(BDRVReopenState *state)
977 BDRVRawReopenState *rs = state->opaque;
979 /* nothing to do if NULL, we didn't get far enough */
980 if (rs == NULL) {
981 return;
984 if (rs->fd >= 0) {
985 qemu_close(rs->fd);
986 rs->fd = -1;
988 g_free(state->opaque);
989 state->opaque = NULL;
992 static int hdev_get_max_transfer_length(BlockDriverState *bs, int fd)
994 #ifdef BLKSECTGET
995 int max_bytes = 0;
996 short max_sectors = 0;
997 if (bs->sg && ioctl(fd, BLKSECTGET, &max_bytes) == 0) {
998 return max_bytes;
999 } else if (!bs->sg && ioctl(fd, BLKSECTGET, &max_sectors) == 0) {
1000 return max_sectors << BDRV_SECTOR_BITS;
1001 } else {
1002 return -errno;
1004 #else
1005 return -ENOSYS;
1006 #endif
1009 static int hdev_get_max_segments(const struct stat *st)
1011 #ifdef CONFIG_LINUX
1012 char buf[32];
1013 const char *end;
1014 char *sysfspath;
1015 int ret;
1016 int fd = -1;
1017 long max_segments;
1019 sysfspath = g_strdup_printf("/sys/dev/block/%u:%u/queue/max_segments",
1020 major(st->st_rdev), minor(st->st_rdev));
1021 fd = open(sysfspath, O_RDONLY);
1022 if (fd == -1) {
1023 ret = -errno;
1024 goto out;
1026 do {
1027 ret = read(fd, buf, sizeof(buf) - 1);
1028 } while (ret == -1 && errno == EINTR);
1029 if (ret < 0) {
1030 ret = -errno;
1031 goto out;
1032 } else if (ret == 0) {
1033 ret = -EIO;
1034 goto out;
1036 buf[ret] = 0;
1037 /* The file is ended with '\n', pass 'end' to accept that. */
1038 ret = qemu_strtol(buf, &end, 10, &max_segments);
1039 if (ret == 0 && end && *end == '\n') {
1040 ret = max_segments;
1043 out:
1044 if (fd != -1) {
1045 close(fd);
1047 g_free(sysfspath);
1048 return ret;
1049 #else
1050 return -ENOTSUP;
1051 #endif
1054 static void raw_refresh_limits(BlockDriverState *bs, Error **errp)
1056 BDRVRawState *s = bs->opaque;
1057 struct stat st;
1059 if (!fstat(s->fd, &st)) {
1060 if (S_ISBLK(st.st_mode) || S_ISCHR(st.st_mode)) {
1061 int ret = hdev_get_max_transfer_length(bs, s->fd);
1062 if (ret > 0 && ret <= BDRV_REQUEST_MAX_BYTES) {
1063 bs->bl.max_transfer = pow2floor(ret);
1065 ret = hdev_get_max_segments(&st);
1066 if (ret > 0) {
1067 bs->bl.max_transfer = MIN(bs->bl.max_transfer,
1068 ret * getpagesize());
1073 raw_probe_alignment(bs, s->fd, errp);
1074 bs->bl.min_mem_alignment = s->buf_align;
1075 bs->bl.opt_mem_alignment = MAX(s->buf_align, getpagesize());
1078 static int check_for_dasd(int fd)
1080 #ifdef BIODASDINFO2
1081 struct dasd_information2_t info = {0};
1083 return ioctl(fd, BIODASDINFO2, &info);
1084 #else
1085 return -1;
1086 #endif
1090 * Try to get @bs's logical and physical block size.
1091 * On success, store them in @bsz and return zero.
1092 * On failure, return negative errno.
1094 static int hdev_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz)
1096 BDRVRawState *s = bs->opaque;
1097 int ret;
1099 /* If DASD, get blocksizes */
1100 if (check_for_dasd(s->fd) < 0) {
1101 return -ENOTSUP;
1103 ret = probe_logical_blocksize(s->fd, &bsz->log);
1104 if (ret < 0) {
1105 return ret;
1107 return probe_physical_blocksize(s->fd, &bsz->phys);
1111 * Try to get @bs's geometry: cyls, heads, sectors.
1112 * On success, store them in @geo and return 0.
1113 * On failure return -errno.
1114 * (Allows block driver to assign default geometry values that guest sees)
1116 #ifdef __linux__
1117 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1119 BDRVRawState *s = bs->opaque;
1120 struct hd_geometry ioctl_geo = {0};
1122 /* If DASD, get its geometry */
1123 if (check_for_dasd(s->fd) < 0) {
1124 return -ENOTSUP;
1126 if (ioctl(s->fd, HDIO_GETGEO, &ioctl_geo) < 0) {
1127 return -errno;
1129 /* HDIO_GETGEO may return success even though geo contains zeros
1130 (e.g. certain multipath setups) */
1131 if (!ioctl_geo.heads || !ioctl_geo.sectors || !ioctl_geo.cylinders) {
1132 return -ENOTSUP;
1134 /* Do not return a geometry for partition */
1135 if (ioctl_geo.start != 0) {
1136 return -ENOTSUP;
1138 geo->heads = ioctl_geo.heads;
1139 geo->sectors = ioctl_geo.sectors;
1140 geo->cylinders = ioctl_geo.cylinders;
1142 return 0;
1144 #else /* __linux__ */
1145 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1147 return -ENOTSUP;
1149 #endif
1151 static ssize_t handle_aiocb_ioctl(RawPosixAIOData *aiocb)
1153 int ret;
1155 ret = ioctl(aiocb->aio_fildes, aiocb->aio_ioctl_cmd, aiocb->aio_ioctl_buf);
1156 if (ret == -1) {
1157 return -errno;
1160 return 0;
1163 static ssize_t handle_aiocb_flush(RawPosixAIOData *aiocb)
1165 BDRVRawState *s = aiocb->bs->opaque;
1166 int ret;
1168 if (s->page_cache_inconsistent) {
1169 return -EIO;
1172 ret = qemu_fdatasync(aiocb->aio_fildes);
1173 if (ret == -1) {
1174 /* There is no clear definition of the semantics of a failing fsync(),
1175 * so we may have to assume the worst. The sad truth is that this
1176 * assumption is correct for Linux. Some pages are now probably marked
1177 * clean in the page cache even though they are inconsistent with the
1178 * on-disk contents. The next fdatasync() call would succeed, but no
1179 * further writeback attempt will be made. We can't get back to a state
1180 * in which we know what is on disk (we would have to rewrite
1181 * everything that was touched since the last fdatasync() at least), so
1182 * make bdrv_flush() fail permanently. Given that the behaviour isn't
1183 * really defined, I have little hope that other OSes are doing better.
1185 * Obviously, this doesn't affect O_DIRECT, which bypasses the page
1186 * cache. */
1187 if ((s->open_flags & O_DIRECT) == 0) {
1188 s->page_cache_inconsistent = true;
1190 return -errno;
1192 return 0;
1195 #ifdef CONFIG_PREADV
1197 static bool preadv_present = true;
1199 static ssize_t
1200 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1202 return preadv(fd, iov, nr_iov, offset);
1205 static ssize_t
1206 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1208 return pwritev(fd, iov, nr_iov, offset);
1211 #else
1213 static bool preadv_present = false;
1215 static ssize_t
1216 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1218 return -ENOSYS;
1221 static ssize_t
1222 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1224 return -ENOSYS;
1227 #endif
1229 static ssize_t handle_aiocb_rw_vector(RawPosixAIOData *aiocb)
1231 ssize_t len;
1233 do {
1234 if (aiocb->aio_type & QEMU_AIO_WRITE)
1235 len = qemu_pwritev(aiocb->aio_fildes,
1236 aiocb->aio_iov,
1237 aiocb->aio_niov,
1238 aiocb->aio_offset);
1239 else
1240 len = qemu_preadv(aiocb->aio_fildes,
1241 aiocb->aio_iov,
1242 aiocb->aio_niov,
1243 aiocb->aio_offset);
1244 } while (len == -1 && errno == EINTR);
1246 if (len == -1) {
1247 return -errno;
1249 return len;
1253 * Read/writes the data to/from a given linear buffer.
1255 * Returns the number of bytes handles or -errno in case of an error. Short
1256 * reads are only returned if the end of the file is reached.
1258 static ssize_t handle_aiocb_rw_linear(RawPosixAIOData *aiocb, char *buf)
1260 ssize_t offset = 0;
1261 ssize_t len;
1263 while (offset < aiocb->aio_nbytes) {
1264 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1265 len = pwrite(aiocb->aio_fildes,
1266 (const char *)buf + offset,
1267 aiocb->aio_nbytes - offset,
1268 aiocb->aio_offset + offset);
1269 } else {
1270 len = pread(aiocb->aio_fildes,
1271 buf + offset,
1272 aiocb->aio_nbytes - offset,
1273 aiocb->aio_offset + offset);
1275 if (len == -1 && errno == EINTR) {
1276 continue;
1277 } else if (len == -1 && errno == EINVAL &&
1278 (aiocb->bs->open_flags & BDRV_O_NOCACHE) &&
1279 !(aiocb->aio_type & QEMU_AIO_WRITE) &&
1280 offset > 0) {
1281 /* O_DIRECT pread() may fail with EINVAL when offset is unaligned
1282 * after a short read. Assume that O_DIRECT short reads only occur
1283 * at EOF. Therefore this is a short read, not an I/O error.
1285 break;
1286 } else if (len == -1) {
1287 offset = -errno;
1288 break;
1289 } else if (len == 0) {
1290 break;
1292 offset += len;
1295 return offset;
1298 static ssize_t handle_aiocb_rw(RawPosixAIOData *aiocb)
1300 ssize_t nbytes;
1301 char *buf;
1303 if (!(aiocb->aio_type & QEMU_AIO_MISALIGNED)) {
1305 * If there is just a single buffer, and it is properly aligned
1306 * we can just use plain pread/pwrite without any problems.
1308 if (aiocb->aio_niov == 1) {
1309 return handle_aiocb_rw_linear(aiocb, aiocb->aio_iov->iov_base);
1312 * We have more than one iovec, and all are properly aligned.
1314 * Try preadv/pwritev first and fall back to linearizing the
1315 * buffer if it's not supported.
1317 if (preadv_present) {
1318 nbytes = handle_aiocb_rw_vector(aiocb);
1319 if (nbytes == aiocb->aio_nbytes ||
1320 (nbytes < 0 && nbytes != -ENOSYS)) {
1321 return nbytes;
1323 preadv_present = false;
1327 * XXX(hch): short read/write. no easy way to handle the reminder
1328 * using these interfaces. For now retry using plain
1329 * pread/pwrite?
1334 * Ok, we have to do it the hard way, copy all segments into
1335 * a single aligned buffer.
1337 buf = qemu_try_blockalign(aiocb->bs, aiocb->aio_nbytes);
1338 if (buf == NULL) {
1339 return -ENOMEM;
1342 if (aiocb->aio_type & QEMU_AIO_WRITE) {
1343 char *p = buf;
1344 int i;
1346 for (i = 0; i < aiocb->aio_niov; ++i) {
1347 memcpy(p, aiocb->aio_iov[i].iov_base, aiocb->aio_iov[i].iov_len);
1348 p += aiocb->aio_iov[i].iov_len;
1350 assert(p - buf == aiocb->aio_nbytes);
1353 nbytes = handle_aiocb_rw_linear(aiocb, buf);
1354 if (!(aiocb->aio_type & QEMU_AIO_WRITE)) {
1355 char *p = buf;
1356 size_t count = aiocb->aio_nbytes, copy;
1357 int i;
1359 for (i = 0; i < aiocb->aio_niov && count; ++i) {
1360 copy = count;
1361 if (copy > aiocb->aio_iov[i].iov_len) {
1362 copy = aiocb->aio_iov[i].iov_len;
1364 memcpy(aiocb->aio_iov[i].iov_base, p, copy);
1365 assert(count >= copy);
1366 p += copy;
1367 count -= copy;
1369 assert(count == 0);
1371 qemu_vfree(buf);
1373 return nbytes;
1376 #ifdef CONFIG_XFS
1377 static int xfs_write_zeroes(BDRVRawState *s, int64_t offset, uint64_t bytes)
1379 struct xfs_flock64 fl;
1380 int err;
1382 memset(&fl, 0, sizeof(fl));
1383 fl.l_whence = SEEK_SET;
1384 fl.l_start = offset;
1385 fl.l_len = bytes;
1387 if (xfsctl(NULL, s->fd, XFS_IOC_ZERO_RANGE, &fl) < 0) {
1388 err = errno;
1389 DPRINTF("cannot write zero range (%s)\n", strerror(errno));
1390 return -err;
1393 return 0;
1396 static int xfs_discard(BDRVRawState *s, int64_t offset, uint64_t bytes)
1398 struct xfs_flock64 fl;
1399 int err;
1401 memset(&fl, 0, sizeof(fl));
1402 fl.l_whence = SEEK_SET;
1403 fl.l_start = offset;
1404 fl.l_len = bytes;
1406 if (xfsctl(NULL, s->fd, XFS_IOC_UNRESVSP64, &fl) < 0) {
1407 err = errno;
1408 DPRINTF("cannot punch hole (%s)\n", strerror(errno));
1409 return -err;
1412 return 0;
1414 #endif
1416 static int translate_err(int err)
1418 if (err == -ENODEV || err == -ENOSYS || err == -EOPNOTSUPP ||
1419 err == -ENOTTY) {
1420 err = -ENOTSUP;
1422 return err;
1425 #ifdef CONFIG_FALLOCATE
1426 static int do_fallocate(int fd, int mode, off_t offset, off_t len)
1428 do {
1429 if (fallocate(fd, mode, offset, len) == 0) {
1430 return 0;
1432 } while (errno == EINTR);
1433 return translate_err(-errno);
1435 #endif
1437 static ssize_t handle_aiocb_write_zeroes_block(RawPosixAIOData *aiocb)
1439 int ret = -ENOTSUP;
1440 BDRVRawState *s = aiocb->bs->opaque;
1442 if (!s->has_write_zeroes) {
1443 return -ENOTSUP;
1446 #ifdef BLKZEROOUT
1447 do {
1448 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1449 if (ioctl(aiocb->aio_fildes, BLKZEROOUT, range) == 0) {
1450 return 0;
1452 } while (errno == EINTR);
1454 ret = translate_err(-errno);
1455 #endif
1457 if (ret == -ENOTSUP) {
1458 s->has_write_zeroes = false;
1460 return ret;
1463 static ssize_t handle_aiocb_write_zeroes(RawPosixAIOData *aiocb)
1465 #if defined(CONFIG_FALLOCATE) || defined(CONFIG_XFS)
1466 BDRVRawState *s = aiocb->bs->opaque;
1467 #endif
1468 #ifdef CONFIG_FALLOCATE
1469 int64_t len;
1470 #endif
1472 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1473 return handle_aiocb_write_zeroes_block(aiocb);
1476 #ifdef CONFIG_XFS
1477 if (s->is_xfs) {
1478 return xfs_write_zeroes(s, aiocb->aio_offset, aiocb->aio_nbytes);
1480 #endif
1482 #ifdef CONFIG_FALLOCATE_ZERO_RANGE
1483 if (s->has_write_zeroes) {
1484 int ret = do_fallocate(s->fd, FALLOC_FL_ZERO_RANGE,
1485 aiocb->aio_offset, aiocb->aio_nbytes);
1486 if (ret == 0 || ret != -ENOTSUP) {
1487 return ret;
1489 s->has_write_zeroes = false;
1491 #endif
1493 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1494 if (s->has_discard && s->has_fallocate) {
1495 int ret = do_fallocate(s->fd,
1496 FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1497 aiocb->aio_offset, aiocb->aio_nbytes);
1498 if (ret == 0) {
1499 ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1500 if (ret == 0 || ret != -ENOTSUP) {
1501 return ret;
1503 s->has_fallocate = false;
1504 } else if (ret != -ENOTSUP) {
1505 return ret;
1506 } else {
1507 s->has_discard = false;
1510 #endif
1512 #ifdef CONFIG_FALLOCATE
1513 /* Last resort: we are trying to extend the file with zeroed data. This
1514 * can be done via fallocate(fd, 0) */
1515 len = bdrv_getlength(aiocb->bs);
1516 if (s->has_fallocate && len >= 0 && aiocb->aio_offset >= len) {
1517 int ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1518 if (ret == 0 || ret != -ENOTSUP) {
1519 return ret;
1521 s->has_fallocate = false;
1523 #endif
1525 return -ENOTSUP;
1528 static ssize_t handle_aiocb_write_zeroes_unmap(RawPosixAIOData *aiocb)
1530 BDRVRawState *s G_GNUC_UNUSED = aiocb->bs->opaque;
1531 int ret;
1533 /* First try to write zeros and unmap at the same time */
1535 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1536 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1537 aiocb->aio_offset, aiocb->aio_nbytes);
1538 if (ret != -ENOTSUP) {
1539 return ret;
1541 #endif
1543 #ifdef CONFIG_XFS
1544 if (s->is_xfs) {
1545 /* xfs_discard() guarantees that the discarded area reads as all-zero
1546 * afterwards, so we can use it here. */
1547 return xfs_discard(s, aiocb->aio_offset, aiocb->aio_nbytes);
1549 #endif
1551 /* If we couldn't manage to unmap while guaranteed that the area reads as
1552 * all-zero afterwards, just write zeroes without unmapping */
1553 ret = handle_aiocb_write_zeroes(aiocb);
1554 return ret;
1557 #ifndef HAVE_COPY_FILE_RANGE
1558 static off_t copy_file_range(int in_fd, off_t *in_off, int out_fd,
1559 off_t *out_off, size_t len, unsigned int flags)
1561 #ifdef __NR_copy_file_range
1562 return syscall(__NR_copy_file_range, in_fd, in_off, out_fd,
1563 out_off, len, flags);
1564 #else
1565 errno = ENOSYS;
1566 return -1;
1567 #endif
1569 #endif
1571 static ssize_t handle_aiocb_copy_range(RawPosixAIOData *aiocb)
1573 uint64_t bytes = aiocb->aio_nbytes;
1574 off_t in_off = aiocb->aio_offset;
1575 off_t out_off = aiocb->aio_offset2;
1577 while (bytes) {
1578 ssize_t ret = copy_file_range(aiocb->aio_fildes, &in_off,
1579 aiocb->aio_fd2, &out_off,
1580 bytes, 0);
1581 trace_file_copy_file_range(aiocb->bs, aiocb->aio_fildes, in_off,
1582 aiocb->aio_fd2, out_off, bytes, 0, ret);
1583 if (ret == 0) {
1584 /* No progress (e.g. when beyond EOF), let the caller fall back to
1585 * buffer I/O. */
1586 return -ENOSPC;
1588 if (ret < 0) {
1589 switch (errno) {
1590 case ENOSYS:
1591 return -ENOTSUP;
1592 case EINTR:
1593 continue;
1594 default:
1595 return -errno;
1598 bytes -= ret;
1600 return 0;
1603 static ssize_t handle_aiocb_discard(RawPosixAIOData *aiocb)
1605 int ret = -EOPNOTSUPP;
1606 BDRVRawState *s = aiocb->bs->opaque;
1608 if (!s->has_discard) {
1609 return -ENOTSUP;
1612 if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1613 #ifdef BLKDISCARD
1614 do {
1615 uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1616 if (ioctl(aiocb->aio_fildes, BLKDISCARD, range) == 0) {
1617 return 0;
1619 } while (errno == EINTR);
1621 ret = -errno;
1622 #endif
1623 } else {
1624 #ifdef CONFIG_XFS
1625 if (s->is_xfs) {
1626 return xfs_discard(s, aiocb->aio_offset, aiocb->aio_nbytes);
1628 #endif
1630 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1631 ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1632 aiocb->aio_offset, aiocb->aio_nbytes);
1633 #endif
1636 ret = translate_err(ret);
1637 if (ret == -ENOTSUP) {
1638 s->has_discard = false;
1640 return ret;
1643 static int handle_aiocb_truncate(RawPosixAIOData *aiocb)
1645 int result = 0;
1646 int64_t current_length = 0;
1647 char *buf = NULL;
1648 struct stat st;
1649 int fd = aiocb->aio_fildes;
1650 int64_t offset = aiocb->aio_offset;
1651 Error **errp = aiocb->errp;
1653 if (fstat(fd, &st) < 0) {
1654 result = -errno;
1655 error_setg_errno(errp, -result, "Could not stat file");
1656 return result;
1659 current_length = st.st_size;
1660 if (current_length > offset && aiocb->prealloc != PREALLOC_MODE_OFF) {
1661 error_setg(errp, "Cannot use preallocation for shrinking files");
1662 return -ENOTSUP;
1665 switch (aiocb->prealloc) {
1666 #ifdef CONFIG_POSIX_FALLOCATE
1667 case PREALLOC_MODE_FALLOC:
1669 * Truncating before posix_fallocate() makes it about twice slower on
1670 * file systems that do not support fallocate(), trying to check if a
1671 * block is allocated before allocating it, so don't do that here.
1673 if (offset != current_length) {
1674 result = -posix_fallocate(fd, current_length,
1675 offset - current_length);
1676 if (result != 0) {
1677 /* posix_fallocate() doesn't set errno. */
1678 error_setg_errno(errp, -result,
1679 "Could not preallocate new data");
1681 } else {
1682 result = 0;
1684 goto out;
1685 #endif
1686 case PREALLOC_MODE_FULL:
1688 int64_t num = 0, left = offset - current_length;
1689 off_t seek_result;
1692 * Knowing the final size from the beginning could allow the file
1693 * system driver to do less allocations and possibly avoid
1694 * fragmentation of the file.
1696 if (ftruncate(fd, offset) != 0) {
1697 result = -errno;
1698 error_setg_errno(errp, -result, "Could not resize file");
1699 goto out;
1702 buf = g_malloc0(65536);
1704 seek_result = lseek(fd, current_length, SEEK_SET);
1705 if (seek_result < 0) {
1706 result = -errno;
1707 error_setg_errno(errp, -result,
1708 "Failed to seek to the old end of file");
1709 goto out;
1712 while (left > 0) {
1713 num = MIN(left, 65536);
1714 result = write(fd, buf, num);
1715 if (result < 0) {
1716 if (errno == EINTR) {
1717 continue;
1719 result = -errno;
1720 error_setg_errno(errp, -result,
1721 "Could not write zeros for preallocation");
1722 goto out;
1724 left -= result;
1726 if (result >= 0) {
1727 result = fsync(fd);
1728 if (result < 0) {
1729 result = -errno;
1730 error_setg_errno(errp, -result,
1731 "Could not flush file to disk");
1732 goto out;
1735 goto out;
1737 case PREALLOC_MODE_OFF:
1738 if (ftruncate(fd, offset) != 0) {
1739 result = -errno;
1740 error_setg_errno(errp, -result, "Could not resize file");
1742 return result;
1743 default:
1744 result = -ENOTSUP;
1745 error_setg(errp, "Unsupported preallocation mode: %s",
1746 PreallocMode_str(aiocb->prealloc));
1747 return result;
1750 out:
1751 if (result < 0) {
1752 if (ftruncate(fd, current_length) < 0) {
1753 error_report("Failed to restore old file length: %s",
1754 strerror(errno));
1758 g_free(buf);
1759 return result;
1762 static int aio_worker(void *arg)
1764 RawPosixAIOData *aiocb = arg;
1765 ssize_t ret = 0;
1767 switch (aiocb->aio_type & QEMU_AIO_TYPE_MASK) {
1768 case QEMU_AIO_READ:
1769 ret = handle_aiocb_rw(aiocb);
1770 if (ret >= 0 && ret < aiocb->aio_nbytes) {
1771 iov_memset(aiocb->aio_iov, aiocb->aio_niov, ret,
1772 0, aiocb->aio_nbytes - ret);
1774 ret = aiocb->aio_nbytes;
1776 if (ret == aiocb->aio_nbytes) {
1777 ret = 0;
1778 } else if (ret >= 0 && ret < aiocb->aio_nbytes) {
1779 ret = -EINVAL;
1781 break;
1782 case QEMU_AIO_WRITE:
1783 ret = handle_aiocb_rw(aiocb);
1784 if (ret == aiocb->aio_nbytes) {
1785 ret = 0;
1786 } else if (ret >= 0 && ret < aiocb->aio_nbytes) {
1787 ret = -EINVAL;
1789 break;
1790 case QEMU_AIO_FLUSH:
1791 ret = handle_aiocb_flush(aiocb);
1792 break;
1793 case QEMU_AIO_IOCTL:
1794 ret = handle_aiocb_ioctl(aiocb);
1795 break;
1796 case QEMU_AIO_DISCARD:
1797 ret = handle_aiocb_discard(aiocb);
1798 break;
1799 case QEMU_AIO_WRITE_ZEROES:
1800 ret = handle_aiocb_write_zeroes(aiocb);
1801 break;
1802 case QEMU_AIO_WRITE_ZEROES | QEMU_AIO_DISCARD:
1803 ret = handle_aiocb_write_zeroes_unmap(aiocb);
1804 break;
1805 case QEMU_AIO_COPY_RANGE:
1806 ret = handle_aiocb_copy_range(aiocb);
1807 break;
1808 case QEMU_AIO_TRUNCATE:
1809 ret = handle_aiocb_truncate(aiocb);
1810 break;
1811 default:
1812 error_report("invalid aio request (0x%x)", aiocb->aio_type);
1813 ret = -EINVAL;
1814 break;
1817 g_free(aiocb);
1818 return ret;
1821 static int paio_submit_co_full(BlockDriverState *bs, int fd,
1822 int64_t offset, int fd2, int64_t offset2,
1823 QEMUIOVector *qiov,
1824 int bytes, int type)
1826 RawPosixAIOData *acb = g_new(RawPosixAIOData, 1);
1827 ThreadPool *pool;
1829 acb->bs = bs;
1830 acb->aio_type = type;
1831 acb->aio_fildes = fd;
1832 acb->aio_fd2 = fd2;
1833 acb->aio_offset2 = offset2;
1835 acb->aio_nbytes = bytes;
1836 acb->aio_offset = offset;
1838 if (qiov) {
1839 acb->aio_iov = qiov->iov;
1840 acb->aio_niov = qiov->niov;
1841 assert(qiov->size == bytes);
1844 trace_file_paio_submit_co(offset, bytes, type);
1845 pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
1846 return thread_pool_submit_co(pool, aio_worker, acb);
1849 static inline int paio_submit_co(BlockDriverState *bs, int fd,
1850 int64_t offset, QEMUIOVector *qiov,
1851 int bytes, int type)
1853 return paio_submit_co_full(bs, fd, offset, -1, 0, qiov, bytes, type);
1856 static int coroutine_fn raw_co_prw(BlockDriverState *bs, uint64_t offset,
1857 uint64_t bytes, QEMUIOVector *qiov, int type)
1859 BDRVRawState *s = bs->opaque;
1861 if (fd_open(bs) < 0)
1862 return -EIO;
1865 * Check if the underlying device requires requests to be aligned,
1866 * and if the request we are trying to submit is aligned or not.
1867 * If this is the case tell the low-level driver that it needs
1868 * to copy the buffer.
1870 if (s->needs_alignment) {
1871 if (!bdrv_qiov_is_aligned(bs, qiov)) {
1872 type |= QEMU_AIO_MISALIGNED;
1873 #ifdef CONFIG_LINUX_AIO
1874 } else if (s->use_linux_aio) {
1875 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1876 assert(qiov->size == bytes);
1877 return laio_co_submit(bs, aio, s->fd, offset, qiov, type);
1878 #endif
1882 return paio_submit_co(bs, s->fd, offset, qiov, bytes, type);
1885 static int coroutine_fn raw_co_preadv(BlockDriverState *bs, uint64_t offset,
1886 uint64_t bytes, QEMUIOVector *qiov,
1887 int flags)
1889 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_READ);
1892 static int coroutine_fn raw_co_pwritev(BlockDriverState *bs, uint64_t offset,
1893 uint64_t bytes, QEMUIOVector *qiov,
1894 int flags)
1896 assert(flags == 0);
1897 return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_WRITE);
1900 static void raw_aio_plug(BlockDriverState *bs)
1902 #ifdef CONFIG_LINUX_AIO
1903 BDRVRawState *s = bs->opaque;
1904 if (s->use_linux_aio) {
1905 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1906 laio_io_plug(bs, aio);
1908 #endif
1911 static void raw_aio_unplug(BlockDriverState *bs)
1913 #ifdef CONFIG_LINUX_AIO
1914 BDRVRawState *s = bs->opaque;
1915 if (s->use_linux_aio) {
1916 LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
1917 laio_io_unplug(bs, aio);
1919 #endif
1922 static int raw_co_flush_to_disk(BlockDriverState *bs)
1924 BDRVRawState *s = bs->opaque;
1925 int ret;
1927 ret = fd_open(bs);
1928 if (ret < 0) {
1929 return ret;
1932 return paio_submit_co(bs, s->fd, 0, NULL, 0, QEMU_AIO_FLUSH);
1935 static void raw_aio_attach_aio_context(BlockDriverState *bs,
1936 AioContext *new_context)
1938 #ifdef CONFIG_LINUX_AIO
1939 BDRVRawState *s = bs->opaque;
1940 if (s->use_linux_aio) {
1941 Error *local_err;
1942 if (!aio_setup_linux_aio(new_context, &local_err)) {
1943 error_reportf_err(local_err, "Unable to use native AIO, "
1944 "falling back to thread pool: ");
1945 s->use_linux_aio = false;
1948 #endif
1951 static void raw_close(BlockDriverState *bs)
1953 BDRVRawState *s = bs->opaque;
1955 if (s->fd >= 0) {
1956 qemu_close(s->fd);
1957 s->fd = -1;
1962 * Truncates the given regular file @fd to @offset and, when growing, fills the
1963 * new space according to @prealloc.
1965 * Returns: 0 on success, -errno on failure.
1967 static int coroutine_fn
1968 raw_regular_truncate(BlockDriverState *bs, int fd, int64_t offset,
1969 PreallocMode prealloc, Error **errp)
1971 RawPosixAIOData *acb = g_new(RawPosixAIOData, 1);
1972 ThreadPool *pool;
1974 *acb = (RawPosixAIOData) {
1975 .bs = bs,
1976 .aio_fildes = fd,
1977 .aio_type = QEMU_AIO_TRUNCATE,
1978 .aio_offset = offset,
1979 .prealloc = prealloc,
1980 .errp = errp,
1983 /* @bs can be NULL, bdrv_get_aio_context() returns the main context then */
1984 pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
1985 return thread_pool_submit_co(pool, aio_worker, acb);
1988 static int coroutine_fn raw_co_truncate(BlockDriverState *bs, int64_t offset,
1989 PreallocMode prealloc, Error **errp)
1991 BDRVRawState *s = bs->opaque;
1992 struct stat st;
1993 int ret;
1995 if (fstat(s->fd, &st)) {
1996 ret = -errno;
1997 error_setg_errno(errp, -ret, "Failed to fstat() the file");
1998 return ret;
2001 if (S_ISREG(st.st_mode)) {
2002 return raw_regular_truncate(bs, s->fd, offset, prealloc, errp);
2005 if (prealloc != PREALLOC_MODE_OFF) {
2006 error_setg(errp, "Preallocation mode '%s' unsupported for this "
2007 "non-regular file", PreallocMode_str(prealloc));
2008 return -ENOTSUP;
2011 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2012 if (offset > raw_getlength(bs)) {
2013 error_setg(errp, "Cannot grow device files");
2014 return -EINVAL;
2016 } else {
2017 error_setg(errp, "Resizing this file is not supported");
2018 return -ENOTSUP;
2021 return 0;
2024 #ifdef __OpenBSD__
2025 static int64_t raw_getlength(BlockDriverState *bs)
2027 BDRVRawState *s = bs->opaque;
2028 int fd = s->fd;
2029 struct stat st;
2031 if (fstat(fd, &st))
2032 return -errno;
2033 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2034 struct disklabel dl;
2036 if (ioctl(fd, DIOCGDINFO, &dl))
2037 return -errno;
2038 return (uint64_t)dl.d_secsize *
2039 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2040 } else
2041 return st.st_size;
2043 #elif defined(__NetBSD__)
2044 static int64_t raw_getlength(BlockDriverState *bs)
2046 BDRVRawState *s = bs->opaque;
2047 int fd = s->fd;
2048 struct stat st;
2050 if (fstat(fd, &st))
2051 return -errno;
2052 if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2053 struct dkwedge_info dkw;
2055 if (ioctl(fd, DIOCGWEDGEINFO, &dkw) != -1) {
2056 return dkw.dkw_size * 512;
2057 } else {
2058 struct disklabel dl;
2060 if (ioctl(fd, DIOCGDINFO, &dl))
2061 return -errno;
2062 return (uint64_t)dl.d_secsize *
2063 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2065 } else
2066 return st.st_size;
2068 #elif defined(__sun__)
2069 static int64_t raw_getlength(BlockDriverState *bs)
2071 BDRVRawState *s = bs->opaque;
2072 struct dk_minfo minfo;
2073 int ret;
2074 int64_t size;
2076 ret = fd_open(bs);
2077 if (ret < 0) {
2078 return ret;
2082 * Use the DKIOCGMEDIAINFO ioctl to read the size.
2084 ret = ioctl(s->fd, DKIOCGMEDIAINFO, &minfo);
2085 if (ret != -1) {
2086 return minfo.dki_lbsize * minfo.dki_capacity;
2090 * There are reports that lseek on some devices fails, but
2091 * irc discussion said that contingency on contingency was overkill.
2093 size = lseek(s->fd, 0, SEEK_END);
2094 if (size < 0) {
2095 return -errno;
2097 return size;
2099 #elif defined(CONFIG_BSD)
2100 static int64_t raw_getlength(BlockDriverState *bs)
2102 BDRVRawState *s = bs->opaque;
2103 int fd = s->fd;
2104 int64_t size;
2105 struct stat sb;
2106 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2107 int reopened = 0;
2108 #endif
2109 int ret;
2111 ret = fd_open(bs);
2112 if (ret < 0)
2113 return ret;
2115 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2116 again:
2117 #endif
2118 if (!fstat(fd, &sb) && (S_IFCHR & sb.st_mode)) {
2119 #ifdef DIOCGMEDIASIZE
2120 if (ioctl(fd, DIOCGMEDIASIZE, (off_t *)&size))
2121 #elif defined(DIOCGPART)
2123 struct partinfo pi;
2124 if (ioctl(fd, DIOCGPART, &pi) == 0)
2125 size = pi.media_size;
2126 else
2127 size = 0;
2129 if (size == 0)
2130 #endif
2131 #if defined(__APPLE__) && defined(__MACH__)
2133 uint64_t sectors = 0;
2134 uint32_t sector_size = 0;
2136 if (ioctl(fd, DKIOCGETBLOCKCOUNT, &sectors) == 0
2137 && ioctl(fd, DKIOCGETBLOCKSIZE, &sector_size) == 0) {
2138 size = sectors * sector_size;
2139 } else {
2140 size = lseek(fd, 0LL, SEEK_END);
2141 if (size < 0) {
2142 return -errno;
2146 #else
2147 size = lseek(fd, 0LL, SEEK_END);
2148 if (size < 0) {
2149 return -errno;
2151 #endif
2152 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
2153 switch(s->type) {
2154 case FTYPE_CD:
2155 /* XXX FreeBSD acd returns UINT_MAX sectors for an empty drive */
2156 if (size == 2048LL * (unsigned)-1)
2157 size = 0;
2158 /* XXX no disc? maybe we need to reopen... */
2159 if (size <= 0 && !reopened && cdrom_reopen(bs) >= 0) {
2160 reopened = 1;
2161 goto again;
2164 #endif
2165 } else {
2166 size = lseek(fd, 0, SEEK_END);
2167 if (size < 0) {
2168 return -errno;
2171 return size;
2173 #else
2174 static int64_t raw_getlength(BlockDriverState *bs)
2176 BDRVRawState *s = bs->opaque;
2177 int ret;
2178 int64_t size;
2180 ret = fd_open(bs);
2181 if (ret < 0) {
2182 return ret;
2185 size = lseek(s->fd, 0, SEEK_END);
2186 if (size < 0) {
2187 return -errno;
2189 return size;
2191 #endif
2193 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
2195 struct stat st;
2196 BDRVRawState *s = bs->opaque;
2198 if (fstat(s->fd, &st) < 0) {
2199 return -errno;
2201 return (int64_t)st.st_blocks * 512;
2204 static int coroutine_fn
2205 raw_co_create(BlockdevCreateOptions *options, Error **errp)
2207 BlockdevCreateOptionsFile *file_opts;
2208 Error *local_err = NULL;
2209 int fd;
2210 uint64_t perm, shared;
2211 int result = 0;
2213 /* Validate options and set default values */
2214 assert(options->driver == BLOCKDEV_DRIVER_FILE);
2215 file_opts = &options->u.file;
2217 if (!file_opts->has_nocow) {
2218 file_opts->nocow = false;
2220 if (!file_opts->has_preallocation) {
2221 file_opts->preallocation = PREALLOC_MODE_OFF;
2224 /* Create file */
2225 fd = qemu_open(file_opts->filename, O_RDWR | O_CREAT | O_BINARY, 0644);
2226 if (fd < 0) {
2227 result = -errno;
2228 error_setg_errno(errp, -result, "Could not create file");
2229 goto out;
2232 /* Take permissions: We want to discard everything, so we need
2233 * BLK_PERM_WRITE; and truncation to the desired size requires
2234 * BLK_PERM_RESIZE.
2235 * On the other hand, we cannot share the RESIZE permission
2236 * because we promise that after this function, the file has the
2237 * size given in the options. If someone else were to resize it
2238 * concurrently, we could not guarantee that.
2239 * Note that after this function, we can no longer guarantee that
2240 * the file is not touched by a third party, so it may be resized
2241 * then. */
2242 perm = BLK_PERM_WRITE | BLK_PERM_RESIZE;
2243 shared = BLK_PERM_ALL & ~BLK_PERM_RESIZE;
2245 /* Step one: Take locks */
2246 result = raw_apply_lock_bytes(NULL, fd, perm, ~shared, false, errp);
2247 if (result < 0) {
2248 goto out_close;
2251 /* Step two: Check that nobody else has taken conflicting locks */
2252 result = raw_check_lock_bytes(fd, perm, shared, errp);
2253 if (result < 0) {
2254 error_append_hint(errp,
2255 "Is another process using the image [%s]?\n",
2256 file_opts->filename);
2257 goto out_unlock;
2260 /* Clear the file by truncating it to 0 */
2261 result = raw_regular_truncate(NULL, fd, 0, PREALLOC_MODE_OFF, errp);
2262 if (result < 0) {
2263 goto out_unlock;
2266 if (file_opts->nocow) {
2267 #ifdef __linux__
2268 /* Set NOCOW flag to solve performance issue on fs like btrfs.
2269 * This is an optimisation. The FS_IOC_SETFLAGS ioctl return value
2270 * will be ignored since any failure of this operation should not
2271 * block the left work.
2273 int attr;
2274 if (ioctl(fd, FS_IOC_GETFLAGS, &attr) == 0) {
2275 attr |= FS_NOCOW_FL;
2276 ioctl(fd, FS_IOC_SETFLAGS, &attr);
2278 #endif
2281 /* Resize and potentially preallocate the file to the desired
2282 * final size */
2283 result = raw_regular_truncate(NULL, fd, file_opts->size,
2284 file_opts->preallocation, errp);
2285 if (result < 0) {
2286 goto out_unlock;
2289 out_unlock:
2290 raw_apply_lock_bytes(NULL, fd, 0, 0, true, &local_err);
2291 if (local_err) {
2292 /* The above call should not fail, and if it does, that does
2293 * not mean the whole creation operation has failed. So
2294 * report it the user for their convenience, but do not report
2295 * it to the caller. */
2296 warn_report_err(local_err);
2299 out_close:
2300 if (qemu_close(fd) != 0 && result == 0) {
2301 result = -errno;
2302 error_setg_errno(errp, -result, "Could not close the new file");
2304 out:
2305 return result;
2308 static int coroutine_fn raw_co_create_opts(const char *filename, QemuOpts *opts,
2309 Error **errp)
2311 BlockdevCreateOptions options;
2312 int64_t total_size = 0;
2313 bool nocow = false;
2314 PreallocMode prealloc;
2315 char *buf = NULL;
2316 Error *local_err = NULL;
2318 /* Skip file: protocol prefix */
2319 strstart(filename, "file:", &filename);
2321 /* Read out options */
2322 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2323 BDRV_SECTOR_SIZE);
2324 nocow = qemu_opt_get_bool(opts, BLOCK_OPT_NOCOW, false);
2325 buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
2326 prealloc = qapi_enum_parse(&PreallocMode_lookup, buf,
2327 PREALLOC_MODE_OFF, &local_err);
2328 g_free(buf);
2329 if (local_err) {
2330 error_propagate(errp, local_err);
2331 return -EINVAL;
2334 options = (BlockdevCreateOptions) {
2335 .driver = BLOCKDEV_DRIVER_FILE,
2336 .u.file = {
2337 .filename = (char *) filename,
2338 .size = total_size,
2339 .has_preallocation = true,
2340 .preallocation = prealloc,
2341 .has_nocow = true,
2342 .nocow = nocow,
2345 return raw_co_create(&options, errp);
2349 * Find allocation range in @bs around offset @start.
2350 * May change underlying file descriptor's file offset.
2351 * If @start is not in a hole, store @start in @data, and the
2352 * beginning of the next hole in @hole, and return 0.
2353 * If @start is in a non-trailing hole, store @start in @hole and the
2354 * beginning of the next non-hole in @data, and return 0.
2355 * If @start is in a trailing hole or beyond EOF, return -ENXIO.
2356 * If we can't find out, return a negative errno other than -ENXIO.
2358 static int find_allocation(BlockDriverState *bs, off_t start,
2359 off_t *data, off_t *hole)
2361 #if defined SEEK_HOLE && defined SEEK_DATA
2362 BDRVRawState *s = bs->opaque;
2363 off_t offs;
2366 * SEEK_DATA cases:
2367 * D1. offs == start: start is in data
2368 * D2. offs > start: start is in a hole, next data at offs
2369 * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
2370 * or start is beyond EOF
2371 * If the latter happens, the file has been truncated behind
2372 * our back since we opened it. All bets are off then.
2373 * Treating like a trailing hole is simplest.
2374 * D4. offs < 0, errno != ENXIO: we learned nothing
2376 offs = lseek(s->fd, start, SEEK_DATA);
2377 if (offs < 0) {
2378 return -errno; /* D3 or D4 */
2381 if (offs < start) {
2382 /* This is not a valid return by lseek(). We are safe to just return
2383 * -EIO in this case, and we'll treat it like D4. */
2384 return -EIO;
2387 if (offs > start) {
2388 /* D2: in hole, next data at offs */
2389 *hole = start;
2390 *data = offs;
2391 return 0;
2394 /* D1: in data, end not yet known */
2397 * SEEK_HOLE cases:
2398 * H1. offs == start: start is in a hole
2399 * If this happens here, a hole has been dug behind our back
2400 * since the previous lseek().
2401 * H2. offs > start: either start is in data, next hole at offs,
2402 * or start is in trailing hole, EOF at offs
2403 * Linux treats trailing holes like any other hole: offs ==
2404 * start. Solaris seeks to EOF instead: offs > start (blech).
2405 * If that happens here, a hole has been dug behind our back
2406 * since the previous lseek().
2407 * H3. offs < 0, errno = ENXIO: start is beyond EOF
2408 * If this happens, the file has been truncated behind our
2409 * back since we opened it. Treat it like a trailing hole.
2410 * H4. offs < 0, errno != ENXIO: we learned nothing
2411 * Pretend we know nothing at all, i.e. "forget" about D1.
2413 offs = lseek(s->fd, start, SEEK_HOLE);
2414 if (offs < 0) {
2415 return -errno; /* D1 and (H3 or H4) */
2418 if (offs < start) {
2419 /* This is not a valid return by lseek(). We are safe to just return
2420 * -EIO in this case, and we'll treat it like H4. */
2421 return -EIO;
2424 if (offs > start) {
2426 * D1 and H2: either in data, next hole at offs, or it was in
2427 * data but is now in a trailing hole. In the latter case,
2428 * all bets are off. Treating it as if it there was data all
2429 * the way to EOF is safe, so simply do that.
2431 *data = start;
2432 *hole = offs;
2433 return 0;
2436 /* D1 and H1 */
2437 return -EBUSY;
2438 #else
2439 return -ENOTSUP;
2440 #endif
2444 * Returns the allocation status of the specified offset.
2446 * The block layer guarantees 'offset' and 'bytes' are within bounds.
2448 * 'pnum' is set to the number of bytes (including and immediately following
2449 * the specified offset) that are known to be in the same
2450 * allocated/unallocated state.
2452 * 'bytes' is the max value 'pnum' should be set to.
2454 static int coroutine_fn raw_co_block_status(BlockDriverState *bs,
2455 bool want_zero,
2456 int64_t offset,
2457 int64_t bytes, int64_t *pnum,
2458 int64_t *map,
2459 BlockDriverState **file)
2461 off_t data = 0, hole = 0;
2462 int ret;
2464 assert(QEMU_IS_ALIGNED(offset | bytes, bs->bl.request_alignment));
2466 ret = fd_open(bs);
2467 if (ret < 0) {
2468 return ret;
2471 if (!want_zero) {
2472 *pnum = bytes;
2473 *map = offset;
2474 *file = bs;
2475 return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
2478 ret = find_allocation(bs, offset, &data, &hole);
2479 if (ret == -ENXIO) {
2480 /* Trailing hole */
2481 *pnum = bytes;
2482 ret = BDRV_BLOCK_ZERO;
2483 } else if (ret < 0) {
2484 /* No info available, so pretend there are no holes */
2485 *pnum = bytes;
2486 ret = BDRV_BLOCK_DATA;
2487 } else if (data == offset) {
2488 /* On a data extent, compute bytes to the end of the extent,
2489 * possibly including a partial sector at EOF. */
2490 *pnum = MIN(bytes, hole - offset);
2493 * We are not allowed to return partial sectors, though, so
2494 * round up if necessary.
2496 if (!QEMU_IS_ALIGNED(*pnum, bs->bl.request_alignment)) {
2497 int64_t file_length = raw_getlength(bs);
2498 if (file_length > 0) {
2499 /* Ignore errors, this is just a safeguard */
2500 assert(hole == file_length);
2502 *pnum = ROUND_UP(*pnum, bs->bl.request_alignment);
2505 ret = BDRV_BLOCK_DATA;
2506 } else {
2507 /* On a hole, compute bytes to the beginning of the next extent. */
2508 assert(hole == offset);
2509 *pnum = MIN(bytes, data - offset);
2510 ret = BDRV_BLOCK_ZERO;
2512 *map = offset;
2513 *file = bs;
2514 return ret | BDRV_BLOCK_OFFSET_VALID;
2517 #if defined(__linux__)
2518 /* Verify that the file is not in the page cache */
2519 static void check_cache_dropped(BlockDriverState *bs, Error **errp)
2521 const size_t window_size = 128 * 1024 * 1024;
2522 BDRVRawState *s = bs->opaque;
2523 void *window = NULL;
2524 size_t length = 0;
2525 unsigned char *vec;
2526 size_t page_size;
2527 off_t offset;
2528 off_t end;
2530 /* mincore(2) page status information requires 1 byte per page */
2531 page_size = sysconf(_SC_PAGESIZE);
2532 vec = g_malloc(DIV_ROUND_UP(window_size, page_size));
2534 end = raw_getlength(bs);
2536 for (offset = 0; offset < end; offset += window_size) {
2537 void *new_window;
2538 size_t new_length;
2539 size_t vec_end;
2540 size_t i;
2541 int ret;
2543 /* Unmap previous window if size has changed */
2544 new_length = MIN(end - offset, window_size);
2545 if (new_length != length) {
2546 munmap(window, length);
2547 window = NULL;
2548 length = 0;
2551 new_window = mmap(window, new_length, PROT_NONE, MAP_PRIVATE,
2552 s->fd, offset);
2553 if (new_window == MAP_FAILED) {
2554 error_setg_errno(errp, errno, "mmap failed");
2555 break;
2558 window = new_window;
2559 length = new_length;
2561 ret = mincore(window, length, vec);
2562 if (ret < 0) {
2563 error_setg_errno(errp, errno, "mincore failed");
2564 break;
2567 vec_end = DIV_ROUND_UP(length, page_size);
2568 for (i = 0; i < vec_end; i++) {
2569 if (vec[i] & 0x1) {
2570 error_setg(errp, "page cache still in use!");
2571 break;
2576 if (window) {
2577 munmap(window, length);
2580 g_free(vec);
2582 #endif /* __linux__ */
2584 static void coroutine_fn raw_co_invalidate_cache(BlockDriverState *bs,
2585 Error **errp)
2587 BDRVRawState *s = bs->opaque;
2588 int ret;
2590 ret = fd_open(bs);
2591 if (ret < 0) {
2592 error_setg_errno(errp, -ret, "The file descriptor is not open");
2593 return;
2596 if (s->open_flags & O_DIRECT) {
2597 return; /* No host kernel page cache */
2600 #if defined(__linux__)
2601 /* This sets the scene for the next syscall... */
2602 ret = bdrv_co_flush(bs);
2603 if (ret < 0) {
2604 error_setg_errno(errp, -ret, "flush failed");
2605 return;
2608 /* Linux does not invalidate pages that are dirty, locked, or mmapped by a
2609 * process. These limitations are okay because we just fsynced the file,
2610 * we don't use mmap, and the file should not be in use by other processes.
2612 ret = posix_fadvise(s->fd, 0, 0, POSIX_FADV_DONTNEED);
2613 if (ret != 0) { /* the return value is a positive errno */
2614 error_setg_errno(errp, ret, "fadvise failed");
2615 return;
2618 if (s->check_cache_dropped) {
2619 check_cache_dropped(bs, errp);
2621 #else /* __linux__ */
2622 /* Do nothing. Live migration to a remote host with cache.direct=off is
2623 * unsupported on other host operating systems. Cache consistency issues
2624 * may occur but no error is reported here, partly because that's the
2625 * historical behavior and partly because it's hard to differentiate valid
2626 * configurations that should not cause errors.
2628 #endif /* !__linux__ */
2631 static coroutine_fn int
2632 raw_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
2634 BDRVRawState *s = bs->opaque;
2636 return paio_submit_co(bs, s->fd, offset, NULL, bytes, QEMU_AIO_DISCARD);
2639 static int coroutine_fn raw_co_pwrite_zeroes(
2640 BlockDriverState *bs, int64_t offset,
2641 int bytes, BdrvRequestFlags flags)
2643 BDRVRawState *s = bs->opaque;
2644 int operation = QEMU_AIO_WRITE_ZEROES;
2646 if (flags & BDRV_REQ_MAY_UNMAP) {
2647 operation |= QEMU_AIO_DISCARD;
2650 return paio_submit_co(bs, s->fd, offset, NULL, bytes, operation);
2653 static int raw_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2655 BDRVRawState *s = bs->opaque;
2657 bdi->unallocated_blocks_are_zero = s->discard_zeroes;
2658 return 0;
2661 static QemuOptsList raw_create_opts = {
2662 .name = "raw-create-opts",
2663 .head = QTAILQ_HEAD_INITIALIZER(raw_create_opts.head),
2664 .desc = {
2666 .name = BLOCK_OPT_SIZE,
2667 .type = QEMU_OPT_SIZE,
2668 .help = "Virtual disk size"
2671 .name = BLOCK_OPT_NOCOW,
2672 .type = QEMU_OPT_BOOL,
2673 .help = "Turn off copy-on-write (valid only on btrfs)"
2676 .name = BLOCK_OPT_PREALLOC,
2677 .type = QEMU_OPT_STRING,
2678 .help = "Preallocation mode (allowed values: off, falloc, full)"
2680 { /* end of list */ }
2684 static int raw_check_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared,
2685 Error **errp)
2687 return raw_handle_perm_lock(bs, RAW_PL_PREPARE, perm, shared, errp);
2690 static void raw_set_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared)
2692 BDRVRawState *s = bs->opaque;
2693 raw_handle_perm_lock(bs, RAW_PL_COMMIT, perm, shared, NULL);
2694 s->perm = perm;
2695 s->shared_perm = shared;
2698 static void raw_abort_perm_update(BlockDriverState *bs)
2700 raw_handle_perm_lock(bs, RAW_PL_ABORT, 0, 0, NULL);
2703 static int coroutine_fn raw_co_copy_range_from(
2704 BlockDriverState *bs, BdrvChild *src, uint64_t src_offset,
2705 BdrvChild *dst, uint64_t dst_offset, uint64_t bytes,
2706 BdrvRequestFlags read_flags, BdrvRequestFlags write_flags)
2708 return bdrv_co_copy_range_to(src, src_offset, dst, dst_offset, bytes,
2709 read_flags, write_flags);
2712 static int coroutine_fn raw_co_copy_range_to(BlockDriverState *bs,
2713 BdrvChild *src,
2714 uint64_t src_offset,
2715 BdrvChild *dst,
2716 uint64_t dst_offset,
2717 uint64_t bytes,
2718 BdrvRequestFlags read_flags,
2719 BdrvRequestFlags write_flags)
2721 BDRVRawState *s = bs->opaque;
2722 BDRVRawState *src_s;
2724 assert(dst->bs == bs);
2725 if (src->bs->drv->bdrv_co_copy_range_to != raw_co_copy_range_to) {
2726 return -ENOTSUP;
2729 src_s = src->bs->opaque;
2730 if (fd_open(src->bs) < 0 || fd_open(dst->bs) < 0) {
2731 return -EIO;
2733 return paio_submit_co_full(bs, src_s->fd, src_offset, s->fd, dst_offset,
2734 NULL, bytes, QEMU_AIO_COPY_RANGE);
2737 BlockDriver bdrv_file = {
2738 .format_name = "file",
2739 .protocol_name = "file",
2740 .instance_size = sizeof(BDRVRawState),
2741 .bdrv_needs_filename = true,
2742 .bdrv_probe = NULL, /* no probe for protocols */
2743 .bdrv_parse_filename = raw_parse_filename,
2744 .bdrv_file_open = raw_open,
2745 .bdrv_reopen_prepare = raw_reopen_prepare,
2746 .bdrv_reopen_commit = raw_reopen_commit,
2747 .bdrv_reopen_abort = raw_reopen_abort,
2748 .bdrv_close = raw_close,
2749 .bdrv_co_create = raw_co_create,
2750 .bdrv_co_create_opts = raw_co_create_opts,
2751 .bdrv_has_zero_init = bdrv_has_zero_init_1,
2752 .bdrv_co_block_status = raw_co_block_status,
2753 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
2754 .bdrv_co_pwrite_zeroes = raw_co_pwrite_zeroes,
2756 .bdrv_co_preadv = raw_co_preadv,
2757 .bdrv_co_pwritev = raw_co_pwritev,
2758 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
2759 .bdrv_co_pdiscard = raw_co_pdiscard,
2760 .bdrv_co_copy_range_from = raw_co_copy_range_from,
2761 .bdrv_co_copy_range_to = raw_co_copy_range_to,
2762 .bdrv_refresh_limits = raw_refresh_limits,
2763 .bdrv_io_plug = raw_aio_plug,
2764 .bdrv_io_unplug = raw_aio_unplug,
2765 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
2767 .bdrv_co_truncate = raw_co_truncate,
2768 .bdrv_getlength = raw_getlength,
2769 .bdrv_get_info = raw_get_info,
2770 .bdrv_get_allocated_file_size
2771 = raw_get_allocated_file_size,
2772 .bdrv_check_perm = raw_check_perm,
2773 .bdrv_set_perm = raw_set_perm,
2774 .bdrv_abort_perm_update = raw_abort_perm_update,
2775 .create_opts = &raw_create_opts,
2778 /***********************************************/
2779 /* host device */
2781 #if defined(__APPLE__) && defined(__MACH__)
2782 static kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
2783 CFIndex maxPathSize, int flags);
2784 static char *FindEjectableOpticalMedia(io_iterator_t *mediaIterator)
2786 kern_return_t kernResult = KERN_FAILURE;
2787 mach_port_t masterPort;
2788 CFMutableDictionaryRef classesToMatch;
2789 const char *matching_array[] = {kIODVDMediaClass, kIOCDMediaClass};
2790 char *mediaType = NULL;
2792 kernResult = IOMasterPort( MACH_PORT_NULL, &masterPort );
2793 if ( KERN_SUCCESS != kernResult ) {
2794 printf( "IOMasterPort returned %d\n", kernResult );
2797 int index;
2798 for (index = 0; index < ARRAY_SIZE(matching_array); index++) {
2799 classesToMatch = IOServiceMatching(matching_array[index]);
2800 if (classesToMatch == NULL) {
2801 error_report("IOServiceMatching returned NULL for %s",
2802 matching_array[index]);
2803 continue;
2805 CFDictionarySetValue(classesToMatch, CFSTR(kIOMediaEjectableKey),
2806 kCFBooleanTrue);
2807 kernResult = IOServiceGetMatchingServices(masterPort, classesToMatch,
2808 mediaIterator);
2809 if (kernResult != KERN_SUCCESS) {
2810 error_report("Note: IOServiceGetMatchingServices returned %d",
2811 kernResult);
2812 continue;
2815 /* If a match was found, leave the loop */
2816 if (*mediaIterator != 0) {
2817 DPRINTF("Matching using %s\n", matching_array[index]);
2818 mediaType = g_strdup(matching_array[index]);
2819 break;
2822 return mediaType;
2825 kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
2826 CFIndex maxPathSize, int flags)
2828 io_object_t nextMedia;
2829 kern_return_t kernResult = KERN_FAILURE;
2830 *bsdPath = '\0';
2831 nextMedia = IOIteratorNext( mediaIterator );
2832 if ( nextMedia )
2834 CFTypeRef bsdPathAsCFString;
2835 bsdPathAsCFString = IORegistryEntryCreateCFProperty( nextMedia, CFSTR( kIOBSDNameKey ), kCFAllocatorDefault, 0 );
2836 if ( bsdPathAsCFString ) {
2837 size_t devPathLength;
2838 strcpy( bsdPath, _PATH_DEV );
2839 if (flags & BDRV_O_NOCACHE) {
2840 strcat(bsdPath, "r");
2842 devPathLength = strlen( bsdPath );
2843 if ( CFStringGetCString( bsdPathAsCFString, bsdPath + devPathLength, maxPathSize - devPathLength, kCFStringEncodingASCII ) ) {
2844 kernResult = KERN_SUCCESS;
2846 CFRelease( bsdPathAsCFString );
2848 IOObjectRelease( nextMedia );
2851 return kernResult;
2854 /* Sets up a real cdrom for use in QEMU */
2855 static bool setup_cdrom(char *bsd_path, Error **errp)
2857 int index, num_of_test_partitions = 2, fd;
2858 char test_partition[MAXPATHLEN];
2859 bool partition_found = false;
2861 /* look for a working partition */
2862 for (index = 0; index < num_of_test_partitions; index++) {
2863 snprintf(test_partition, sizeof(test_partition), "%ss%d", bsd_path,
2864 index);
2865 fd = qemu_open(test_partition, O_RDONLY | O_BINARY | O_LARGEFILE);
2866 if (fd >= 0) {
2867 partition_found = true;
2868 qemu_close(fd);
2869 break;
2873 /* if a working partition on the device was not found */
2874 if (partition_found == false) {
2875 error_setg(errp, "Failed to find a working partition on disc");
2876 } else {
2877 DPRINTF("Using %s as optical disc\n", test_partition);
2878 pstrcpy(bsd_path, MAXPATHLEN, test_partition);
2880 return partition_found;
2883 /* Prints directions on mounting and unmounting a device */
2884 static void print_unmounting_directions(const char *file_name)
2886 error_report("If device %s is mounted on the desktop, unmount"
2887 " it first before using it in QEMU", file_name);
2888 error_report("Command to unmount device: diskutil unmountDisk %s",
2889 file_name);
2890 error_report("Command to mount device: diskutil mountDisk %s", file_name);
2893 #endif /* defined(__APPLE__) && defined(__MACH__) */
2895 static int hdev_probe_device(const char *filename)
2897 struct stat st;
2899 /* allow a dedicated CD-ROM driver to match with a higher priority */
2900 if (strstart(filename, "/dev/cdrom", NULL))
2901 return 50;
2903 if (stat(filename, &st) >= 0 &&
2904 (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
2905 return 100;
2908 return 0;
2911 static int check_hdev_writable(BDRVRawState *s)
2913 #if defined(BLKROGET)
2914 /* Linux block devices can be configured "read-only" using blockdev(8).
2915 * This is independent of device node permissions and therefore open(2)
2916 * with O_RDWR succeeds. Actual writes fail with EPERM.
2918 * bdrv_open() is supposed to fail if the disk is read-only. Explicitly
2919 * check for read-only block devices so that Linux block devices behave
2920 * properly.
2922 struct stat st;
2923 int readonly = 0;
2925 if (fstat(s->fd, &st)) {
2926 return -errno;
2929 if (!S_ISBLK(st.st_mode)) {
2930 return 0;
2933 if (ioctl(s->fd, BLKROGET, &readonly) < 0) {
2934 return -errno;
2937 if (readonly) {
2938 return -EACCES;
2940 #endif /* defined(BLKROGET) */
2941 return 0;
2944 static void hdev_parse_filename(const char *filename, QDict *options,
2945 Error **errp)
2947 bdrv_parse_filename_strip_prefix(filename, "host_device:", options);
2950 static bool hdev_is_sg(BlockDriverState *bs)
2953 #if defined(__linux__)
2955 BDRVRawState *s = bs->opaque;
2956 struct stat st;
2957 struct sg_scsi_id scsiid;
2958 int sg_version;
2959 int ret;
2961 if (stat(bs->filename, &st) < 0 || !S_ISCHR(st.st_mode)) {
2962 return false;
2965 ret = ioctl(s->fd, SG_GET_VERSION_NUM, &sg_version);
2966 if (ret < 0) {
2967 return false;
2970 ret = ioctl(s->fd, SG_GET_SCSI_ID, &scsiid);
2971 if (ret >= 0) {
2972 DPRINTF("SG device found: type=%d, version=%d\n",
2973 scsiid.scsi_type, sg_version);
2974 return true;
2977 #endif
2979 return false;
2982 static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
2983 Error **errp)
2985 BDRVRawState *s = bs->opaque;
2986 Error *local_err = NULL;
2987 int ret;
2989 #if defined(__APPLE__) && defined(__MACH__)
2991 * Caution: while qdict_get_str() is fine, getting non-string types
2992 * would require more care. When @options come from -blockdev or
2993 * blockdev_add, its members are typed according to the QAPI
2994 * schema, but when they come from -drive, they're all QString.
2996 const char *filename = qdict_get_str(options, "filename");
2997 char bsd_path[MAXPATHLEN] = "";
2998 bool error_occurred = false;
3000 /* If using a real cdrom */
3001 if (strcmp(filename, "/dev/cdrom") == 0) {
3002 char *mediaType = NULL;
3003 kern_return_t ret_val;
3004 io_iterator_t mediaIterator = 0;
3006 mediaType = FindEjectableOpticalMedia(&mediaIterator);
3007 if (mediaType == NULL) {
3008 error_setg(errp, "Please make sure your CD/DVD is in the optical"
3009 " drive");
3010 error_occurred = true;
3011 goto hdev_open_Mac_error;
3014 ret_val = GetBSDPath(mediaIterator, bsd_path, sizeof(bsd_path), flags);
3015 if (ret_val != KERN_SUCCESS) {
3016 error_setg(errp, "Could not get BSD path for optical drive");
3017 error_occurred = true;
3018 goto hdev_open_Mac_error;
3021 /* If a real optical drive was not found */
3022 if (bsd_path[0] == '\0') {
3023 error_setg(errp, "Failed to obtain bsd path for optical drive");
3024 error_occurred = true;
3025 goto hdev_open_Mac_error;
3028 /* If using a cdrom disc and finding a partition on the disc failed */
3029 if (strncmp(mediaType, kIOCDMediaClass, 9) == 0 &&
3030 setup_cdrom(bsd_path, errp) == false) {
3031 print_unmounting_directions(bsd_path);
3032 error_occurred = true;
3033 goto hdev_open_Mac_error;
3036 qdict_put_str(options, "filename", bsd_path);
3038 hdev_open_Mac_error:
3039 g_free(mediaType);
3040 if (mediaIterator) {
3041 IOObjectRelease(mediaIterator);
3043 if (error_occurred) {
3044 return -ENOENT;
3047 #endif /* defined(__APPLE__) && defined(__MACH__) */
3049 s->type = FTYPE_FILE;
3051 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3052 if (ret < 0) {
3053 error_propagate(errp, local_err);
3054 #if defined(__APPLE__) && defined(__MACH__)
3055 if (*bsd_path) {
3056 filename = bsd_path;
3058 /* if a physical device experienced an error while being opened */
3059 if (strncmp(filename, "/dev/", 5) == 0) {
3060 print_unmounting_directions(filename);
3062 #endif /* defined(__APPLE__) && defined(__MACH__) */
3063 return ret;
3066 /* Since this does ioctl the device must be already opened */
3067 bs->sg = hdev_is_sg(bs);
3069 if (flags & BDRV_O_RDWR) {
3070 ret = check_hdev_writable(s);
3071 if (ret < 0) {
3072 raw_close(bs);
3073 error_setg_errno(errp, -ret, "The device is not writable");
3074 return ret;
3078 return ret;
3081 #if defined(__linux__)
3083 static BlockAIOCB *hdev_aio_ioctl(BlockDriverState *bs,
3084 unsigned long int req, void *buf,
3085 BlockCompletionFunc *cb, void *opaque)
3087 BDRVRawState *s = bs->opaque;
3088 RawPosixAIOData *acb;
3089 ThreadPool *pool;
3091 if (fd_open(bs) < 0)
3092 return NULL;
3094 if (req == SG_IO && s->pr_mgr) {
3095 struct sg_io_hdr *io_hdr = buf;
3096 if (io_hdr->cmdp[0] == PERSISTENT_RESERVE_OUT ||
3097 io_hdr->cmdp[0] == PERSISTENT_RESERVE_IN) {
3098 return pr_manager_execute(s->pr_mgr, bdrv_get_aio_context(bs),
3099 s->fd, io_hdr, cb, opaque);
3103 acb = g_new(RawPosixAIOData, 1);
3104 acb->bs = bs;
3105 acb->aio_type = QEMU_AIO_IOCTL;
3106 acb->aio_fildes = s->fd;
3107 acb->aio_offset = 0;
3108 acb->aio_ioctl_buf = buf;
3109 acb->aio_ioctl_cmd = req;
3110 pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
3111 return thread_pool_submit_aio(pool, aio_worker, acb, cb, opaque);
3113 #endif /* linux */
3115 static int fd_open(BlockDriverState *bs)
3117 BDRVRawState *s = bs->opaque;
3119 /* this is just to ensure s->fd is sane (its called by io ops) */
3120 if (s->fd >= 0)
3121 return 0;
3122 return -EIO;
3125 static coroutine_fn int
3126 hdev_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
3128 BDRVRawState *s = bs->opaque;
3129 int ret;
3131 ret = fd_open(bs);
3132 if (ret < 0) {
3133 return ret;
3135 return paio_submit_co(bs, s->fd, offset, NULL, bytes,
3136 QEMU_AIO_DISCARD | QEMU_AIO_BLKDEV);
3139 static coroutine_fn int hdev_co_pwrite_zeroes(BlockDriverState *bs,
3140 int64_t offset, int bytes, BdrvRequestFlags flags)
3142 BDRVRawState *s = bs->opaque;
3143 int operation = QEMU_AIO_WRITE_ZEROES | QEMU_AIO_BLKDEV;
3144 int rc;
3146 rc = fd_open(bs);
3147 if (rc < 0) {
3148 return rc;
3151 if (flags & BDRV_REQ_MAY_UNMAP) {
3152 operation |= QEMU_AIO_DISCARD;
3155 return paio_submit_co(bs, s->fd, offset, NULL, bytes, operation);
3158 static int coroutine_fn hdev_co_create_opts(const char *filename, QemuOpts *opts,
3159 Error **errp)
3161 int fd;
3162 int ret = 0;
3163 struct stat stat_buf;
3164 int64_t total_size = 0;
3165 bool has_prefix;
3167 /* This function is used by both protocol block drivers and therefore either
3168 * of these prefixes may be given.
3169 * The return value has to be stored somewhere, otherwise this is an error
3170 * due to -Werror=unused-value. */
3171 has_prefix =
3172 strstart(filename, "host_device:", &filename) ||
3173 strstart(filename, "host_cdrom:" , &filename);
3175 (void)has_prefix;
3177 ret = raw_normalize_devicepath(&filename, errp);
3178 if (ret < 0) {
3179 return ret;
3182 /* Read out options */
3183 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
3184 BDRV_SECTOR_SIZE);
3186 fd = qemu_open(filename, O_WRONLY | O_BINARY);
3187 if (fd < 0) {
3188 ret = -errno;
3189 error_setg_errno(errp, -ret, "Could not open device");
3190 return ret;
3193 if (fstat(fd, &stat_buf) < 0) {
3194 ret = -errno;
3195 error_setg_errno(errp, -ret, "Could not stat device");
3196 } else if (!S_ISBLK(stat_buf.st_mode) && !S_ISCHR(stat_buf.st_mode)) {
3197 error_setg(errp,
3198 "The given file is neither a block nor a character device");
3199 ret = -ENODEV;
3200 } else if (lseek(fd, 0, SEEK_END) < total_size) {
3201 error_setg(errp, "Device is too small");
3202 ret = -ENOSPC;
3205 if (!ret && total_size) {
3206 uint8_t buf[BDRV_SECTOR_SIZE] = { 0 };
3207 int64_t zero_size = MIN(BDRV_SECTOR_SIZE, total_size);
3208 if (lseek(fd, 0, SEEK_SET) == -1) {
3209 ret = -errno;
3210 } else {
3211 ret = qemu_write_full(fd, buf, zero_size);
3212 ret = ret == zero_size ? 0 : -errno;
3215 qemu_close(fd);
3216 return ret;
3219 static BlockDriver bdrv_host_device = {
3220 .format_name = "host_device",
3221 .protocol_name = "host_device",
3222 .instance_size = sizeof(BDRVRawState),
3223 .bdrv_needs_filename = true,
3224 .bdrv_probe_device = hdev_probe_device,
3225 .bdrv_parse_filename = hdev_parse_filename,
3226 .bdrv_file_open = hdev_open,
3227 .bdrv_close = raw_close,
3228 .bdrv_reopen_prepare = raw_reopen_prepare,
3229 .bdrv_reopen_commit = raw_reopen_commit,
3230 .bdrv_reopen_abort = raw_reopen_abort,
3231 .bdrv_co_create_opts = hdev_co_create_opts,
3232 .create_opts = &raw_create_opts,
3233 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3234 .bdrv_co_pwrite_zeroes = hdev_co_pwrite_zeroes,
3236 .bdrv_co_preadv = raw_co_preadv,
3237 .bdrv_co_pwritev = raw_co_pwritev,
3238 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3239 .bdrv_co_pdiscard = hdev_co_pdiscard,
3240 .bdrv_co_copy_range_from = raw_co_copy_range_from,
3241 .bdrv_co_copy_range_to = raw_co_copy_range_to,
3242 .bdrv_refresh_limits = raw_refresh_limits,
3243 .bdrv_io_plug = raw_aio_plug,
3244 .bdrv_io_unplug = raw_aio_unplug,
3245 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3247 .bdrv_co_truncate = raw_co_truncate,
3248 .bdrv_getlength = raw_getlength,
3249 .bdrv_get_info = raw_get_info,
3250 .bdrv_get_allocated_file_size
3251 = raw_get_allocated_file_size,
3252 .bdrv_check_perm = raw_check_perm,
3253 .bdrv_set_perm = raw_set_perm,
3254 .bdrv_abort_perm_update = raw_abort_perm_update,
3255 .bdrv_probe_blocksizes = hdev_probe_blocksizes,
3256 .bdrv_probe_geometry = hdev_probe_geometry,
3258 /* generic scsi device */
3259 #ifdef __linux__
3260 .bdrv_aio_ioctl = hdev_aio_ioctl,
3261 #endif
3264 #if defined(__linux__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3265 static void cdrom_parse_filename(const char *filename, QDict *options,
3266 Error **errp)
3268 bdrv_parse_filename_strip_prefix(filename, "host_cdrom:", options);
3270 #endif
3272 #ifdef __linux__
3273 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3274 Error **errp)
3276 BDRVRawState *s = bs->opaque;
3278 s->type = FTYPE_CD;
3280 /* open will not fail even if no CD is inserted, so add O_NONBLOCK */
3281 return raw_open_common(bs, options, flags, O_NONBLOCK, true, errp);
3284 static int cdrom_probe_device(const char *filename)
3286 int fd, ret;
3287 int prio = 0;
3288 struct stat st;
3290 fd = qemu_open(filename, O_RDONLY | O_NONBLOCK);
3291 if (fd < 0) {
3292 goto out;
3294 ret = fstat(fd, &st);
3295 if (ret == -1 || !S_ISBLK(st.st_mode)) {
3296 goto outc;
3299 /* Attempt to detect via a CDROM specific ioctl */
3300 ret = ioctl(fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3301 if (ret >= 0)
3302 prio = 100;
3304 outc:
3305 qemu_close(fd);
3306 out:
3307 return prio;
3310 static bool cdrom_is_inserted(BlockDriverState *bs)
3312 BDRVRawState *s = bs->opaque;
3313 int ret;
3315 ret = ioctl(s->fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3316 return ret == CDS_DISC_OK;
3319 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3321 BDRVRawState *s = bs->opaque;
3323 if (eject_flag) {
3324 if (ioctl(s->fd, CDROMEJECT, NULL) < 0)
3325 perror("CDROMEJECT");
3326 } else {
3327 if (ioctl(s->fd, CDROMCLOSETRAY, NULL) < 0)
3328 perror("CDROMEJECT");
3332 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3334 BDRVRawState *s = bs->opaque;
3336 if (ioctl(s->fd, CDROM_LOCKDOOR, locked) < 0) {
3338 * Note: an error can happen if the distribution automatically
3339 * mounts the CD-ROM
3341 /* perror("CDROM_LOCKDOOR"); */
3345 static BlockDriver bdrv_host_cdrom = {
3346 .format_name = "host_cdrom",
3347 .protocol_name = "host_cdrom",
3348 .instance_size = sizeof(BDRVRawState),
3349 .bdrv_needs_filename = true,
3350 .bdrv_probe_device = cdrom_probe_device,
3351 .bdrv_parse_filename = cdrom_parse_filename,
3352 .bdrv_file_open = cdrom_open,
3353 .bdrv_close = raw_close,
3354 .bdrv_reopen_prepare = raw_reopen_prepare,
3355 .bdrv_reopen_commit = raw_reopen_commit,
3356 .bdrv_reopen_abort = raw_reopen_abort,
3357 .bdrv_co_create_opts = hdev_co_create_opts,
3358 .create_opts = &raw_create_opts,
3359 .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3362 .bdrv_co_preadv = raw_co_preadv,
3363 .bdrv_co_pwritev = raw_co_pwritev,
3364 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3365 .bdrv_refresh_limits = raw_refresh_limits,
3366 .bdrv_io_plug = raw_aio_plug,
3367 .bdrv_io_unplug = raw_aio_unplug,
3368 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3370 .bdrv_co_truncate = raw_co_truncate,
3371 .bdrv_getlength = raw_getlength,
3372 .has_variable_length = true,
3373 .bdrv_get_allocated_file_size
3374 = raw_get_allocated_file_size,
3376 /* removable device support */
3377 .bdrv_is_inserted = cdrom_is_inserted,
3378 .bdrv_eject = cdrom_eject,
3379 .bdrv_lock_medium = cdrom_lock_medium,
3381 /* generic scsi device */
3382 .bdrv_aio_ioctl = hdev_aio_ioctl,
3384 #endif /* __linux__ */
3386 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
3387 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3388 Error **errp)
3390 BDRVRawState *s = bs->opaque;
3391 Error *local_err = NULL;
3392 int ret;
3394 s->type = FTYPE_CD;
3396 ret = raw_open_common(bs, options, flags, 0, true, &local_err);
3397 if (ret) {
3398 error_propagate(errp, local_err);
3399 return ret;
3402 /* make sure the door isn't locked at this time */
3403 ioctl(s->fd, CDIOCALLOW);
3404 return 0;
3407 static int cdrom_probe_device(const char *filename)
3409 if (strstart(filename, "/dev/cd", NULL) ||
3410 strstart(filename, "/dev/acd", NULL))
3411 return 100;
3412 return 0;
3415 static int cdrom_reopen(BlockDriverState *bs)
3417 BDRVRawState *s = bs->opaque;
3418 int fd;
3421 * Force reread of possibly changed/newly loaded disc,
3422 * FreeBSD seems to not notice sometimes...
3424 if (s->fd >= 0)
3425 qemu_close(s->fd);
3426 fd = qemu_open(bs->filename, s->open_flags, 0644);
3427 if (fd < 0) {
3428 s->fd = -1;
3429 return -EIO;
3431 s->fd = fd;
3433 /* make sure the door isn't locked at this time */
3434 ioctl(s->fd, CDIOCALLOW);
3435 return 0;
3438 static bool cdrom_is_inserted(BlockDriverState *bs)
3440 return raw_getlength(bs) > 0;
3443 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3445 BDRVRawState *s = bs->opaque;
3447 if (s->fd < 0)
3448 return;
3450 (void) ioctl(s->fd, CDIOCALLOW);
3452 if (eject_flag) {
3453 if (ioctl(s->fd, CDIOCEJECT) < 0)
3454 perror("CDIOCEJECT");
3455 } else {
3456 if (ioctl(s->fd, CDIOCCLOSE) < 0)
3457 perror("CDIOCCLOSE");
3460 cdrom_reopen(bs);
3463 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3465 BDRVRawState *s = bs->opaque;
3467 if (s->fd < 0)
3468 return;
3469 if (ioctl(s->fd, (locked ? CDIOCPREVENT : CDIOCALLOW)) < 0) {
3471 * Note: an error can happen if the distribution automatically
3472 * mounts the CD-ROM
3474 /* perror("CDROM_LOCKDOOR"); */
3478 static BlockDriver bdrv_host_cdrom = {
3479 .format_name = "host_cdrom",
3480 .protocol_name = "host_cdrom",
3481 .instance_size = sizeof(BDRVRawState),
3482 .bdrv_needs_filename = true,
3483 .bdrv_probe_device = cdrom_probe_device,
3484 .bdrv_parse_filename = cdrom_parse_filename,
3485 .bdrv_file_open = cdrom_open,
3486 .bdrv_close = raw_close,
3487 .bdrv_reopen_prepare = raw_reopen_prepare,
3488 .bdrv_reopen_commit = raw_reopen_commit,
3489 .bdrv_reopen_abort = raw_reopen_abort,
3490 .bdrv_co_create_opts = hdev_co_create_opts,
3491 .create_opts = &raw_create_opts,
3493 .bdrv_co_preadv = raw_co_preadv,
3494 .bdrv_co_pwritev = raw_co_pwritev,
3495 .bdrv_co_flush_to_disk = raw_co_flush_to_disk,
3496 .bdrv_refresh_limits = raw_refresh_limits,
3497 .bdrv_io_plug = raw_aio_plug,
3498 .bdrv_io_unplug = raw_aio_unplug,
3499 .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3501 .bdrv_co_truncate = raw_co_truncate,
3502 .bdrv_getlength = raw_getlength,
3503 .has_variable_length = true,
3504 .bdrv_get_allocated_file_size
3505 = raw_get_allocated_file_size,
3507 /* removable device support */
3508 .bdrv_is_inserted = cdrom_is_inserted,
3509 .bdrv_eject = cdrom_eject,
3510 .bdrv_lock_medium = cdrom_lock_medium,
3512 #endif /* __FreeBSD__ */
3514 static void bdrv_file_init(void)
3517 * Register all the drivers. Note that order is important, the driver
3518 * registered last will get probed first.
3520 bdrv_register(&bdrv_file);
3521 bdrv_register(&bdrv_host_device);
3522 #ifdef __linux__
3523 bdrv_register(&bdrv_host_cdrom);
3524 #endif
3525 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3526 bdrv_register(&bdrv_host_cdrom);
3527 #endif
3530 block_init(bdrv_file_init);