xref: /qemu/block/file-posix.c (revision b83a80e8)
1 /*
2  * Block driver for RAW files (posix)
3  *
4  * Copyright (c) 2006 Fabrice Bellard
5  *
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:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
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.
23  */
24 
25 #include "qemu/osdep.h"
26 #include "qemu-common.h"
27 #include "qapi/error.h"
28 #include "qemu/cutils.h"
29 #include "qemu/error-report.h"
30 #include "block/block_int.h"
31 #include "qemu/module.h"
32 #include "qemu/option.h"
33 #include "qemu/units.h"
34 #include "trace.h"
35 #include "block/thread-pool.h"
36 #include "qemu/iov.h"
37 #include "block/raw-aio.h"
38 #include "qapi/qmp/qdict.h"
39 #include "qapi/qmp/qstring.h"
40 
41 #include "scsi/pr-manager.h"
42 #include "scsi/constants.h"
43 
44 #if defined(__APPLE__) && (__MACH__)
45 #include <sys/ioctl.h>
46 #if defined(HAVE_HOST_BLOCK_DEVICE)
47 #include <paths.h>
48 #include <sys/param.h>
49 #include <sys/mount.h>
50 #include <IOKit/IOKitLib.h>
51 #include <IOKit/IOBSD.h>
52 #include <IOKit/storage/IOMediaBSDClient.h>
53 #include <IOKit/storage/IOMedia.h>
54 #include <IOKit/storage/IOCDMedia.h>
55 //#include <IOKit/storage/IOCDTypes.h>
56 #include <IOKit/storage/IODVDMedia.h>
57 #include <CoreFoundation/CoreFoundation.h>
58 #endif /* defined(HAVE_HOST_BLOCK_DEVICE) */
59 #endif
60 
61 #ifdef __sun__
62 #define _POSIX_PTHREAD_SEMANTICS 1
63 #include <sys/dkio.h>
64 #endif
65 #ifdef __linux__
66 #include <sys/ioctl.h>
67 #include <sys/param.h>
68 #include <sys/syscall.h>
69 #include <sys/vfs.h>
70 #include <linux/cdrom.h>
71 #include <linux/fd.h>
72 #include <linux/fs.h>
73 #include <linux/hdreg.h>
74 #include <linux/magic.h>
75 #include <scsi/sg.h>
76 #ifdef __s390__
77 #include <asm/dasd.h>
78 #endif
79 #ifndef FS_NOCOW_FL
80 #define FS_NOCOW_FL                     0x00800000 /* Do not cow file */
81 #endif
82 #endif
83 #if defined(CONFIG_FALLOCATE_PUNCH_HOLE) || defined(CONFIG_FALLOCATE_ZERO_RANGE)
84 #include <linux/falloc.h>
85 #endif
86 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
87 #include <sys/disk.h>
88 #include <sys/cdio.h>
89 #endif
90 
91 #ifdef __OpenBSD__
92 #include <sys/ioctl.h>
93 #include <sys/disklabel.h>
94 #include <sys/dkio.h>
95 #endif
96 
97 #ifdef __NetBSD__
98 #include <sys/ioctl.h>
99 #include <sys/disklabel.h>
100 #include <sys/dkio.h>
101 #include <sys/disk.h>
102 #endif
103 
104 #ifdef __DragonFly__
105 #include <sys/ioctl.h>
106 #include <sys/diskslice.h>
107 #endif
108 
109 /* OS X does not have O_DSYNC */
110 #ifndef O_DSYNC
111 #ifdef O_SYNC
112 #define O_DSYNC O_SYNC
113 #elif defined(O_FSYNC)
114 #define O_DSYNC O_FSYNC
115 #endif
116 #endif
117 
118 /* Approximate O_DIRECT with O_DSYNC if O_DIRECT isn't available */
119 #ifndef O_DIRECT
120 #define O_DIRECT O_DSYNC
121 #endif
122 
123 #define FTYPE_FILE   0
124 #define FTYPE_CD     1
125 
126 #define MAX_BLOCKSIZE	4096
127 
128 /* Posix file locking bytes. Libvirt takes byte 0, we start from higher bytes,
129  * leaving a few more bytes for its future use. */
130 #define RAW_LOCK_PERM_BASE             100
131 #define RAW_LOCK_SHARED_BASE           200
132 
133 typedef struct BDRVRawState {
134     int fd;
135     bool use_lock;
136     int type;
137     int open_flags;
138     size_t buf_align;
139 
140     /* The current permissions. */
141     uint64_t perm;
142     uint64_t shared_perm;
143 
144     /* The perms bits whose corresponding bytes are already locked in
145      * s->fd. */
146     uint64_t locked_perm;
147     uint64_t locked_shared_perm;
148 
149     uint64_t aio_max_batch;
150 
151     int perm_change_fd;
152     int perm_change_flags;
153     BDRVReopenState *reopen_state;
154 
155     bool has_discard:1;
156     bool has_write_zeroes:1;
157     bool discard_zeroes:1;
158     bool use_linux_aio:1;
159     bool use_linux_io_uring:1;
160     int page_cache_inconsistent; /* errno from fdatasync failure */
161     bool has_fallocate;
162     bool needs_alignment;
163     bool force_alignment;
164     bool drop_cache;
165     bool check_cache_dropped;
166     struct {
167         uint64_t discard_nb_ok;
168         uint64_t discard_nb_failed;
169         uint64_t discard_bytes_ok;
170     } stats;
171 
172     PRManager *pr_mgr;
173 } BDRVRawState;
174 
175 typedef struct BDRVRawReopenState {
176     int open_flags;
177     bool drop_cache;
178     bool check_cache_dropped;
179 } BDRVRawReopenState;
180 
181 static int fd_open(BlockDriverState *bs)
182 {
183     BDRVRawState *s = bs->opaque;
184 
185     /* this is just to ensure s->fd is sane (its called by io ops) */
186     if (s->fd >= 0) {
187         return 0;
188     }
189     return -EIO;
190 }
191 
192 static int64_t raw_getlength(BlockDriverState *bs);
193 
194 typedef struct RawPosixAIOData {
195     BlockDriverState *bs;
196     int aio_type;
197     int aio_fildes;
198 
199     off_t aio_offset;
200     uint64_t aio_nbytes;
201 
202     union {
203         struct {
204             struct iovec *iov;
205             int niov;
206         } io;
207         struct {
208             uint64_t cmd;
209             void *buf;
210         } ioctl;
211         struct {
212             int aio_fd2;
213             off_t aio_offset2;
214         } copy_range;
215         struct {
216             PreallocMode prealloc;
217             Error **errp;
218         } truncate;
219     };
220 } RawPosixAIOData;
221 
222 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
223 static int cdrom_reopen(BlockDriverState *bs);
224 #endif
225 
226 /*
227  * Elide EAGAIN and EACCES details when failing to lock, as this
228  * indicates that the specified file region is already locked by
229  * another process, which is considered a common scenario.
230  */
231 #define raw_lock_error_setg_errno(errp, err, fmt, ...)                  \
232     do {                                                                \
233         if ((err) == EAGAIN || (err) == EACCES) {                       \
234             error_setg((errp), (fmt), ## __VA_ARGS__);                  \
235         } else {                                                        \
236             error_setg_errno((errp), (err), (fmt), ## __VA_ARGS__);     \
237         }                                                               \
238     } while (0)
239 
240 #if defined(__NetBSD__)
241 static int raw_normalize_devicepath(const char **filename, Error **errp)
242 {
243     static char namebuf[PATH_MAX];
244     const char *dp, *fname;
245     struct stat sb;
246 
247     fname = *filename;
248     dp = strrchr(fname, '/');
249     if (lstat(fname, &sb) < 0) {
250         error_setg_file_open(errp, errno, fname);
251         return -errno;
252     }
253 
254     if (!S_ISBLK(sb.st_mode)) {
255         return 0;
256     }
257 
258     if (dp == NULL) {
259         snprintf(namebuf, PATH_MAX, "r%s", fname);
260     } else {
261         snprintf(namebuf, PATH_MAX, "%.*s/r%s",
262             (int)(dp - fname), fname, dp + 1);
263     }
264     *filename = namebuf;
265     warn_report("%s is a block device, using %s", fname, *filename);
266 
267     return 0;
268 }
269 #else
270 static int raw_normalize_devicepath(const char **filename, Error **errp)
271 {
272     return 0;
273 }
274 #endif
275 
276 /*
277  * Get logical block size via ioctl. On success store it in @sector_size_p.
278  */
279 static int probe_logical_blocksize(int fd, unsigned int *sector_size_p)
280 {
281     unsigned int sector_size;
282     bool success = false;
283     int i;
284 
285     errno = ENOTSUP;
286     static const unsigned long ioctl_list[] = {
287 #ifdef BLKSSZGET
288         BLKSSZGET,
289 #endif
290 #ifdef DKIOCGETBLOCKSIZE
291         DKIOCGETBLOCKSIZE,
292 #endif
293 #ifdef DIOCGSECTORSIZE
294         DIOCGSECTORSIZE,
295 #endif
296     };
297 
298     /* Try a few ioctls to get the right size */
299     for (i = 0; i < (int)ARRAY_SIZE(ioctl_list); i++) {
300         if (ioctl(fd, ioctl_list[i], &sector_size) >= 0) {
301             *sector_size_p = sector_size;
302             success = true;
303         }
304     }
305 
306     return success ? 0 : -errno;
307 }
308 
309 /**
310  * Get physical block size of @fd.
311  * On success, store it in @blk_size and return 0.
312  * On failure, return -errno.
313  */
314 static int probe_physical_blocksize(int fd, unsigned int *blk_size)
315 {
316 #ifdef BLKPBSZGET
317     if (ioctl(fd, BLKPBSZGET, blk_size) < 0) {
318         return -errno;
319     }
320     return 0;
321 #else
322     return -ENOTSUP;
323 #endif
324 }
325 
326 /*
327  * Returns true if no alignment restrictions are necessary even for files
328  * opened with O_DIRECT.
329  *
330  * raw_probe_alignment() probes the required alignment and assume that 1 means
331  * the probing failed, so it falls back to a safe default of 4k. This can be
332  * avoided if we know that byte alignment is okay for the file.
333  */
334 static bool dio_byte_aligned(int fd)
335 {
336 #ifdef __linux__
337     struct statfs buf;
338     int ret;
339 
340     ret = fstatfs(fd, &buf);
341     if (ret == 0 && buf.f_type == NFS_SUPER_MAGIC) {
342         return true;
343     }
344 #endif
345     return false;
346 }
347 
348 static bool raw_needs_alignment(BlockDriverState *bs)
349 {
350     BDRVRawState *s = bs->opaque;
351 
352     if ((bs->open_flags & BDRV_O_NOCACHE) != 0 && !dio_byte_aligned(s->fd)) {
353         return true;
354     }
355 
356     return s->force_alignment;
357 }
358 
359 /* Check if read is allowed with given memory buffer and length.
360  *
361  * This function is used to check O_DIRECT memory buffer and request alignment.
362  */
363 static bool raw_is_io_aligned(int fd, void *buf, size_t len)
364 {
365     ssize_t ret = pread(fd, buf, len, 0);
366 
367     if (ret >= 0) {
368         return true;
369     }
370 
371 #ifdef __linux__
372     /* The Linux kernel returns EINVAL for misaligned O_DIRECT reads.  Ignore
373      * other errors (e.g. real I/O error), which could happen on a failed
374      * drive, since we only care about probing alignment.
375      */
376     if (errno != EINVAL) {
377         return true;
378     }
379 #endif
380 
381     return false;
382 }
383 
384 static void raw_probe_alignment(BlockDriverState *bs, int fd, Error **errp)
385 {
386     BDRVRawState *s = bs->opaque;
387     char *buf;
388     size_t max_align = MAX(MAX_BLOCKSIZE, qemu_real_host_page_size);
389     size_t alignments[] = {1, 512, 1024, 2048, 4096};
390 
391     /* For SCSI generic devices the alignment is not really used.
392        With buffered I/O, we don't have any restrictions. */
393     if (bdrv_is_sg(bs) || !s->needs_alignment) {
394         bs->bl.request_alignment = 1;
395         s->buf_align = 1;
396         return;
397     }
398 
399     bs->bl.request_alignment = 0;
400     s->buf_align = 0;
401     /* Let's try to use the logical blocksize for the alignment. */
402     if (probe_logical_blocksize(fd, &bs->bl.request_alignment) < 0) {
403         bs->bl.request_alignment = 0;
404     }
405 
406 #ifdef __linux__
407     /*
408      * The XFS ioctl definitions are shipped in extra packages that might
409      * not always be available. Since we just need the XFS_IOC_DIOINFO ioctl
410      * here, we simply use our own definition instead:
411      */
412     struct xfs_dioattr {
413         uint32_t d_mem;
414         uint32_t d_miniosz;
415         uint32_t d_maxiosz;
416     } da;
417     if (ioctl(fd, _IOR('X', 30, struct xfs_dioattr), &da) >= 0) {
418         bs->bl.request_alignment = da.d_miniosz;
419         /* The kernel returns wrong information for d_mem */
420         /* s->buf_align = da.d_mem; */
421     }
422 #endif
423 
424     /*
425      * If we could not get the sizes so far, we can only guess them. First try
426      * to detect request alignment, since it is more likely to succeed. Then
427      * try to detect buf_align, which cannot be detected in some cases (e.g.
428      * Gluster). If buf_align cannot be detected, we fallback to the value of
429      * request_alignment.
430      */
431 
432     if (!bs->bl.request_alignment) {
433         int i;
434         size_t align;
435         buf = qemu_memalign(max_align, max_align);
436         for (i = 0; i < ARRAY_SIZE(alignments); i++) {
437             align = alignments[i];
438             if (raw_is_io_aligned(fd, buf, align)) {
439                 /* Fallback to safe value. */
440                 bs->bl.request_alignment = (align != 1) ? align : max_align;
441                 break;
442             }
443         }
444         qemu_vfree(buf);
445     }
446 
447     if (!s->buf_align) {
448         int i;
449         size_t align;
450         buf = qemu_memalign(max_align, 2 * max_align);
451         for (i = 0; i < ARRAY_SIZE(alignments); i++) {
452             align = alignments[i];
453             if (raw_is_io_aligned(fd, buf + align, max_align)) {
454                 /* Fallback to request_alignment. */
455                 s->buf_align = (align != 1) ? align : bs->bl.request_alignment;
456                 break;
457             }
458         }
459         qemu_vfree(buf);
460     }
461 
462     if (!s->buf_align || !bs->bl.request_alignment) {
463         error_setg(errp, "Could not find working O_DIRECT alignment");
464         error_append_hint(errp, "Try cache.direct=off\n");
465     }
466 }
467 
468 static int check_hdev_writable(int fd)
469 {
470 #if defined(BLKROGET)
471     /* Linux block devices can be configured "read-only" using blockdev(8).
472      * This is independent of device node permissions and therefore open(2)
473      * with O_RDWR succeeds.  Actual writes fail with EPERM.
474      *
475      * bdrv_open() is supposed to fail if the disk is read-only.  Explicitly
476      * check for read-only block devices so that Linux block devices behave
477      * properly.
478      */
479     struct stat st;
480     int readonly = 0;
481 
482     if (fstat(fd, &st)) {
483         return -errno;
484     }
485 
486     if (!S_ISBLK(st.st_mode)) {
487         return 0;
488     }
489 
490     if (ioctl(fd, BLKROGET, &readonly) < 0) {
491         return -errno;
492     }
493 
494     if (readonly) {
495         return -EACCES;
496     }
497 #endif /* defined(BLKROGET) */
498     return 0;
499 }
500 
501 static void raw_parse_flags(int bdrv_flags, int *open_flags, bool has_writers)
502 {
503     bool read_write = false;
504     assert(open_flags != NULL);
505 
506     *open_flags |= O_BINARY;
507     *open_flags &= ~O_ACCMODE;
508 
509     if (bdrv_flags & BDRV_O_AUTO_RDONLY) {
510         read_write = has_writers;
511     } else if (bdrv_flags & BDRV_O_RDWR) {
512         read_write = true;
513     }
514 
515     if (read_write) {
516         *open_flags |= O_RDWR;
517     } else {
518         *open_flags |= O_RDONLY;
519     }
520 
521     /* Use O_DSYNC for write-through caching, no flags for write-back caching,
522      * and O_DIRECT for no caching. */
523     if ((bdrv_flags & BDRV_O_NOCACHE)) {
524         *open_flags |= O_DIRECT;
525     }
526 }
527 
528 static void raw_parse_filename(const char *filename, QDict *options,
529                                Error **errp)
530 {
531     bdrv_parse_filename_strip_prefix(filename, "file:", options);
532 }
533 
534 static QemuOptsList raw_runtime_opts = {
535     .name = "raw",
536     .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
537     .desc = {
538         {
539             .name = "filename",
540             .type = QEMU_OPT_STRING,
541             .help = "File name of the image",
542         },
543         {
544             .name = "aio",
545             .type = QEMU_OPT_STRING,
546             .help = "host AIO implementation (threads, native, io_uring)",
547         },
548         {
549             .name = "aio-max-batch",
550             .type = QEMU_OPT_NUMBER,
551             .help = "AIO max batch size (0 = auto handled by AIO backend, default: 0)",
552         },
553         {
554             .name = "locking",
555             .type = QEMU_OPT_STRING,
556             .help = "file locking mode (on/off/auto, default: auto)",
557         },
558         {
559             .name = "pr-manager",
560             .type = QEMU_OPT_STRING,
561             .help = "id of persistent reservation manager object (default: none)",
562         },
563 #if defined(__linux__)
564         {
565             .name = "drop-cache",
566             .type = QEMU_OPT_BOOL,
567             .help = "invalidate page cache during live migration (default: on)",
568         },
569 #endif
570         {
571             .name = "x-check-cache-dropped",
572             .type = QEMU_OPT_BOOL,
573             .help = "check that page cache was dropped on live migration (default: off)"
574         },
575         { /* end of list */ }
576     },
577 };
578 
579 static const char *const mutable_opts[] = { "x-check-cache-dropped", NULL };
580 
581 static int raw_open_common(BlockDriverState *bs, QDict *options,
582                            int bdrv_flags, int open_flags,
583                            bool device, Error **errp)
584 {
585     BDRVRawState *s = bs->opaque;
586     QemuOpts *opts;
587     Error *local_err = NULL;
588     const char *filename = NULL;
589     const char *str;
590     BlockdevAioOptions aio, aio_default;
591     int fd, ret;
592     struct stat st;
593     OnOffAuto locking;
594 
595     opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
596     if (!qemu_opts_absorb_qdict(opts, options, errp)) {
597         ret = -EINVAL;
598         goto fail;
599     }
600 
601     filename = qemu_opt_get(opts, "filename");
602 
603     ret = raw_normalize_devicepath(&filename, errp);
604     if (ret != 0) {
605         goto fail;
606     }
607 
608     if (bdrv_flags & BDRV_O_NATIVE_AIO) {
609         aio_default = BLOCKDEV_AIO_OPTIONS_NATIVE;
610 #ifdef CONFIG_LINUX_IO_URING
611     } else if (bdrv_flags & BDRV_O_IO_URING) {
612         aio_default = BLOCKDEV_AIO_OPTIONS_IO_URING;
613 #endif
614     } else {
615         aio_default = BLOCKDEV_AIO_OPTIONS_THREADS;
616     }
617 
618     aio = qapi_enum_parse(&BlockdevAioOptions_lookup,
619                           qemu_opt_get(opts, "aio"),
620                           aio_default, &local_err);
621     if (local_err) {
622         error_propagate(errp, local_err);
623         ret = -EINVAL;
624         goto fail;
625     }
626 
627     s->use_linux_aio = (aio == BLOCKDEV_AIO_OPTIONS_NATIVE);
628 #ifdef CONFIG_LINUX_IO_URING
629     s->use_linux_io_uring = (aio == BLOCKDEV_AIO_OPTIONS_IO_URING);
630 #endif
631 
632     s->aio_max_batch = qemu_opt_get_number(opts, "aio-max-batch", 0);
633 
634     locking = qapi_enum_parse(&OnOffAuto_lookup,
635                               qemu_opt_get(opts, "locking"),
636                               ON_OFF_AUTO_AUTO, &local_err);
637     if (local_err) {
638         error_propagate(errp, local_err);
639         ret = -EINVAL;
640         goto fail;
641     }
642     switch (locking) {
643     case ON_OFF_AUTO_ON:
644         s->use_lock = true;
645         if (!qemu_has_ofd_lock()) {
646             warn_report("File lock requested but OFD locking syscall is "
647                         "unavailable, falling back to POSIX file locks");
648             error_printf("Due to the implementation, locks can be lost "
649                          "unexpectedly.\n");
650         }
651         break;
652     case ON_OFF_AUTO_OFF:
653         s->use_lock = false;
654         break;
655     case ON_OFF_AUTO_AUTO:
656         s->use_lock = qemu_has_ofd_lock();
657         break;
658     default:
659         abort();
660     }
661 
662     str = qemu_opt_get(opts, "pr-manager");
663     if (str) {
664         s->pr_mgr = pr_manager_lookup(str, &local_err);
665         if (local_err) {
666             error_propagate(errp, local_err);
667             ret = -EINVAL;
668             goto fail;
669         }
670     }
671 
672     s->drop_cache = qemu_opt_get_bool(opts, "drop-cache", true);
673     s->check_cache_dropped = qemu_opt_get_bool(opts, "x-check-cache-dropped",
674                                                false);
675 
676     s->open_flags = open_flags;
677     raw_parse_flags(bdrv_flags, &s->open_flags, false);
678 
679     s->fd = -1;
680     fd = qemu_open(filename, s->open_flags, errp);
681     ret = fd < 0 ? -errno : 0;
682 
683     if (ret < 0) {
684         if (ret == -EROFS) {
685             ret = -EACCES;
686         }
687         goto fail;
688     }
689     s->fd = fd;
690 
691     /* Check s->open_flags rather than bdrv_flags due to auto-read-only */
692     if (s->open_flags & O_RDWR) {
693         ret = check_hdev_writable(s->fd);
694         if (ret < 0) {
695             error_setg_errno(errp, -ret, "The device is not writable");
696             goto fail;
697         }
698     }
699 
700     s->perm = 0;
701     s->shared_perm = BLK_PERM_ALL;
702 
703 #ifdef CONFIG_LINUX_AIO
704      /* Currently Linux does AIO only for files opened with O_DIRECT */
705     if (s->use_linux_aio) {
706         if (!(s->open_flags & O_DIRECT)) {
707             error_setg(errp, "aio=native was specified, but it requires "
708                              "cache.direct=on, which was not specified.");
709             ret = -EINVAL;
710             goto fail;
711         }
712         if (!aio_setup_linux_aio(bdrv_get_aio_context(bs), errp)) {
713             error_prepend(errp, "Unable to use native AIO: ");
714             goto fail;
715         }
716     }
717 #else
718     if (s->use_linux_aio) {
719         error_setg(errp, "aio=native was specified, but is not supported "
720                          "in this build.");
721         ret = -EINVAL;
722         goto fail;
723     }
724 #endif /* !defined(CONFIG_LINUX_AIO) */
725 
726 #ifdef CONFIG_LINUX_IO_URING
727     if (s->use_linux_io_uring) {
728         if (!aio_setup_linux_io_uring(bdrv_get_aio_context(bs), errp)) {
729             error_prepend(errp, "Unable to use io_uring: ");
730             goto fail;
731         }
732     }
733 #else
734     if (s->use_linux_io_uring) {
735         error_setg(errp, "aio=io_uring was specified, but is not supported "
736                          "in this build.");
737         ret = -EINVAL;
738         goto fail;
739     }
740 #endif /* !defined(CONFIG_LINUX_IO_URING) */
741 
742     s->has_discard = true;
743     s->has_write_zeroes = true;
744 
745     if (fstat(s->fd, &st) < 0) {
746         ret = -errno;
747         error_setg_errno(errp, errno, "Could not stat file");
748         goto fail;
749     }
750 
751     if (!device) {
752         if (!S_ISREG(st.st_mode)) {
753             error_setg(errp, "'%s' driver requires '%s' to be a regular file",
754                        bs->drv->format_name, bs->filename);
755             ret = -EINVAL;
756             goto fail;
757         } else {
758             s->discard_zeroes = true;
759             s->has_fallocate = true;
760         }
761     } else {
762         if (!(S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
763             error_setg(errp, "'%s' driver requires '%s' to be either "
764                        "a character or block device",
765                        bs->drv->format_name, bs->filename);
766             ret = -EINVAL;
767             goto fail;
768         }
769     }
770 
771     if (S_ISBLK(st.st_mode)) {
772 #ifdef BLKDISCARDZEROES
773         unsigned int arg;
774         if (ioctl(s->fd, BLKDISCARDZEROES, &arg) == 0 && arg) {
775             s->discard_zeroes = true;
776         }
777 #endif
778 #ifdef __linux__
779         /* On Linux 3.10, BLKDISCARD leaves stale data in the page cache.  Do
780          * not rely on the contents of discarded blocks unless using O_DIRECT.
781          * Same for BLKZEROOUT.
782          */
783         if (!(bs->open_flags & BDRV_O_NOCACHE)) {
784             s->discard_zeroes = false;
785             s->has_write_zeroes = false;
786         }
787 #endif
788     }
789 #ifdef __FreeBSD__
790     if (S_ISCHR(st.st_mode)) {
791         /*
792          * The file is a char device (disk), which on FreeBSD isn't behind
793          * a pager, so force all requests to be aligned. This is needed
794          * so QEMU makes sure all IO operations on the device are aligned
795          * to sector size, or else FreeBSD will reject them with EINVAL.
796          */
797         s->force_alignment = true;
798     }
799 #endif
800     s->needs_alignment = raw_needs_alignment(bs);
801 
802     bs->supported_zero_flags = BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK;
803     if (S_ISREG(st.st_mode)) {
804         /* When extending regular files, we get zeros from the OS */
805         bs->supported_truncate_flags = BDRV_REQ_ZERO_WRITE;
806     }
807     ret = 0;
808 fail:
809     if (ret < 0 && s->fd != -1) {
810         qemu_close(s->fd);
811     }
812     if (filename && (bdrv_flags & BDRV_O_TEMPORARY)) {
813         unlink(filename);
814     }
815     qemu_opts_del(opts);
816     return ret;
817 }
818 
819 static int raw_open(BlockDriverState *bs, QDict *options, int flags,
820                     Error **errp)
821 {
822     BDRVRawState *s = bs->opaque;
823 
824     s->type = FTYPE_FILE;
825     return raw_open_common(bs, options, flags, 0, false, errp);
826 }
827 
828 typedef enum {
829     RAW_PL_PREPARE,
830     RAW_PL_COMMIT,
831     RAW_PL_ABORT,
832 } RawPermLockOp;
833 
834 #define PERM_FOREACH(i) \
835     for ((i) = 0; (1ULL << (i)) <= BLK_PERM_ALL; i++)
836 
837 /* Lock bytes indicated by @perm_lock_bits and @shared_perm_lock_bits in the
838  * file; if @unlock == true, also unlock the unneeded bytes.
839  * @shared_perm_lock_bits is the mask of all permissions that are NOT shared.
840  */
841 static int raw_apply_lock_bytes(BDRVRawState *s, int fd,
842                                 uint64_t perm_lock_bits,
843                                 uint64_t shared_perm_lock_bits,
844                                 bool unlock, Error **errp)
845 {
846     int ret;
847     int i;
848     uint64_t locked_perm, locked_shared_perm;
849 
850     if (s) {
851         locked_perm = s->locked_perm;
852         locked_shared_perm = s->locked_shared_perm;
853     } else {
854         /*
855          * We don't have the previous bits, just lock/unlock for each of the
856          * requested bits.
857          */
858         if (unlock) {
859             locked_perm = BLK_PERM_ALL;
860             locked_shared_perm = BLK_PERM_ALL;
861         } else {
862             locked_perm = 0;
863             locked_shared_perm = 0;
864         }
865     }
866 
867     PERM_FOREACH(i) {
868         int off = RAW_LOCK_PERM_BASE + i;
869         uint64_t bit = (1ULL << i);
870         if ((perm_lock_bits & bit) && !(locked_perm & bit)) {
871             ret = qemu_lock_fd(fd, off, 1, false);
872             if (ret) {
873                 raw_lock_error_setg_errno(errp, -ret, "Failed to lock byte %d",
874                                           off);
875                 return ret;
876             } else if (s) {
877                 s->locked_perm |= bit;
878             }
879         } else if (unlock && (locked_perm & bit) && !(perm_lock_bits & bit)) {
880             ret = qemu_unlock_fd(fd, off, 1);
881             if (ret) {
882                 error_setg_errno(errp, -ret, "Failed to unlock byte %d", off);
883                 return ret;
884             } else if (s) {
885                 s->locked_perm &= ~bit;
886             }
887         }
888     }
889     PERM_FOREACH(i) {
890         int off = RAW_LOCK_SHARED_BASE + i;
891         uint64_t bit = (1ULL << i);
892         if ((shared_perm_lock_bits & bit) && !(locked_shared_perm & bit)) {
893             ret = qemu_lock_fd(fd, off, 1, false);
894             if (ret) {
895                 raw_lock_error_setg_errno(errp, -ret, "Failed to lock byte %d",
896                                           off);
897                 return ret;
898             } else if (s) {
899                 s->locked_shared_perm |= bit;
900             }
901         } else if (unlock && (locked_shared_perm & bit) &&
902                    !(shared_perm_lock_bits & bit)) {
903             ret = qemu_unlock_fd(fd, off, 1);
904             if (ret) {
905                 error_setg_errno(errp, -ret, "Failed to unlock byte %d", off);
906                 return ret;
907             } else if (s) {
908                 s->locked_shared_perm &= ~bit;
909             }
910         }
911     }
912     return 0;
913 }
914 
915 /* Check "unshared" bytes implied by @perm and ~@shared_perm in the file. */
916 static int raw_check_lock_bytes(int fd, uint64_t perm, uint64_t shared_perm,
917                                 Error **errp)
918 {
919     int ret;
920     int i;
921 
922     PERM_FOREACH(i) {
923         int off = RAW_LOCK_SHARED_BASE + i;
924         uint64_t p = 1ULL << i;
925         if (perm & p) {
926             ret = qemu_lock_fd_test(fd, off, 1, true);
927             if (ret) {
928                 char *perm_name = bdrv_perm_names(p);
929 
930                 raw_lock_error_setg_errno(errp, -ret,
931                                           "Failed to get \"%s\" lock",
932                                           perm_name);
933                 g_free(perm_name);
934                 return ret;
935             }
936         }
937     }
938     PERM_FOREACH(i) {
939         int off = RAW_LOCK_PERM_BASE + i;
940         uint64_t p = 1ULL << i;
941         if (!(shared_perm & p)) {
942             ret = qemu_lock_fd_test(fd, off, 1, true);
943             if (ret) {
944                 char *perm_name = bdrv_perm_names(p);
945 
946                 raw_lock_error_setg_errno(errp, -ret,
947                                           "Failed to get shared \"%s\" lock",
948                                           perm_name);
949                 g_free(perm_name);
950                 return ret;
951             }
952         }
953     }
954     return 0;
955 }
956 
957 static int raw_handle_perm_lock(BlockDriverState *bs,
958                                 RawPermLockOp op,
959                                 uint64_t new_perm, uint64_t new_shared,
960                                 Error **errp)
961 {
962     BDRVRawState *s = bs->opaque;
963     int ret = 0;
964     Error *local_err = NULL;
965 
966     if (!s->use_lock) {
967         return 0;
968     }
969 
970     if (bdrv_get_flags(bs) & BDRV_O_INACTIVE) {
971         return 0;
972     }
973 
974     switch (op) {
975     case RAW_PL_PREPARE:
976         if ((s->perm | new_perm) == s->perm &&
977             (s->shared_perm & new_shared) == s->shared_perm)
978         {
979             /*
980              * We are going to unlock bytes, it should not fail. If it fail due
981              * to some fs-dependent permission-unrelated reasons (which occurs
982              * sometimes on NFS and leads to abort in bdrv_replace_child) we
983              * can't prevent such errors by any check here. And we ignore them
984              * anyway in ABORT and COMMIT.
985              */
986             return 0;
987         }
988         ret = raw_apply_lock_bytes(s, s->fd, s->perm | new_perm,
989                                    ~s->shared_perm | ~new_shared,
990                                    false, errp);
991         if (!ret) {
992             ret = raw_check_lock_bytes(s->fd, new_perm, new_shared, errp);
993             if (!ret) {
994                 return 0;
995             }
996             error_append_hint(errp,
997                               "Is another process using the image [%s]?\n",
998                               bs->filename);
999         }
1000         /* fall through to unlock bytes. */
1001     case RAW_PL_ABORT:
1002         raw_apply_lock_bytes(s, s->fd, s->perm, ~s->shared_perm,
1003                              true, &local_err);
1004         if (local_err) {
1005             /* Theoretically the above call only unlocks bytes and it cannot
1006              * fail. Something weird happened, report it.
1007              */
1008             warn_report_err(local_err);
1009         }
1010         break;
1011     case RAW_PL_COMMIT:
1012         raw_apply_lock_bytes(s, s->fd, new_perm, ~new_shared,
1013                              true, &local_err);
1014         if (local_err) {
1015             /* Theoretically the above call only unlocks bytes and it cannot
1016              * fail. Something weird happened, report it.
1017              */
1018             warn_report_err(local_err);
1019         }
1020         break;
1021     }
1022     return ret;
1023 }
1024 
1025 static int raw_reconfigure_getfd(BlockDriverState *bs, int flags,
1026                                  int *open_flags, uint64_t perm, bool force_dup,
1027                                  Error **errp)
1028 {
1029     BDRVRawState *s = bs->opaque;
1030     int fd = -1;
1031     int ret;
1032     bool has_writers = perm &
1033         (BLK_PERM_WRITE | BLK_PERM_WRITE_UNCHANGED | BLK_PERM_RESIZE);
1034     int fcntl_flags = O_APPEND | O_NONBLOCK;
1035 #ifdef O_NOATIME
1036     fcntl_flags |= O_NOATIME;
1037 #endif
1038 
1039     *open_flags = 0;
1040     if (s->type == FTYPE_CD) {
1041         *open_flags |= O_NONBLOCK;
1042     }
1043 
1044     raw_parse_flags(flags, open_flags, has_writers);
1045 
1046 #ifdef O_ASYNC
1047     /* Not all operating systems have O_ASYNC, and those that don't
1048      * will not let us track the state into rs->open_flags (typically
1049      * you achieve the same effect with an ioctl, for example I_SETSIG
1050      * on Solaris). But we do not use O_ASYNC, so that's fine.
1051      */
1052     assert((s->open_flags & O_ASYNC) == 0);
1053 #endif
1054 
1055     if (!force_dup && *open_flags == s->open_flags) {
1056         /* We're lucky, the existing fd is fine */
1057         return s->fd;
1058     }
1059 
1060     if ((*open_flags & ~fcntl_flags) == (s->open_flags & ~fcntl_flags)) {
1061         /* dup the original fd */
1062         fd = qemu_dup(s->fd);
1063         if (fd >= 0) {
1064             ret = fcntl_setfl(fd, *open_flags);
1065             if (ret) {
1066                 qemu_close(fd);
1067                 fd = -1;
1068             }
1069         }
1070     }
1071 
1072     /* If we cannot use fcntl, or fcntl failed, fall back to qemu_open() */
1073     if (fd == -1) {
1074         const char *normalized_filename = bs->filename;
1075         ret = raw_normalize_devicepath(&normalized_filename, errp);
1076         if (ret >= 0) {
1077             fd = qemu_open(normalized_filename, *open_flags, errp);
1078             if (fd == -1) {
1079                 return -1;
1080             }
1081         }
1082     }
1083 
1084     if (fd != -1 && (*open_flags & O_RDWR)) {
1085         ret = check_hdev_writable(fd);
1086         if (ret < 0) {
1087             qemu_close(fd);
1088             error_setg_errno(errp, -ret, "The device is not writable");
1089             return -1;
1090         }
1091     }
1092 
1093     return fd;
1094 }
1095 
1096 static int raw_reopen_prepare(BDRVReopenState *state,
1097                               BlockReopenQueue *queue, Error **errp)
1098 {
1099     BDRVRawState *s;
1100     BDRVRawReopenState *rs;
1101     QemuOpts *opts;
1102     int ret;
1103 
1104     assert(state != NULL);
1105     assert(state->bs != NULL);
1106 
1107     s = state->bs->opaque;
1108 
1109     state->opaque = g_new0(BDRVRawReopenState, 1);
1110     rs = state->opaque;
1111 
1112     /* Handle options changes */
1113     opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
1114     if (!qemu_opts_absorb_qdict(opts, state->options, errp)) {
1115         ret = -EINVAL;
1116         goto out;
1117     }
1118 
1119     rs->drop_cache = qemu_opt_get_bool_del(opts, "drop-cache", true);
1120     rs->check_cache_dropped =
1121         qemu_opt_get_bool_del(opts, "x-check-cache-dropped", false);
1122 
1123     /* This driver's reopen function doesn't currently allow changing
1124      * other options, so let's put them back in the original QDict and
1125      * bdrv_reopen_prepare() will detect changes and complain. */
1126     qemu_opts_to_qdict(opts, state->options);
1127 
1128     /*
1129      * As part of reopen prepare we also want to create new fd by
1130      * raw_reconfigure_getfd(). But it wants updated "perm", when in
1131      * bdrv_reopen_multiple() .bdrv_reopen_prepare() callback called prior to
1132      * permission update. Happily, permission update is always a part (a seprate
1133      * stage) of bdrv_reopen_multiple() so we can rely on this fact and
1134      * reconfigure fd in raw_check_perm().
1135      */
1136 
1137     s->reopen_state = state;
1138     ret = 0;
1139 
1140 out:
1141     qemu_opts_del(opts);
1142     return ret;
1143 }
1144 
1145 static void raw_reopen_commit(BDRVReopenState *state)
1146 {
1147     BDRVRawReopenState *rs = state->opaque;
1148     BDRVRawState *s = state->bs->opaque;
1149 
1150     s->drop_cache = rs->drop_cache;
1151     s->check_cache_dropped = rs->check_cache_dropped;
1152     s->open_flags = rs->open_flags;
1153     g_free(state->opaque);
1154     state->opaque = NULL;
1155 
1156     assert(s->reopen_state == state);
1157     s->reopen_state = NULL;
1158 }
1159 
1160 
1161 static void raw_reopen_abort(BDRVReopenState *state)
1162 {
1163     BDRVRawReopenState *rs = state->opaque;
1164     BDRVRawState *s = state->bs->opaque;
1165 
1166      /* nothing to do if NULL, we didn't get far enough */
1167     if (rs == NULL) {
1168         return;
1169     }
1170 
1171     g_free(state->opaque);
1172     state->opaque = NULL;
1173 
1174     assert(s->reopen_state == state);
1175     s->reopen_state = NULL;
1176 }
1177 
1178 static int hdev_get_max_hw_transfer(int fd, struct stat *st)
1179 {
1180 #ifdef BLKSECTGET
1181     if (S_ISBLK(st->st_mode)) {
1182         unsigned short max_sectors = 0;
1183         if (ioctl(fd, BLKSECTGET, &max_sectors) == 0) {
1184             return max_sectors * 512;
1185         }
1186     } else {
1187         int max_bytes = 0;
1188         if (ioctl(fd, BLKSECTGET, &max_bytes) == 0) {
1189             return max_bytes;
1190         }
1191     }
1192     return -errno;
1193 #else
1194     return -ENOSYS;
1195 #endif
1196 }
1197 
1198 static int hdev_get_max_segments(int fd, struct stat *st)
1199 {
1200 #ifdef CONFIG_LINUX
1201     char buf[32];
1202     const char *end;
1203     char *sysfspath = NULL;
1204     int ret;
1205     int sysfd = -1;
1206     long max_segments;
1207 
1208     if (S_ISCHR(st->st_mode)) {
1209         if (ioctl(fd, SG_GET_SG_TABLESIZE, &ret) == 0) {
1210             return ret;
1211         }
1212         return -ENOTSUP;
1213     }
1214 
1215     if (!S_ISBLK(st->st_mode)) {
1216         return -ENOTSUP;
1217     }
1218 
1219     sysfspath = g_strdup_printf("/sys/dev/block/%u:%u/queue/max_segments",
1220                                 major(st->st_rdev), minor(st->st_rdev));
1221     sysfd = open(sysfspath, O_RDONLY);
1222     if (sysfd == -1) {
1223         ret = -errno;
1224         goto out;
1225     }
1226     do {
1227         ret = read(sysfd, buf, sizeof(buf) - 1);
1228     } while (ret == -1 && errno == EINTR);
1229     if (ret < 0) {
1230         ret = -errno;
1231         goto out;
1232     } else if (ret == 0) {
1233         ret = -EIO;
1234         goto out;
1235     }
1236     buf[ret] = 0;
1237     /* The file is ended with '\n', pass 'end' to accept that. */
1238     ret = qemu_strtol(buf, &end, 10, &max_segments);
1239     if (ret == 0 && end && *end == '\n') {
1240         ret = max_segments;
1241     }
1242 
1243 out:
1244     if (sysfd != -1) {
1245         close(sysfd);
1246     }
1247     g_free(sysfspath);
1248     return ret;
1249 #else
1250     return -ENOTSUP;
1251 #endif
1252 }
1253 
1254 static void raw_refresh_limits(BlockDriverState *bs, Error **errp)
1255 {
1256     BDRVRawState *s = bs->opaque;
1257     struct stat st;
1258 
1259     s->needs_alignment = raw_needs_alignment(bs);
1260     raw_probe_alignment(bs, s->fd, errp);
1261 
1262     bs->bl.min_mem_alignment = s->buf_align;
1263     bs->bl.opt_mem_alignment = MAX(s->buf_align, qemu_real_host_page_size);
1264 
1265     /*
1266      * Maximum transfers are best effort, so it is okay to ignore any
1267      * errors.  That said, based on the man page errors in fstat would be
1268      * very much unexpected; the only possible case seems to be ENOMEM.
1269      */
1270     if (fstat(s->fd, &st)) {
1271         return;
1272     }
1273 
1274 #if defined(__APPLE__) && (__MACH__)
1275     struct statfs buf;
1276 
1277     if (!fstatfs(s->fd, &buf)) {
1278         bs->bl.opt_transfer = buf.f_iosize;
1279         bs->bl.pdiscard_alignment = buf.f_bsize;
1280     }
1281 #endif
1282 
1283     if (bs->sg || S_ISBLK(st.st_mode)) {
1284         int ret = hdev_get_max_hw_transfer(s->fd, &st);
1285 
1286         if (ret > 0 && ret <= BDRV_REQUEST_MAX_BYTES) {
1287             bs->bl.max_hw_transfer = ret;
1288         }
1289 
1290         ret = hdev_get_max_segments(s->fd, &st);
1291         if (ret > 0) {
1292             bs->bl.max_hw_iov = ret;
1293         }
1294     }
1295 }
1296 
1297 static int check_for_dasd(int fd)
1298 {
1299 #ifdef BIODASDINFO2
1300     struct dasd_information2_t info = {0};
1301 
1302     return ioctl(fd, BIODASDINFO2, &info);
1303 #else
1304     return -1;
1305 #endif
1306 }
1307 
1308 /**
1309  * Try to get @bs's logical and physical block size.
1310  * On success, store them in @bsz and return zero.
1311  * On failure, return negative errno.
1312  */
1313 static int hdev_probe_blocksizes(BlockDriverState *bs, BlockSizes *bsz)
1314 {
1315     BDRVRawState *s = bs->opaque;
1316     int ret;
1317 
1318     /* If DASD, get blocksizes */
1319     if (check_for_dasd(s->fd) < 0) {
1320         return -ENOTSUP;
1321     }
1322     ret = probe_logical_blocksize(s->fd, &bsz->log);
1323     if (ret < 0) {
1324         return ret;
1325     }
1326     return probe_physical_blocksize(s->fd, &bsz->phys);
1327 }
1328 
1329 /**
1330  * Try to get @bs's geometry: cyls, heads, sectors.
1331  * On success, store them in @geo and return 0.
1332  * On failure return -errno.
1333  * (Allows block driver to assign default geometry values that guest sees)
1334  */
1335 #ifdef __linux__
1336 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1337 {
1338     BDRVRawState *s = bs->opaque;
1339     struct hd_geometry ioctl_geo = {0};
1340 
1341     /* If DASD, get its geometry */
1342     if (check_for_dasd(s->fd) < 0) {
1343         return -ENOTSUP;
1344     }
1345     if (ioctl(s->fd, HDIO_GETGEO, &ioctl_geo) < 0) {
1346         return -errno;
1347     }
1348     /* HDIO_GETGEO may return success even though geo contains zeros
1349        (e.g. certain multipath setups) */
1350     if (!ioctl_geo.heads || !ioctl_geo.sectors || !ioctl_geo.cylinders) {
1351         return -ENOTSUP;
1352     }
1353     /* Do not return a geometry for partition */
1354     if (ioctl_geo.start != 0) {
1355         return -ENOTSUP;
1356     }
1357     geo->heads = ioctl_geo.heads;
1358     geo->sectors = ioctl_geo.sectors;
1359     geo->cylinders = ioctl_geo.cylinders;
1360 
1361     return 0;
1362 }
1363 #else /* __linux__ */
1364 static int hdev_probe_geometry(BlockDriverState *bs, HDGeometry *geo)
1365 {
1366     return -ENOTSUP;
1367 }
1368 #endif
1369 
1370 #if defined(__linux__)
1371 static int handle_aiocb_ioctl(void *opaque)
1372 {
1373     RawPosixAIOData *aiocb = opaque;
1374     int ret;
1375 
1376     do {
1377         ret = ioctl(aiocb->aio_fildes, aiocb->ioctl.cmd, aiocb->ioctl.buf);
1378     } while (ret == -1 && errno == EINTR);
1379     if (ret == -1) {
1380         return -errno;
1381     }
1382 
1383     return 0;
1384 }
1385 #endif /* linux */
1386 
1387 static int handle_aiocb_flush(void *opaque)
1388 {
1389     RawPosixAIOData *aiocb = opaque;
1390     BDRVRawState *s = aiocb->bs->opaque;
1391     int ret;
1392 
1393     if (s->page_cache_inconsistent) {
1394         return -s->page_cache_inconsistent;
1395     }
1396 
1397     ret = qemu_fdatasync(aiocb->aio_fildes);
1398     if (ret == -1) {
1399         trace_file_flush_fdatasync_failed(errno);
1400 
1401         /* There is no clear definition of the semantics of a failing fsync(),
1402          * so we may have to assume the worst. The sad truth is that this
1403          * assumption is correct for Linux. Some pages are now probably marked
1404          * clean in the page cache even though they are inconsistent with the
1405          * on-disk contents. The next fdatasync() call would succeed, but no
1406          * further writeback attempt will be made. We can't get back to a state
1407          * in which we know what is on disk (we would have to rewrite
1408          * everything that was touched since the last fdatasync() at least), so
1409          * make bdrv_flush() fail permanently. Given that the behaviour isn't
1410          * really defined, I have little hope that other OSes are doing better.
1411          *
1412          * Obviously, this doesn't affect O_DIRECT, which bypasses the page
1413          * cache. */
1414         if ((s->open_flags & O_DIRECT) == 0) {
1415             s->page_cache_inconsistent = errno;
1416         }
1417         return -errno;
1418     }
1419     return 0;
1420 }
1421 
1422 #ifdef CONFIG_PREADV
1423 
1424 static bool preadv_present = true;
1425 
1426 static ssize_t
1427 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1428 {
1429     return preadv(fd, iov, nr_iov, offset);
1430 }
1431 
1432 static ssize_t
1433 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1434 {
1435     return pwritev(fd, iov, nr_iov, offset);
1436 }
1437 
1438 #else
1439 
1440 static bool preadv_present = false;
1441 
1442 static ssize_t
1443 qemu_preadv(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1444 {
1445     return -ENOSYS;
1446 }
1447 
1448 static ssize_t
1449 qemu_pwritev(int fd, const struct iovec *iov, int nr_iov, off_t offset)
1450 {
1451     return -ENOSYS;
1452 }
1453 
1454 #endif
1455 
1456 static ssize_t handle_aiocb_rw_vector(RawPosixAIOData *aiocb)
1457 {
1458     ssize_t len;
1459 
1460     do {
1461         if (aiocb->aio_type & QEMU_AIO_WRITE)
1462             len = qemu_pwritev(aiocb->aio_fildes,
1463                                aiocb->io.iov,
1464                                aiocb->io.niov,
1465                                aiocb->aio_offset);
1466          else
1467             len = qemu_preadv(aiocb->aio_fildes,
1468                               aiocb->io.iov,
1469                               aiocb->io.niov,
1470                               aiocb->aio_offset);
1471     } while (len == -1 && errno == EINTR);
1472 
1473     if (len == -1) {
1474         return -errno;
1475     }
1476     return len;
1477 }
1478 
1479 /*
1480  * Read/writes the data to/from a given linear buffer.
1481  *
1482  * Returns the number of bytes handles or -errno in case of an error. Short
1483  * reads are only returned if the end of the file is reached.
1484  */
1485 static ssize_t handle_aiocb_rw_linear(RawPosixAIOData *aiocb, char *buf)
1486 {
1487     ssize_t offset = 0;
1488     ssize_t len;
1489 
1490     while (offset < aiocb->aio_nbytes) {
1491         if (aiocb->aio_type & QEMU_AIO_WRITE) {
1492             len = pwrite(aiocb->aio_fildes,
1493                          (const char *)buf + offset,
1494                          aiocb->aio_nbytes - offset,
1495                          aiocb->aio_offset + offset);
1496         } else {
1497             len = pread(aiocb->aio_fildes,
1498                         buf + offset,
1499                         aiocb->aio_nbytes - offset,
1500                         aiocb->aio_offset + offset);
1501         }
1502         if (len == -1 && errno == EINTR) {
1503             continue;
1504         } else if (len == -1 && errno == EINVAL &&
1505                    (aiocb->bs->open_flags & BDRV_O_NOCACHE) &&
1506                    !(aiocb->aio_type & QEMU_AIO_WRITE) &&
1507                    offset > 0) {
1508             /* O_DIRECT pread() may fail with EINVAL when offset is unaligned
1509              * after a short read.  Assume that O_DIRECT short reads only occur
1510              * at EOF.  Therefore this is a short read, not an I/O error.
1511              */
1512             break;
1513         } else if (len == -1) {
1514             offset = -errno;
1515             break;
1516         } else if (len == 0) {
1517             break;
1518         }
1519         offset += len;
1520     }
1521 
1522     return offset;
1523 }
1524 
1525 static int handle_aiocb_rw(void *opaque)
1526 {
1527     RawPosixAIOData *aiocb = opaque;
1528     ssize_t nbytes;
1529     char *buf;
1530 
1531     if (!(aiocb->aio_type & QEMU_AIO_MISALIGNED)) {
1532         /*
1533          * If there is just a single buffer, and it is properly aligned
1534          * we can just use plain pread/pwrite without any problems.
1535          */
1536         if (aiocb->io.niov == 1) {
1537             nbytes = handle_aiocb_rw_linear(aiocb, aiocb->io.iov->iov_base);
1538             goto out;
1539         }
1540         /*
1541          * We have more than one iovec, and all are properly aligned.
1542          *
1543          * Try preadv/pwritev first and fall back to linearizing the
1544          * buffer if it's not supported.
1545          */
1546         if (preadv_present) {
1547             nbytes = handle_aiocb_rw_vector(aiocb);
1548             if (nbytes == aiocb->aio_nbytes ||
1549                 (nbytes < 0 && nbytes != -ENOSYS)) {
1550                 goto out;
1551             }
1552             preadv_present = false;
1553         }
1554 
1555         /*
1556          * XXX(hch): short read/write.  no easy way to handle the reminder
1557          * using these interfaces.  For now retry using plain
1558          * pread/pwrite?
1559          */
1560     }
1561 
1562     /*
1563      * Ok, we have to do it the hard way, copy all segments into
1564      * a single aligned buffer.
1565      */
1566     buf = qemu_try_blockalign(aiocb->bs, aiocb->aio_nbytes);
1567     if (buf == NULL) {
1568         nbytes = -ENOMEM;
1569         goto out;
1570     }
1571 
1572     if (aiocb->aio_type & QEMU_AIO_WRITE) {
1573         char *p = buf;
1574         int i;
1575 
1576         for (i = 0; i < aiocb->io.niov; ++i) {
1577             memcpy(p, aiocb->io.iov[i].iov_base, aiocb->io.iov[i].iov_len);
1578             p += aiocb->io.iov[i].iov_len;
1579         }
1580         assert(p - buf == aiocb->aio_nbytes);
1581     }
1582 
1583     nbytes = handle_aiocb_rw_linear(aiocb, buf);
1584     if (!(aiocb->aio_type & QEMU_AIO_WRITE)) {
1585         char *p = buf;
1586         size_t count = aiocb->aio_nbytes, copy;
1587         int i;
1588 
1589         for (i = 0; i < aiocb->io.niov && count; ++i) {
1590             copy = count;
1591             if (copy > aiocb->io.iov[i].iov_len) {
1592                 copy = aiocb->io.iov[i].iov_len;
1593             }
1594             memcpy(aiocb->io.iov[i].iov_base, p, copy);
1595             assert(count >= copy);
1596             p     += copy;
1597             count -= copy;
1598         }
1599         assert(count == 0);
1600     }
1601     qemu_vfree(buf);
1602 
1603 out:
1604     if (nbytes == aiocb->aio_nbytes) {
1605         return 0;
1606     } else if (nbytes >= 0 && nbytes < aiocb->aio_nbytes) {
1607         if (aiocb->aio_type & QEMU_AIO_WRITE) {
1608             return -EINVAL;
1609         } else {
1610             iov_memset(aiocb->io.iov, aiocb->io.niov, nbytes,
1611                       0, aiocb->aio_nbytes - nbytes);
1612             return 0;
1613         }
1614     } else {
1615         assert(nbytes < 0);
1616         return nbytes;
1617     }
1618 }
1619 
1620 #if defined(CONFIG_FALLOCATE) || defined(BLKZEROOUT) || defined(BLKDISCARD)
1621 static int translate_err(int err)
1622 {
1623     if (err == -ENODEV || err == -ENOSYS || err == -EOPNOTSUPP ||
1624         err == -ENOTTY) {
1625         err = -ENOTSUP;
1626     }
1627     return err;
1628 }
1629 #endif
1630 
1631 #ifdef CONFIG_FALLOCATE
1632 static int do_fallocate(int fd, int mode, off_t offset, off_t len)
1633 {
1634     do {
1635         if (fallocate(fd, mode, offset, len) == 0) {
1636             return 0;
1637         }
1638     } while (errno == EINTR);
1639     return translate_err(-errno);
1640 }
1641 #endif
1642 
1643 static ssize_t handle_aiocb_write_zeroes_block(RawPosixAIOData *aiocb)
1644 {
1645     int ret = -ENOTSUP;
1646     BDRVRawState *s = aiocb->bs->opaque;
1647 
1648     if (!s->has_write_zeroes) {
1649         return -ENOTSUP;
1650     }
1651 
1652 #ifdef BLKZEROOUT
1653     /* The BLKZEROOUT implementation in the kernel doesn't set
1654      * BLKDEV_ZERO_NOFALLBACK, so we can't call this if we have to avoid slow
1655      * fallbacks. */
1656     if (!(aiocb->aio_type & QEMU_AIO_NO_FALLBACK)) {
1657         do {
1658             uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1659             if (ioctl(aiocb->aio_fildes, BLKZEROOUT, range) == 0) {
1660                 return 0;
1661             }
1662         } while (errno == EINTR);
1663 
1664         ret = translate_err(-errno);
1665         if (ret == -ENOTSUP) {
1666             s->has_write_zeroes = false;
1667         }
1668     }
1669 #endif
1670 
1671     return ret;
1672 }
1673 
1674 static int handle_aiocb_write_zeroes(void *opaque)
1675 {
1676     RawPosixAIOData *aiocb = opaque;
1677 #ifdef CONFIG_FALLOCATE
1678     BDRVRawState *s = aiocb->bs->opaque;
1679     int64_t len;
1680 #endif
1681 
1682     if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1683         return handle_aiocb_write_zeroes_block(aiocb);
1684     }
1685 
1686 #ifdef CONFIG_FALLOCATE_ZERO_RANGE
1687     if (s->has_write_zeroes) {
1688         int ret = do_fallocate(s->fd, FALLOC_FL_ZERO_RANGE,
1689                                aiocb->aio_offset, aiocb->aio_nbytes);
1690         if (ret == -ENOTSUP) {
1691             s->has_write_zeroes = false;
1692         } else if (ret == 0 || ret != -EINVAL) {
1693             return ret;
1694         }
1695         /*
1696          * Note: Some file systems do not like unaligned byte ranges, and
1697          * return EINVAL in such a case, though they should not do it according
1698          * to the man-page of fallocate(). Thus we simply ignore this return
1699          * value and try the other fallbacks instead.
1700          */
1701     }
1702 #endif
1703 
1704 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1705     if (s->has_discard && s->has_fallocate) {
1706         int ret = do_fallocate(s->fd,
1707                                FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1708                                aiocb->aio_offset, aiocb->aio_nbytes);
1709         if (ret == 0) {
1710             ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1711             if (ret == 0 || ret != -ENOTSUP) {
1712                 return ret;
1713             }
1714             s->has_fallocate = false;
1715         } else if (ret == -EINVAL) {
1716             /*
1717              * Some file systems like older versions of GPFS do not like un-
1718              * aligned byte ranges, and return EINVAL in such a case, though
1719              * they should not do it according to the man-page of fallocate().
1720              * Warn about the bad filesystem and try the final fallback instead.
1721              */
1722             warn_report_once("Your file system is misbehaving: "
1723                              "fallocate(FALLOC_FL_PUNCH_HOLE) returned EINVAL. "
1724                              "Please report this bug to your file system "
1725                              "vendor.");
1726         } else if (ret != -ENOTSUP) {
1727             return ret;
1728         } else {
1729             s->has_discard = false;
1730         }
1731     }
1732 #endif
1733 
1734 #ifdef CONFIG_FALLOCATE
1735     /* Last resort: we are trying to extend the file with zeroed data. This
1736      * can be done via fallocate(fd, 0) */
1737     len = bdrv_getlength(aiocb->bs);
1738     if (s->has_fallocate && len >= 0 && aiocb->aio_offset >= len) {
1739         int ret = do_fallocate(s->fd, 0, aiocb->aio_offset, aiocb->aio_nbytes);
1740         if (ret == 0 || ret != -ENOTSUP) {
1741             return ret;
1742         }
1743         s->has_fallocate = false;
1744     }
1745 #endif
1746 
1747     return -ENOTSUP;
1748 }
1749 
1750 static int handle_aiocb_write_zeroes_unmap(void *opaque)
1751 {
1752     RawPosixAIOData *aiocb = opaque;
1753     BDRVRawState *s G_GNUC_UNUSED = aiocb->bs->opaque;
1754 
1755     /* First try to write zeros and unmap at the same time */
1756 
1757 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1758     int ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1759                            aiocb->aio_offset, aiocb->aio_nbytes);
1760     switch (ret) {
1761     case -ENOTSUP:
1762     case -EINVAL:
1763     case -EBUSY:
1764         break;
1765     default:
1766         return ret;
1767     }
1768 #endif
1769 
1770     /* If we couldn't manage to unmap while guaranteed that the area reads as
1771      * all-zero afterwards, just write zeroes without unmapping */
1772     return handle_aiocb_write_zeroes(aiocb);
1773 }
1774 
1775 #ifndef HAVE_COPY_FILE_RANGE
1776 static off_t copy_file_range(int in_fd, off_t *in_off, int out_fd,
1777                              off_t *out_off, size_t len, unsigned int flags)
1778 {
1779 #ifdef __NR_copy_file_range
1780     return syscall(__NR_copy_file_range, in_fd, in_off, out_fd,
1781                    out_off, len, flags);
1782 #else
1783     errno = ENOSYS;
1784     return -1;
1785 #endif
1786 }
1787 #endif
1788 
1789 static int handle_aiocb_copy_range(void *opaque)
1790 {
1791     RawPosixAIOData *aiocb = opaque;
1792     uint64_t bytes = aiocb->aio_nbytes;
1793     off_t in_off = aiocb->aio_offset;
1794     off_t out_off = aiocb->copy_range.aio_offset2;
1795 
1796     while (bytes) {
1797         ssize_t ret = copy_file_range(aiocb->aio_fildes, &in_off,
1798                                       aiocb->copy_range.aio_fd2, &out_off,
1799                                       bytes, 0);
1800         trace_file_copy_file_range(aiocb->bs, aiocb->aio_fildes, in_off,
1801                                    aiocb->copy_range.aio_fd2, out_off, bytes,
1802                                    0, ret);
1803         if (ret == 0) {
1804             /* No progress (e.g. when beyond EOF), let the caller fall back to
1805              * buffer I/O. */
1806             return -ENOSPC;
1807         }
1808         if (ret < 0) {
1809             switch (errno) {
1810             case ENOSYS:
1811                 return -ENOTSUP;
1812             case EINTR:
1813                 continue;
1814             default:
1815                 return -errno;
1816             }
1817         }
1818         bytes -= ret;
1819     }
1820     return 0;
1821 }
1822 
1823 static int handle_aiocb_discard(void *opaque)
1824 {
1825     RawPosixAIOData *aiocb = opaque;
1826     int ret = -ENOTSUP;
1827     BDRVRawState *s = aiocb->bs->opaque;
1828 
1829     if (!s->has_discard) {
1830         return -ENOTSUP;
1831     }
1832 
1833     if (aiocb->aio_type & QEMU_AIO_BLKDEV) {
1834 #ifdef BLKDISCARD
1835         do {
1836             uint64_t range[2] = { aiocb->aio_offset, aiocb->aio_nbytes };
1837             if (ioctl(aiocb->aio_fildes, BLKDISCARD, range) == 0) {
1838                 return 0;
1839             }
1840         } while (errno == EINTR);
1841 
1842         ret = translate_err(-errno);
1843 #endif
1844     } else {
1845 #ifdef CONFIG_FALLOCATE_PUNCH_HOLE
1846         ret = do_fallocate(s->fd, FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE,
1847                            aiocb->aio_offset, aiocb->aio_nbytes);
1848         ret = translate_err(ret);
1849 #elif defined(__APPLE__) && (__MACH__)
1850         fpunchhole_t fpunchhole;
1851         fpunchhole.fp_flags = 0;
1852         fpunchhole.reserved = 0;
1853         fpunchhole.fp_offset = aiocb->aio_offset;
1854         fpunchhole.fp_length = aiocb->aio_nbytes;
1855         if (fcntl(s->fd, F_PUNCHHOLE, &fpunchhole) == -1) {
1856             ret = errno == ENODEV ? -ENOTSUP : -errno;
1857         } else {
1858             ret = 0;
1859         }
1860 #endif
1861     }
1862 
1863     if (ret == -ENOTSUP) {
1864         s->has_discard = false;
1865     }
1866     return ret;
1867 }
1868 
1869 /*
1870  * Help alignment probing by allocating the first block.
1871  *
1872  * When reading with direct I/O from unallocated area on Gluster backed by XFS,
1873  * reading succeeds regardless of request length. In this case we fallback to
1874  * safe alignment which is not optimal. Allocating the first block avoids this
1875  * fallback.
1876  *
1877  * fd may be opened with O_DIRECT, but we don't know the buffer alignment or
1878  * request alignment, so we use safe values.
1879  *
1880  * Returns: 0 on success, -errno on failure. Since this is an optimization,
1881  * caller may ignore failures.
1882  */
1883 static int allocate_first_block(int fd, size_t max_size)
1884 {
1885     size_t write_size = (max_size < MAX_BLOCKSIZE)
1886         ? BDRV_SECTOR_SIZE
1887         : MAX_BLOCKSIZE;
1888     size_t max_align = MAX(MAX_BLOCKSIZE, qemu_real_host_page_size);
1889     void *buf;
1890     ssize_t n;
1891     int ret;
1892 
1893     buf = qemu_memalign(max_align, write_size);
1894     memset(buf, 0, write_size);
1895 
1896     do {
1897         n = pwrite(fd, buf, write_size, 0);
1898     } while (n == -1 && errno == EINTR);
1899 
1900     ret = (n == -1) ? -errno : 0;
1901 
1902     qemu_vfree(buf);
1903     return ret;
1904 }
1905 
1906 static int handle_aiocb_truncate(void *opaque)
1907 {
1908     RawPosixAIOData *aiocb = opaque;
1909     int result = 0;
1910     int64_t current_length = 0;
1911     char *buf = NULL;
1912     struct stat st;
1913     int fd = aiocb->aio_fildes;
1914     int64_t offset = aiocb->aio_offset;
1915     PreallocMode prealloc = aiocb->truncate.prealloc;
1916     Error **errp = aiocb->truncate.errp;
1917 
1918     if (fstat(fd, &st) < 0) {
1919         result = -errno;
1920         error_setg_errno(errp, -result, "Could not stat file");
1921         return result;
1922     }
1923 
1924     current_length = st.st_size;
1925     if (current_length > offset && prealloc != PREALLOC_MODE_OFF) {
1926         error_setg(errp, "Cannot use preallocation for shrinking files");
1927         return -ENOTSUP;
1928     }
1929 
1930     switch (prealloc) {
1931 #ifdef CONFIG_POSIX_FALLOCATE
1932     case PREALLOC_MODE_FALLOC:
1933         /*
1934          * Truncating before posix_fallocate() makes it about twice slower on
1935          * file systems that do not support fallocate(), trying to check if a
1936          * block is allocated before allocating it, so don't do that here.
1937          */
1938         if (offset != current_length) {
1939             result = -posix_fallocate(fd, current_length,
1940                                       offset - current_length);
1941             if (result != 0) {
1942                 /* posix_fallocate() doesn't set errno. */
1943                 error_setg_errno(errp, -result,
1944                                  "Could not preallocate new data");
1945             } else if (current_length == 0) {
1946                 /*
1947                  * posix_fallocate() uses fallocate() if the filesystem
1948                  * supports it, or fallback to manually writing zeroes. If
1949                  * fallocate() was used, unaligned reads from the fallocated
1950                  * area in raw_probe_alignment() will succeed, hence we need to
1951                  * allocate the first block.
1952                  *
1953                  * Optimize future alignment probing; ignore failures.
1954                  */
1955                 allocate_first_block(fd, offset);
1956             }
1957         } else {
1958             result = 0;
1959         }
1960         goto out;
1961 #endif
1962     case PREALLOC_MODE_FULL:
1963     {
1964         int64_t num = 0, left = offset - current_length;
1965         off_t seek_result;
1966 
1967         /*
1968          * Knowing the final size from the beginning could allow the file
1969          * system driver to do less allocations and possibly avoid
1970          * fragmentation of the file.
1971          */
1972         if (ftruncate(fd, offset) != 0) {
1973             result = -errno;
1974             error_setg_errno(errp, -result, "Could not resize file");
1975             goto out;
1976         }
1977 
1978         buf = g_malloc0(65536);
1979 
1980         seek_result = lseek(fd, current_length, SEEK_SET);
1981         if (seek_result < 0) {
1982             result = -errno;
1983             error_setg_errno(errp, -result,
1984                              "Failed to seek to the old end of file");
1985             goto out;
1986         }
1987 
1988         while (left > 0) {
1989             num = MIN(left, 65536);
1990             result = write(fd, buf, num);
1991             if (result < 0) {
1992                 if (errno == EINTR) {
1993                     continue;
1994                 }
1995                 result = -errno;
1996                 error_setg_errno(errp, -result,
1997                                  "Could not write zeros for preallocation");
1998                 goto out;
1999             }
2000             left -= result;
2001         }
2002         if (result >= 0) {
2003             result = fsync(fd);
2004             if (result < 0) {
2005                 result = -errno;
2006                 error_setg_errno(errp, -result,
2007                                  "Could not flush file to disk");
2008                 goto out;
2009             }
2010         }
2011         goto out;
2012     }
2013     case PREALLOC_MODE_OFF:
2014         if (ftruncate(fd, offset) != 0) {
2015             result = -errno;
2016             error_setg_errno(errp, -result, "Could not resize file");
2017         } else if (current_length == 0 && offset > current_length) {
2018             /* Optimize future alignment probing; ignore failures. */
2019             allocate_first_block(fd, offset);
2020         }
2021         return result;
2022     default:
2023         result = -ENOTSUP;
2024         error_setg(errp, "Unsupported preallocation mode: %s",
2025                    PreallocMode_str(prealloc));
2026         return result;
2027     }
2028 
2029 out:
2030     if (result < 0) {
2031         if (ftruncate(fd, current_length) < 0) {
2032             error_report("Failed to restore old file length: %s",
2033                          strerror(errno));
2034         }
2035     }
2036 
2037     g_free(buf);
2038     return result;
2039 }
2040 
2041 static int coroutine_fn raw_thread_pool_submit(BlockDriverState *bs,
2042                                                ThreadPoolFunc func, void *arg)
2043 {
2044     /* @bs can be NULL, bdrv_get_aio_context() returns the main context then */
2045     ThreadPool *pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
2046     return thread_pool_submit_co(pool, func, arg);
2047 }
2048 
2049 static int coroutine_fn raw_co_prw(BlockDriverState *bs, uint64_t offset,
2050                                    uint64_t bytes, QEMUIOVector *qiov, int type)
2051 {
2052     BDRVRawState *s = bs->opaque;
2053     RawPosixAIOData acb;
2054 
2055     if (fd_open(bs) < 0)
2056         return -EIO;
2057 
2058     /*
2059      * When using O_DIRECT, the request must be aligned to be able to use
2060      * either libaio or io_uring interface. If not fail back to regular thread
2061      * pool read/write code which emulates this for us if we
2062      * set QEMU_AIO_MISALIGNED.
2063      */
2064     if (s->needs_alignment && !bdrv_qiov_is_aligned(bs, qiov)) {
2065         type |= QEMU_AIO_MISALIGNED;
2066 #ifdef CONFIG_LINUX_IO_URING
2067     } else if (s->use_linux_io_uring) {
2068         LuringState *aio = aio_get_linux_io_uring(bdrv_get_aio_context(bs));
2069         assert(qiov->size == bytes);
2070         return luring_co_submit(bs, aio, s->fd, offset, qiov, type);
2071 #endif
2072 #ifdef CONFIG_LINUX_AIO
2073     } else if (s->use_linux_aio) {
2074         LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
2075         assert(qiov->size == bytes);
2076         return laio_co_submit(bs, aio, s->fd, offset, qiov, type,
2077                               s->aio_max_batch);
2078 #endif
2079     }
2080 
2081     acb = (RawPosixAIOData) {
2082         .bs             = bs,
2083         .aio_fildes     = s->fd,
2084         .aio_type       = type,
2085         .aio_offset     = offset,
2086         .aio_nbytes     = bytes,
2087         .io             = {
2088             .iov            = qiov->iov,
2089             .niov           = qiov->niov,
2090         },
2091     };
2092 
2093     assert(qiov->size == bytes);
2094     return raw_thread_pool_submit(bs, handle_aiocb_rw, &acb);
2095 }
2096 
2097 static int coroutine_fn raw_co_preadv(BlockDriverState *bs, int64_t offset,
2098                                       int64_t bytes, QEMUIOVector *qiov,
2099                                       BdrvRequestFlags flags)
2100 {
2101     return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_READ);
2102 }
2103 
2104 static int coroutine_fn raw_co_pwritev(BlockDriverState *bs, int64_t offset,
2105                                        int64_t bytes, QEMUIOVector *qiov,
2106                                        BdrvRequestFlags flags)
2107 {
2108     assert(flags == 0);
2109     return raw_co_prw(bs, offset, bytes, qiov, QEMU_AIO_WRITE);
2110 }
2111 
2112 static void raw_aio_plug(BlockDriverState *bs)
2113 {
2114     BDRVRawState __attribute__((unused)) *s = bs->opaque;
2115 #ifdef CONFIG_LINUX_AIO
2116     if (s->use_linux_aio) {
2117         LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
2118         laio_io_plug(bs, aio);
2119     }
2120 #endif
2121 #ifdef CONFIG_LINUX_IO_URING
2122     if (s->use_linux_io_uring) {
2123         LuringState *aio = aio_get_linux_io_uring(bdrv_get_aio_context(bs));
2124         luring_io_plug(bs, aio);
2125     }
2126 #endif
2127 }
2128 
2129 static void raw_aio_unplug(BlockDriverState *bs)
2130 {
2131     BDRVRawState __attribute__((unused)) *s = bs->opaque;
2132 #ifdef CONFIG_LINUX_AIO
2133     if (s->use_linux_aio) {
2134         LinuxAioState *aio = aio_get_linux_aio(bdrv_get_aio_context(bs));
2135         laio_io_unplug(bs, aio, s->aio_max_batch);
2136     }
2137 #endif
2138 #ifdef CONFIG_LINUX_IO_URING
2139     if (s->use_linux_io_uring) {
2140         LuringState *aio = aio_get_linux_io_uring(bdrv_get_aio_context(bs));
2141         luring_io_unplug(bs, aio);
2142     }
2143 #endif
2144 }
2145 
2146 static int raw_co_flush_to_disk(BlockDriverState *bs)
2147 {
2148     BDRVRawState *s = bs->opaque;
2149     RawPosixAIOData acb;
2150     int ret;
2151 
2152     ret = fd_open(bs);
2153     if (ret < 0) {
2154         return ret;
2155     }
2156 
2157     acb = (RawPosixAIOData) {
2158         .bs             = bs,
2159         .aio_fildes     = s->fd,
2160         .aio_type       = QEMU_AIO_FLUSH,
2161     };
2162 
2163 #ifdef CONFIG_LINUX_IO_URING
2164     if (s->use_linux_io_uring) {
2165         LuringState *aio = aio_get_linux_io_uring(bdrv_get_aio_context(bs));
2166         return luring_co_submit(bs, aio, s->fd, 0, NULL, QEMU_AIO_FLUSH);
2167     }
2168 #endif
2169     return raw_thread_pool_submit(bs, handle_aiocb_flush, &acb);
2170 }
2171 
2172 static void raw_aio_attach_aio_context(BlockDriverState *bs,
2173                                        AioContext *new_context)
2174 {
2175     BDRVRawState __attribute__((unused)) *s = bs->opaque;
2176 #ifdef CONFIG_LINUX_AIO
2177     if (s->use_linux_aio) {
2178         Error *local_err = NULL;
2179         if (!aio_setup_linux_aio(new_context, &local_err)) {
2180             error_reportf_err(local_err, "Unable to use native AIO, "
2181                                          "falling back to thread pool: ");
2182             s->use_linux_aio = false;
2183         }
2184     }
2185 #endif
2186 #ifdef CONFIG_LINUX_IO_URING
2187     if (s->use_linux_io_uring) {
2188         Error *local_err = NULL;
2189         if (!aio_setup_linux_io_uring(new_context, &local_err)) {
2190             error_reportf_err(local_err, "Unable to use linux io_uring, "
2191                                          "falling back to thread pool: ");
2192             s->use_linux_io_uring = false;
2193         }
2194     }
2195 #endif
2196 }
2197 
2198 static void raw_close(BlockDriverState *bs)
2199 {
2200     BDRVRawState *s = bs->opaque;
2201 
2202     if (s->fd >= 0) {
2203         qemu_close(s->fd);
2204         s->fd = -1;
2205     }
2206 }
2207 
2208 /**
2209  * Truncates the given regular file @fd to @offset and, when growing, fills the
2210  * new space according to @prealloc.
2211  *
2212  * Returns: 0 on success, -errno on failure.
2213  */
2214 static int coroutine_fn
2215 raw_regular_truncate(BlockDriverState *bs, int fd, int64_t offset,
2216                      PreallocMode prealloc, Error **errp)
2217 {
2218     RawPosixAIOData acb;
2219 
2220     acb = (RawPosixAIOData) {
2221         .bs             = bs,
2222         .aio_fildes     = fd,
2223         .aio_type       = QEMU_AIO_TRUNCATE,
2224         .aio_offset     = offset,
2225         .truncate       = {
2226             .prealloc       = prealloc,
2227             .errp           = errp,
2228         },
2229     };
2230 
2231     return raw_thread_pool_submit(bs, handle_aiocb_truncate, &acb);
2232 }
2233 
2234 static int coroutine_fn raw_co_truncate(BlockDriverState *bs, int64_t offset,
2235                                         bool exact, PreallocMode prealloc,
2236                                         BdrvRequestFlags flags, Error **errp)
2237 {
2238     BDRVRawState *s = bs->opaque;
2239     struct stat st;
2240     int ret;
2241 
2242     if (fstat(s->fd, &st)) {
2243         ret = -errno;
2244         error_setg_errno(errp, -ret, "Failed to fstat() the file");
2245         return ret;
2246     }
2247 
2248     if (S_ISREG(st.st_mode)) {
2249         /* Always resizes to the exact @offset */
2250         return raw_regular_truncate(bs, s->fd, offset, prealloc, errp);
2251     }
2252 
2253     if (prealloc != PREALLOC_MODE_OFF) {
2254         error_setg(errp, "Preallocation mode '%s' unsupported for this "
2255                    "non-regular file", PreallocMode_str(prealloc));
2256         return -ENOTSUP;
2257     }
2258 
2259     if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2260         int64_t cur_length = raw_getlength(bs);
2261 
2262         if (offset != cur_length && exact) {
2263             error_setg(errp, "Cannot resize device files");
2264             return -ENOTSUP;
2265         } else if (offset > cur_length) {
2266             error_setg(errp, "Cannot grow device files");
2267             return -EINVAL;
2268         }
2269     } else {
2270         error_setg(errp, "Resizing this file is not supported");
2271         return -ENOTSUP;
2272     }
2273 
2274     return 0;
2275 }
2276 
2277 #ifdef __OpenBSD__
2278 static int64_t raw_getlength(BlockDriverState *bs)
2279 {
2280     BDRVRawState *s = bs->opaque;
2281     int fd = s->fd;
2282     struct stat st;
2283 
2284     if (fstat(fd, &st))
2285         return -errno;
2286     if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2287         struct disklabel dl;
2288 
2289         if (ioctl(fd, DIOCGDINFO, &dl))
2290             return -errno;
2291         return (uint64_t)dl.d_secsize *
2292             dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2293     } else
2294         return st.st_size;
2295 }
2296 #elif defined(__NetBSD__)
2297 static int64_t raw_getlength(BlockDriverState *bs)
2298 {
2299     BDRVRawState *s = bs->opaque;
2300     int fd = s->fd;
2301     struct stat st;
2302 
2303     if (fstat(fd, &st))
2304         return -errno;
2305     if (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode)) {
2306         struct dkwedge_info dkw;
2307 
2308         if (ioctl(fd, DIOCGWEDGEINFO, &dkw) != -1) {
2309             return dkw.dkw_size * 512;
2310         } else {
2311             struct disklabel dl;
2312 
2313             if (ioctl(fd, DIOCGDINFO, &dl))
2314                 return -errno;
2315             return (uint64_t)dl.d_secsize *
2316                 dl.d_partitions[DISKPART(st.st_rdev)].p_size;
2317         }
2318     } else
2319         return st.st_size;
2320 }
2321 #elif defined(__sun__)
2322 static int64_t raw_getlength(BlockDriverState *bs)
2323 {
2324     BDRVRawState *s = bs->opaque;
2325     struct dk_minfo minfo;
2326     int ret;
2327     int64_t size;
2328 
2329     ret = fd_open(bs);
2330     if (ret < 0) {
2331         return ret;
2332     }
2333 
2334     /*
2335      * Use the DKIOCGMEDIAINFO ioctl to read the size.
2336      */
2337     ret = ioctl(s->fd, DKIOCGMEDIAINFO, &minfo);
2338     if (ret != -1) {
2339         return minfo.dki_lbsize * minfo.dki_capacity;
2340     }
2341 
2342     /*
2343      * There are reports that lseek on some devices fails, but
2344      * irc discussion said that contingency on contingency was overkill.
2345      */
2346     size = lseek(s->fd, 0, SEEK_END);
2347     if (size < 0) {
2348         return -errno;
2349     }
2350     return size;
2351 }
2352 #elif defined(CONFIG_BSD)
2353 static int64_t raw_getlength(BlockDriverState *bs)
2354 {
2355     BDRVRawState *s = bs->opaque;
2356     int fd = s->fd;
2357     int64_t size;
2358     struct stat sb;
2359 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2360     int reopened = 0;
2361 #endif
2362     int ret;
2363 
2364     ret = fd_open(bs);
2365     if (ret < 0)
2366         return ret;
2367 
2368 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
2369 again:
2370 #endif
2371     if (!fstat(fd, &sb) && (S_IFCHR & sb.st_mode)) {
2372         size = 0;
2373 #ifdef DIOCGMEDIASIZE
2374         if (ioctl(fd, DIOCGMEDIASIZE, (off_t *)&size)) {
2375             size = 0;
2376         }
2377 #endif
2378 #ifdef DIOCGPART
2379         if (size == 0) {
2380             struct partinfo pi;
2381             if (ioctl(fd, DIOCGPART, &pi) == 0) {
2382                 size = pi.media_size;
2383             }
2384         }
2385 #endif
2386 #if defined(DKIOCGETBLOCKCOUNT) && defined(DKIOCGETBLOCKSIZE)
2387         if (size == 0) {
2388             uint64_t sectors = 0;
2389             uint32_t sector_size = 0;
2390 
2391             if (ioctl(fd, DKIOCGETBLOCKCOUNT, &sectors) == 0
2392                && ioctl(fd, DKIOCGETBLOCKSIZE, &sector_size) == 0) {
2393                 size = sectors * sector_size;
2394             }
2395         }
2396 #endif
2397         if (size == 0) {
2398             size = lseek(fd, 0LL, SEEK_END);
2399         }
2400         if (size < 0) {
2401             return -errno;
2402         }
2403 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
2404         switch(s->type) {
2405         case FTYPE_CD:
2406             /* XXX FreeBSD acd returns UINT_MAX sectors for an empty drive */
2407             if (size == 2048LL * (unsigned)-1)
2408                 size = 0;
2409             /* XXX no disc?  maybe we need to reopen... */
2410             if (size <= 0 && !reopened && cdrom_reopen(bs) >= 0) {
2411                 reopened = 1;
2412                 goto again;
2413             }
2414         }
2415 #endif
2416     } else {
2417         size = lseek(fd, 0, SEEK_END);
2418         if (size < 0) {
2419             return -errno;
2420         }
2421     }
2422     return size;
2423 }
2424 #else
2425 static int64_t raw_getlength(BlockDriverState *bs)
2426 {
2427     BDRVRawState *s = bs->opaque;
2428     int ret;
2429     int64_t size;
2430 
2431     ret = fd_open(bs);
2432     if (ret < 0) {
2433         return ret;
2434     }
2435 
2436     size = lseek(s->fd, 0, SEEK_END);
2437     if (size < 0) {
2438         return -errno;
2439     }
2440     return size;
2441 }
2442 #endif
2443 
2444 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
2445 {
2446     struct stat st;
2447     BDRVRawState *s = bs->opaque;
2448 
2449     if (fstat(s->fd, &st) < 0) {
2450         return -errno;
2451     }
2452     return (int64_t)st.st_blocks * 512;
2453 }
2454 
2455 static int coroutine_fn
2456 raw_co_create(BlockdevCreateOptions *options, Error **errp)
2457 {
2458     BlockdevCreateOptionsFile *file_opts;
2459     Error *local_err = NULL;
2460     int fd;
2461     uint64_t perm, shared;
2462     int result = 0;
2463 
2464     /* Validate options and set default values */
2465     assert(options->driver == BLOCKDEV_DRIVER_FILE);
2466     file_opts = &options->u.file;
2467 
2468     if (!file_opts->has_nocow) {
2469         file_opts->nocow = false;
2470     }
2471     if (!file_opts->has_preallocation) {
2472         file_opts->preallocation = PREALLOC_MODE_OFF;
2473     }
2474     if (!file_opts->has_extent_size_hint) {
2475         file_opts->extent_size_hint = 1 * MiB;
2476     }
2477     if (file_opts->extent_size_hint > UINT32_MAX) {
2478         result = -EINVAL;
2479         error_setg(errp, "Extent size hint is too large");
2480         goto out;
2481     }
2482 
2483     /* Create file */
2484     fd = qemu_create(file_opts->filename, O_RDWR | O_BINARY, 0644, errp);
2485     if (fd < 0) {
2486         result = -errno;
2487         goto out;
2488     }
2489 
2490     /* Take permissions: We want to discard everything, so we need
2491      * BLK_PERM_WRITE; and truncation to the desired size requires
2492      * BLK_PERM_RESIZE.
2493      * On the other hand, we cannot share the RESIZE permission
2494      * because we promise that after this function, the file has the
2495      * size given in the options.  If someone else were to resize it
2496      * concurrently, we could not guarantee that.
2497      * Note that after this function, we can no longer guarantee that
2498      * the file is not touched by a third party, so it may be resized
2499      * then. */
2500     perm = BLK_PERM_WRITE | BLK_PERM_RESIZE;
2501     shared = BLK_PERM_ALL & ~BLK_PERM_RESIZE;
2502 
2503     /* Step one: Take locks */
2504     result = raw_apply_lock_bytes(NULL, fd, perm, ~shared, false, errp);
2505     if (result < 0) {
2506         goto out_close;
2507     }
2508 
2509     /* Step two: Check that nobody else has taken conflicting locks */
2510     result = raw_check_lock_bytes(fd, perm, shared, errp);
2511     if (result < 0) {
2512         error_append_hint(errp,
2513                           "Is another process using the image [%s]?\n",
2514                           file_opts->filename);
2515         goto out_unlock;
2516     }
2517 
2518     /* Clear the file by truncating it to 0 */
2519     result = raw_regular_truncate(NULL, fd, 0, PREALLOC_MODE_OFF, errp);
2520     if (result < 0) {
2521         goto out_unlock;
2522     }
2523 
2524     if (file_opts->nocow) {
2525 #ifdef __linux__
2526         /* Set NOCOW flag to solve performance issue on fs like btrfs.
2527          * This is an optimisation. The FS_IOC_SETFLAGS ioctl return value
2528          * will be ignored since any failure of this operation should not
2529          * block the left work.
2530          */
2531         int attr;
2532         if (ioctl(fd, FS_IOC_GETFLAGS, &attr) == 0) {
2533             attr |= FS_NOCOW_FL;
2534             ioctl(fd, FS_IOC_SETFLAGS, &attr);
2535         }
2536 #endif
2537     }
2538 #ifdef FS_IOC_FSSETXATTR
2539     /*
2540      * Try to set the extent size hint. Failure is not fatal, and a warning is
2541      * only printed if the option was explicitly specified.
2542      */
2543     {
2544         struct fsxattr attr;
2545         result = ioctl(fd, FS_IOC_FSGETXATTR, &attr);
2546         if (result == 0) {
2547             attr.fsx_xflags |= FS_XFLAG_EXTSIZE;
2548             attr.fsx_extsize = file_opts->extent_size_hint;
2549             result = ioctl(fd, FS_IOC_FSSETXATTR, &attr);
2550         }
2551         if (result < 0 && file_opts->has_extent_size_hint &&
2552             file_opts->extent_size_hint)
2553         {
2554             warn_report("Failed to set extent size hint: %s",
2555                         strerror(errno));
2556         }
2557     }
2558 #endif
2559 
2560     /* Resize and potentially preallocate the file to the desired
2561      * final size */
2562     result = raw_regular_truncate(NULL, fd, file_opts->size,
2563                                   file_opts->preallocation, errp);
2564     if (result < 0) {
2565         goto out_unlock;
2566     }
2567 
2568 out_unlock:
2569     raw_apply_lock_bytes(NULL, fd, 0, 0, true, &local_err);
2570     if (local_err) {
2571         /* The above call should not fail, and if it does, that does
2572          * not mean the whole creation operation has failed.  So
2573          * report it the user for their convenience, but do not report
2574          * it to the caller. */
2575         warn_report_err(local_err);
2576     }
2577 
2578 out_close:
2579     if (qemu_close(fd) != 0 && result == 0) {
2580         result = -errno;
2581         error_setg_errno(errp, -result, "Could not close the new file");
2582     }
2583 out:
2584     return result;
2585 }
2586 
2587 static int coroutine_fn raw_co_create_opts(BlockDriver *drv,
2588                                            const char *filename,
2589                                            QemuOpts *opts,
2590                                            Error **errp)
2591 {
2592     BlockdevCreateOptions options;
2593     int64_t total_size = 0;
2594     int64_t extent_size_hint = 0;
2595     bool has_extent_size_hint = false;
2596     bool nocow = false;
2597     PreallocMode prealloc;
2598     char *buf = NULL;
2599     Error *local_err = NULL;
2600 
2601     /* Skip file: protocol prefix */
2602     strstart(filename, "file:", &filename);
2603 
2604     /* Read out options */
2605     total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2606                           BDRV_SECTOR_SIZE);
2607     if (qemu_opt_get(opts, BLOCK_OPT_EXTENT_SIZE_HINT)) {
2608         has_extent_size_hint = true;
2609         extent_size_hint =
2610             qemu_opt_get_size_del(opts, BLOCK_OPT_EXTENT_SIZE_HINT, -1);
2611     }
2612     nocow = qemu_opt_get_bool(opts, BLOCK_OPT_NOCOW, false);
2613     buf = qemu_opt_get_del(opts, BLOCK_OPT_PREALLOC);
2614     prealloc = qapi_enum_parse(&PreallocMode_lookup, buf,
2615                                PREALLOC_MODE_OFF, &local_err);
2616     g_free(buf);
2617     if (local_err) {
2618         error_propagate(errp, local_err);
2619         return -EINVAL;
2620     }
2621 
2622     options = (BlockdevCreateOptions) {
2623         .driver     = BLOCKDEV_DRIVER_FILE,
2624         .u.file     = {
2625             .filename           = (char *) filename,
2626             .size               = total_size,
2627             .has_preallocation  = true,
2628             .preallocation      = prealloc,
2629             .has_nocow          = true,
2630             .nocow              = nocow,
2631             .has_extent_size_hint = has_extent_size_hint,
2632             .extent_size_hint   = extent_size_hint,
2633         },
2634     };
2635     return raw_co_create(&options, errp);
2636 }
2637 
2638 static int coroutine_fn raw_co_delete_file(BlockDriverState *bs,
2639                                            Error **errp)
2640 {
2641     struct stat st;
2642     int ret;
2643 
2644     if (!(stat(bs->filename, &st) == 0) || !S_ISREG(st.st_mode)) {
2645         error_setg_errno(errp, ENOENT, "%s is not a regular file",
2646                          bs->filename);
2647         return -ENOENT;
2648     }
2649 
2650     ret = unlink(bs->filename);
2651     if (ret < 0) {
2652         ret = -errno;
2653         error_setg_errno(errp, -ret, "Error when deleting file %s",
2654                          bs->filename);
2655     }
2656 
2657     return ret;
2658 }
2659 
2660 /*
2661  * Find allocation range in @bs around offset @start.
2662  * May change underlying file descriptor's file offset.
2663  * If @start is not in a hole, store @start in @data, and the
2664  * beginning of the next hole in @hole, and return 0.
2665  * If @start is in a non-trailing hole, store @start in @hole and the
2666  * beginning of the next non-hole in @data, and return 0.
2667  * If @start is in a trailing hole or beyond EOF, return -ENXIO.
2668  * If we can't find out, return a negative errno other than -ENXIO.
2669  */
2670 static int find_allocation(BlockDriverState *bs, off_t start,
2671                            off_t *data, off_t *hole)
2672 {
2673 #if defined SEEK_HOLE && defined SEEK_DATA
2674     BDRVRawState *s = bs->opaque;
2675     off_t offs;
2676 
2677     /*
2678      * SEEK_DATA cases:
2679      * D1. offs == start: start is in data
2680      * D2. offs > start: start is in a hole, next data at offs
2681      * D3. offs < 0, errno = ENXIO: either start is in a trailing hole
2682      *                              or start is beyond EOF
2683      *     If the latter happens, the file has been truncated behind
2684      *     our back since we opened it.  All bets are off then.
2685      *     Treating like a trailing hole is simplest.
2686      * D4. offs < 0, errno != ENXIO: we learned nothing
2687      */
2688     offs = lseek(s->fd, start, SEEK_DATA);
2689     if (offs < 0) {
2690         return -errno;          /* D3 or D4 */
2691     }
2692 
2693     if (offs < start) {
2694         /* This is not a valid return by lseek().  We are safe to just return
2695          * -EIO in this case, and we'll treat it like D4. */
2696         return -EIO;
2697     }
2698 
2699     if (offs > start) {
2700         /* D2: in hole, next data at offs */
2701         *hole = start;
2702         *data = offs;
2703         return 0;
2704     }
2705 
2706     /* D1: in data, end not yet known */
2707 
2708     /*
2709      * SEEK_HOLE cases:
2710      * H1. offs == start: start is in a hole
2711      *     If this happens here, a hole has been dug behind our back
2712      *     since the previous lseek().
2713      * H2. offs > start: either start is in data, next hole at offs,
2714      *                   or start is in trailing hole, EOF at offs
2715      *     Linux treats trailing holes like any other hole: offs ==
2716      *     start.  Solaris seeks to EOF instead: offs > start (blech).
2717      *     If that happens here, a hole has been dug behind our back
2718      *     since the previous lseek().
2719      * H3. offs < 0, errno = ENXIO: start is beyond EOF
2720      *     If this happens, the file has been truncated behind our
2721      *     back since we opened it.  Treat it like a trailing hole.
2722      * H4. offs < 0, errno != ENXIO: we learned nothing
2723      *     Pretend we know nothing at all, i.e. "forget" about D1.
2724      */
2725     offs = lseek(s->fd, start, SEEK_HOLE);
2726     if (offs < 0) {
2727         return -errno;          /* D1 and (H3 or H4) */
2728     }
2729 
2730     if (offs < start) {
2731         /* This is not a valid return by lseek().  We are safe to just return
2732          * -EIO in this case, and we'll treat it like H4. */
2733         return -EIO;
2734     }
2735 
2736     if (offs > start) {
2737         /*
2738          * D1 and H2: either in data, next hole at offs, or it was in
2739          * data but is now in a trailing hole.  In the latter case,
2740          * all bets are off.  Treating it as if it there was data all
2741          * the way to EOF is safe, so simply do that.
2742          */
2743         *data = start;
2744         *hole = offs;
2745         return 0;
2746     }
2747 
2748     /* D1 and H1 */
2749     return -EBUSY;
2750 #else
2751     return -ENOTSUP;
2752 #endif
2753 }
2754 
2755 /*
2756  * Returns the allocation status of the specified offset.
2757  *
2758  * The block layer guarantees 'offset' and 'bytes' are within bounds.
2759  *
2760  * 'pnum' is set to the number of bytes (including and immediately following
2761  * the specified offset) that are known to be in the same
2762  * allocated/unallocated state.
2763  *
2764  * 'bytes' is a soft cap for 'pnum'.  If the information is free, 'pnum' may
2765  * well exceed it.
2766  */
2767 static int coroutine_fn raw_co_block_status(BlockDriverState *bs,
2768                                             bool want_zero,
2769                                             int64_t offset,
2770                                             int64_t bytes, int64_t *pnum,
2771                                             int64_t *map,
2772                                             BlockDriverState **file)
2773 {
2774     off_t data = 0, hole = 0;
2775     int ret;
2776 
2777     assert(QEMU_IS_ALIGNED(offset | bytes, bs->bl.request_alignment));
2778 
2779     ret = fd_open(bs);
2780     if (ret < 0) {
2781         return ret;
2782     }
2783 
2784     if (!want_zero) {
2785         *pnum = bytes;
2786         *map = offset;
2787         *file = bs;
2788         return BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
2789     }
2790 
2791     ret = find_allocation(bs, offset, &data, &hole);
2792     if (ret == -ENXIO) {
2793         /* Trailing hole */
2794         *pnum = bytes;
2795         ret = BDRV_BLOCK_ZERO;
2796     } else if (ret < 0) {
2797         /* No info available, so pretend there are no holes */
2798         *pnum = bytes;
2799         ret = BDRV_BLOCK_DATA;
2800     } else if (data == offset) {
2801         /* On a data extent, compute bytes to the end of the extent,
2802          * possibly including a partial sector at EOF. */
2803         *pnum = hole - offset;
2804 
2805         /*
2806          * We are not allowed to return partial sectors, though, so
2807          * round up if necessary.
2808          */
2809         if (!QEMU_IS_ALIGNED(*pnum, bs->bl.request_alignment)) {
2810             int64_t file_length = raw_getlength(bs);
2811             if (file_length > 0) {
2812                 /* Ignore errors, this is just a safeguard */
2813                 assert(hole == file_length);
2814             }
2815             *pnum = ROUND_UP(*pnum, bs->bl.request_alignment);
2816         }
2817 
2818         ret = BDRV_BLOCK_DATA;
2819     } else {
2820         /* On a hole, compute bytes to the beginning of the next extent.  */
2821         assert(hole == offset);
2822         *pnum = data - offset;
2823         ret = BDRV_BLOCK_ZERO;
2824     }
2825     *map = offset;
2826     *file = bs;
2827     return ret | BDRV_BLOCK_OFFSET_VALID;
2828 }
2829 
2830 #if defined(__linux__)
2831 /* Verify that the file is not in the page cache */
2832 static void check_cache_dropped(BlockDriverState *bs, Error **errp)
2833 {
2834     const size_t window_size = 128 * 1024 * 1024;
2835     BDRVRawState *s = bs->opaque;
2836     void *window = NULL;
2837     size_t length = 0;
2838     unsigned char *vec;
2839     size_t page_size;
2840     off_t offset;
2841     off_t end;
2842 
2843     /* mincore(2) page status information requires 1 byte per page */
2844     page_size = sysconf(_SC_PAGESIZE);
2845     vec = g_malloc(DIV_ROUND_UP(window_size, page_size));
2846 
2847     end = raw_getlength(bs);
2848 
2849     for (offset = 0; offset < end; offset += window_size) {
2850         void *new_window;
2851         size_t new_length;
2852         size_t vec_end;
2853         size_t i;
2854         int ret;
2855 
2856         /* Unmap previous window if size has changed */
2857         new_length = MIN(end - offset, window_size);
2858         if (new_length != length) {
2859             munmap(window, length);
2860             window = NULL;
2861             length = 0;
2862         }
2863 
2864         new_window = mmap(window, new_length, PROT_NONE, MAP_PRIVATE,
2865                           s->fd, offset);
2866         if (new_window == MAP_FAILED) {
2867             error_setg_errno(errp, errno, "mmap failed");
2868             break;
2869         }
2870 
2871         window = new_window;
2872         length = new_length;
2873 
2874         ret = mincore(window, length, vec);
2875         if (ret < 0) {
2876             error_setg_errno(errp, errno, "mincore failed");
2877             break;
2878         }
2879 
2880         vec_end = DIV_ROUND_UP(length, page_size);
2881         for (i = 0; i < vec_end; i++) {
2882             if (vec[i] & 0x1) {
2883                 break;
2884             }
2885         }
2886         if (i < vec_end) {
2887             error_setg(errp, "page cache still in use!");
2888             break;
2889         }
2890     }
2891 
2892     if (window) {
2893         munmap(window, length);
2894     }
2895 
2896     g_free(vec);
2897 }
2898 #endif /* __linux__ */
2899 
2900 static void coroutine_fn raw_co_invalidate_cache(BlockDriverState *bs,
2901                                                  Error **errp)
2902 {
2903     BDRVRawState *s = bs->opaque;
2904     int ret;
2905 
2906     ret = fd_open(bs);
2907     if (ret < 0) {
2908         error_setg_errno(errp, -ret, "The file descriptor is not open");
2909         return;
2910     }
2911 
2912     if (!s->drop_cache) {
2913         return;
2914     }
2915 
2916     if (s->open_flags & O_DIRECT) {
2917         return; /* No host kernel page cache */
2918     }
2919 
2920 #if defined(__linux__)
2921     /* This sets the scene for the next syscall... */
2922     ret = bdrv_co_flush(bs);
2923     if (ret < 0) {
2924         error_setg_errno(errp, -ret, "flush failed");
2925         return;
2926     }
2927 
2928     /* Linux does not invalidate pages that are dirty, locked, or mmapped by a
2929      * process.  These limitations are okay because we just fsynced the file,
2930      * we don't use mmap, and the file should not be in use by other processes.
2931      */
2932     ret = posix_fadvise(s->fd, 0, 0, POSIX_FADV_DONTNEED);
2933     if (ret != 0) { /* the return value is a positive errno */
2934         error_setg_errno(errp, ret, "fadvise failed");
2935         return;
2936     }
2937 
2938     if (s->check_cache_dropped) {
2939         check_cache_dropped(bs, errp);
2940     }
2941 #else /* __linux__ */
2942     /* Do nothing.  Live migration to a remote host with cache.direct=off is
2943      * unsupported on other host operating systems.  Cache consistency issues
2944      * may occur but no error is reported here, partly because that's the
2945      * historical behavior and partly because it's hard to differentiate valid
2946      * configurations that should not cause errors.
2947      */
2948 #endif /* !__linux__ */
2949 }
2950 
2951 static void raw_account_discard(BDRVRawState *s, uint64_t nbytes, int ret)
2952 {
2953     if (ret) {
2954         s->stats.discard_nb_failed++;
2955     } else {
2956         s->stats.discard_nb_ok++;
2957         s->stats.discard_bytes_ok += nbytes;
2958     }
2959 }
2960 
2961 static coroutine_fn int
2962 raw_do_pdiscard(BlockDriverState *bs, int64_t offset, int64_t bytes,
2963                 bool blkdev)
2964 {
2965     BDRVRawState *s = bs->opaque;
2966     RawPosixAIOData acb;
2967     int ret;
2968 
2969     acb = (RawPosixAIOData) {
2970         .bs             = bs,
2971         .aio_fildes     = s->fd,
2972         .aio_type       = QEMU_AIO_DISCARD,
2973         .aio_offset     = offset,
2974         .aio_nbytes     = bytes,
2975     };
2976 
2977     if (blkdev) {
2978         acb.aio_type |= QEMU_AIO_BLKDEV;
2979     }
2980 
2981     ret = raw_thread_pool_submit(bs, handle_aiocb_discard, &acb);
2982     raw_account_discard(s, bytes, ret);
2983     return ret;
2984 }
2985 
2986 static coroutine_fn int
2987 raw_co_pdiscard(BlockDriverState *bs, int64_t offset, int64_t bytes)
2988 {
2989     return raw_do_pdiscard(bs, offset, bytes, false);
2990 }
2991 
2992 static int coroutine_fn
2993 raw_do_pwrite_zeroes(BlockDriverState *bs, int64_t offset, int64_t bytes,
2994                      BdrvRequestFlags flags, bool blkdev)
2995 {
2996     BDRVRawState *s = bs->opaque;
2997     RawPosixAIOData acb;
2998     ThreadPoolFunc *handler;
2999 
3000 #ifdef CONFIG_FALLOCATE
3001     if (offset + bytes > bs->total_sectors * BDRV_SECTOR_SIZE) {
3002         BdrvTrackedRequest *req;
3003 
3004         /*
3005          * This is a workaround for a bug in the Linux XFS driver,
3006          * where writes submitted through the AIO interface will be
3007          * discarded if they happen beyond a concurrently running
3008          * fallocate() that increases the file length (i.e., both the
3009          * write and the fallocate() happen beyond the EOF).
3010          *
3011          * To work around it, we extend the tracked request for this
3012          * zero write until INT64_MAX (effectively infinity), and mark
3013          * it as serializing.
3014          *
3015          * We have to enable this workaround for all filesystems and
3016          * AIO modes (not just XFS with aio=native), because for
3017          * remote filesystems we do not know the host configuration.
3018          */
3019 
3020         req = bdrv_co_get_self_request(bs);
3021         assert(req);
3022         assert(req->type == BDRV_TRACKED_WRITE);
3023         assert(req->offset <= offset);
3024         assert(req->offset + req->bytes >= offset + bytes);
3025 
3026         req->bytes = BDRV_MAX_LENGTH - req->offset;
3027 
3028         bdrv_check_request(req->offset, req->bytes, &error_abort);
3029 
3030         bdrv_make_request_serialising(req, bs->bl.request_alignment);
3031     }
3032 #endif
3033 
3034     acb = (RawPosixAIOData) {
3035         .bs             = bs,
3036         .aio_fildes     = s->fd,
3037         .aio_type       = QEMU_AIO_WRITE_ZEROES,
3038         .aio_offset     = offset,
3039         .aio_nbytes     = bytes,
3040     };
3041 
3042     if (blkdev) {
3043         acb.aio_type |= QEMU_AIO_BLKDEV;
3044     }
3045     if (flags & BDRV_REQ_NO_FALLBACK) {
3046         acb.aio_type |= QEMU_AIO_NO_FALLBACK;
3047     }
3048 
3049     if (flags & BDRV_REQ_MAY_UNMAP) {
3050         acb.aio_type |= QEMU_AIO_DISCARD;
3051         handler = handle_aiocb_write_zeroes_unmap;
3052     } else {
3053         handler = handle_aiocb_write_zeroes;
3054     }
3055 
3056     return raw_thread_pool_submit(bs, handler, &acb);
3057 }
3058 
3059 static int coroutine_fn raw_co_pwrite_zeroes(
3060     BlockDriverState *bs, int64_t offset,
3061     int64_t bytes, BdrvRequestFlags flags)
3062 {
3063     return raw_do_pwrite_zeroes(bs, offset, bytes, flags, false);
3064 }
3065 
3066 static int raw_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
3067 {
3068     return 0;
3069 }
3070 
3071 static BlockStatsSpecificFile get_blockstats_specific_file(BlockDriverState *bs)
3072 {
3073     BDRVRawState *s = bs->opaque;
3074     return (BlockStatsSpecificFile) {
3075         .discard_nb_ok = s->stats.discard_nb_ok,
3076         .discard_nb_failed = s->stats.discard_nb_failed,
3077         .discard_bytes_ok = s->stats.discard_bytes_ok,
3078     };
3079 }
3080 
3081 static BlockStatsSpecific *raw_get_specific_stats(BlockDriverState *bs)
3082 {
3083     BlockStatsSpecific *stats = g_new(BlockStatsSpecific, 1);
3084 
3085     stats->driver = BLOCKDEV_DRIVER_FILE;
3086     stats->u.file = get_blockstats_specific_file(bs);
3087 
3088     return stats;
3089 }
3090 
3091 #if defined(HAVE_HOST_BLOCK_DEVICE)
3092 static BlockStatsSpecific *hdev_get_specific_stats(BlockDriverState *bs)
3093 {
3094     BlockStatsSpecific *stats = g_new(BlockStatsSpecific, 1);
3095 
3096     stats->driver = BLOCKDEV_DRIVER_HOST_DEVICE;
3097     stats->u.host_device = get_blockstats_specific_file(bs);
3098 
3099     return stats;
3100 }
3101 #endif /* HAVE_HOST_BLOCK_DEVICE */
3102 
3103 static QemuOptsList raw_create_opts = {
3104     .name = "raw-create-opts",
3105     .head = QTAILQ_HEAD_INITIALIZER(raw_create_opts.head),
3106     .desc = {
3107         {
3108             .name = BLOCK_OPT_SIZE,
3109             .type = QEMU_OPT_SIZE,
3110             .help = "Virtual disk size"
3111         },
3112         {
3113             .name = BLOCK_OPT_NOCOW,
3114             .type = QEMU_OPT_BOOL,
3115             .help = "Turn off copy-on-write (valid only on btrfs)"
3116         },
3117         {
3118             .name = BLOCK_OPT_PREALLOC,
3119             .type = QEMU_OPT_STRING,
3120             .help = "Preallocation mode (allowed values: off"
3121 #ifdef CONFIG_POSIX_FALLOCATE
3122                     ", falloc"
3123 #endif
3124                     ", full)"
3125         },
3126         {
3127             .name = BLOCK_OPT_EXTENT_SIZE_HINT,
3128             .type = QEMU_OPT_SIZE,
3129             .help = "Extent size hint for the image file, 0 to disable"
3130         },
3131         { /* end of list */ }
3132     }
3133 };
3134 
3135 static int raw_check_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared,
3136                           Error **errp)
3137 {
3138     BDRVRawState *s = bs->opaque;
3139     int input_flags = s->reopen_state ? s->reopen_state->flags : bs->open_flags;
3140     int open_flags;
3141     int ret;
3142 
3143     /* We may need a new fd if auto-read-only switches the mode */
3144     ret = raw_reconfigure_getfd(bs, input_flags, &open_flags, perm,
3145                                 false, errp);
3146     if (ret < 0) {
3147         return ret;
3148     } else if (ret != s->fd) {
3149         Error *local_err = NULL;
3150 
3151         /*
3152          * Fail already check_perm() if we can't get a working O_DIRECT
3153          * alignment with the new fd.
3154          */
3155         raw_probe_alignment(bs, ret, &local_err);
3156         if (local_err) {
3157             error_propagate(errp, local_err);
3158             return -EINVAL;
3159         }
3160 
3161         s->perm_change_fd = ret;
3162         s->perm_change_flags = open_flags;
3163     }
3164 
3165     /* Prepare permissions on old fd to avoid conflicts between old and new,
3166      * but keep everything locked that new will need. */
3167     ret = raw_handle_perm_lock(bs, RAW_PL_PREPARE, perm, shared, errp);
3168     if (ret < 0) {
3169         goto fail;
3170     }
3171 
3172     /* Copy locks to the new fd */
3173     if (s->perm_change_fd && s->use_lock) {
3174         ret = raw_apply_lock_bytes(NULL, s->perm_change_fd, perm, ~shared,
3175                                    false, errp);
3176         if (ret < 0) {
3177             raw_handle_perm_lock(bs, RAW_PL_ABORT, 0, 0, NULL);
3178             goto fail;
3179         }
3180     }
3181     return 0;
3182 
3183 fail:
3184     if (s->perm_change_fd) {
3185         qemu_close(s->perm_change_fd);
3186     }
3187     s->perm_change_fd = 0;
3188     return ret;
3189 }
3190 
3191 static void raw_set_perm(BlockDriverState *bs, uint64_t perm, uint64_t shared)
3192 {
3193     BDRVRawState *s = bs->opaque;
3194 
3195     /* For reopen, we have already switched to the new fd (.bdrv_set_perm is
3196      * called after .bdrv_reopen_commit) */
3197     if (s->perm_change_fd && s->fd != s->perm_change_fd) {
3198         qemu_close(s->fd);
3199         s->fd = s->perm_change_fd;
3200         s->open_flags = s->perm_change_flags;
3201     }
3202     s->perm_change_fd = 0;
3203 
3204     raw_handle_perm_lock(bs, RAW_PL_COMMIT, perm, shared, NULL);
3205     s->perm = perm;
3206     s->shared_perm = shared;
3207 }
3208 
3209 static void raw_abort_perm_update(BlockDriverState *bs)
3210 {
3211     BDRVRawState *s = bs->opaque;
3212 
3213     /* For reopen, .bdrv_reopen_abort is called afterwards and will close
3214      * the file descriptor. */
3215     if (s->perm_change_fd) {
3216         qemu_close(s->perm_change_fd);
3217     }
3218     s->perm_change_fd = 0;
3219 
3220     raw_handle_perm_lock(bs, RAW_PL_ABORT, 0, 0, NULL);
3221 }
3222 
3223 static int coroutine_fn raw_co_copy_range_from(
3224         BlockDriverState *bs, BdrvChild *src, int64_t src_offset,
3225         BdrvChild *dst, int64_t dst_offset, int64_t bytes,
3226         BdrvRequestFlags read_flags, BdrvRequestFlags write_flags)
3227 {
3228     return bdrv_co_copy_range_to(src, src_offset, dst, dst_offset, bytes,
3229                                  read_flags, write_flags);
3230 }
3231 
3232 static int coroutine_fn raw_co_copy_range_to(BlockDriverState *bs,
3233                                              BdrvChild *src,
3234                                              int64_t src_offset,
3235                                              BdrvChild *dst,
3236                                              int64_t dst_offset,
3237                                              int64_t bytes,
3238                                              BdrvRequestFlags read_flags,
3239                                              BdrvRequestFlags write_flags)
3240 {
3241     RawPosixAIOData acb;
3242     BDRVRawState *s = bs->opaque;
3243     BDRVRawState *src_s;
3244 
3245     assert(dst->bs == bs);
3246     if (src->bs->drv->bdrv_co_copy_range_to != raw_co_copy_range_to) {
3247         return -ENOTSUP;
3248     }
3249 
3250     src_s = src->bs->opaque;
3251     if (fd_open(src->bs) < 0 || fd_open(dst->bs) < 0) {
3252         return -EIO;
3253     }
3254 
3255     acb = (RawPosixAIOData) {
3256         .bs             = bs,
3257         .aio_type       = QEMU_AIO_COPY_RANGE,
3258         .aio_fildes     = src_s->fd,
3259         .aio_offset     = src_offset,
3260         .aio_nbytes     = bytes,
3261         .copy_range     = {
3262             .aio_fd2        = s->fd,
3263             .aio_offset2    = dst_offset,
3264         },
3265     };
3266 
3267     return raw_thread_pool_submit(bs, handle_aiocb_copy_range, &acb);
3268 }
3269 
3270 BlockDriver bdrv_file = {
3271     .format_name = "file",
3272     .protocol_name = "file",
3273     .instance_size = sizeof(BDRVRawState),
3274     .bdrv_needs_filename = true,
3275     .bdrv_probe = NULL, /* no probe for protocols */
3276     .bdrv_parse_filename = raw_parse_filename,
3277     .bdrv_file_open = raw_open,
3278     .bdrv_reopen_prepare = raw_reopen_prepare,
3279     .bdrv_reopen_commit = raw_reopen_commit,
3280     .bdrv_reopen_abort = raw_reopen_abort,
3281     .bdrv_close = raw_close,
3282     .bdrv_co_create = raw_co_create,
3283     .bdrv_co_create_opts = raw_co_create_opts,
3284     .bdrv_has_zero_init = bdrv_has_zero_init_1,
3285     .bdrv_co_block_status = raw_co_block_status,
3286     .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3287     .bdrv_co_pwrite_zeroes = raw_co_pwrite_zeroes,
3288     .bdrv_co_delete_file = raw_co_delete_file,
3289 
3290     .bdrv_co_preadv         = raw_co_preadv,
3291     .bdrv_co_pwritev        = raw_co_pwritev,
3292     .bdrv_co_flush_to_disk  = raw_co_flush_to_disk,
3293     .bdrv_co_pdiscard       = raw_co_pdiscard,
3294     .bdrv_co_copy_range_from = raw_co_copy_range_from,
3295     .bdrv_co_copy_range_to  = raw_co_copy_range_to,
3296     .bdrv_refresh_limits = raw_refresh_limits,
3297     .bdrv_io_plug = raw_aio_plug,
3298     .bdrv_io_unplug = raw_aio_unplug,
3299     .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3300 
3301     .bdrv_co_truncate = raw_co_truncate,
3302     .bdrv_getlength = raw_getlength,
3303     .bdrv_get_info = raw_get_info,
3304     .bdrv_get_allocated_file_size
3305                         = raw_get_allocated_file_size,
3306     .bdrv_get_specific_stats = raw_get_specific_stats,
3307     .bdrv_check_perm = raw_check_perm,
3308     .bdrv_set_perm   = raw_set_perm,
3309     .bdrv_abort_perm_update = raw_abort_perm_update,
3310     .create_opts = &raw_create_opts,
3311     .mutable_opts = mutable_opts,
3312 };
3313 
3314 /***********************************************/
3315 /* host device */
3316 
3317 #if defined(HAVE_HOST_BLOCK_DEVICE)
3318 
3319 #if defined(__APPLE__) && defined(__MACH__)
3320 static kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
3321                                 CFIndex maxPathSize, int flags);
3322 static char *FindEjectableOpticalMedia(io_iterator_t *mediaIterator)
3323 {
3324     kern_return_t kernResult = KERN_FAILURE;
3325     mach_port_t     masterPort;
3326     CFMutableDictionaryRef  classesToMatch;
3327     const char *matching_array[] = {kIODVDMediaClass, kIOCDMediaClass};
3328     char *mediaType = NULL;
3329 
3330     kernResult = IOMasterPort( MACH_PORT_NULL, &masterPort );
3331     if ( KERN_SUCCESS != kernResult ) {
3332         printf( "IOMasterPort returned %d\n", kernResult );
3333     }
3334 
3335     int index;
3336     for (index = 0; index < ARRAY_SIZE(matching_array); index++) {
3337         classesToMatch = IOServiceMatching(matching_array[index]);
3338         if (classesToMatch == NULL) {
3339             error_report("IOServiceMatching returned NULL for %s",
3340                          matching_array[index]);
3341             continue;
3342         }
3343         CFDictionarySetValue(classesToMatch, CFSTR(kIOMediaEjectableKey),
3344                              kCFBooleanTrue);
3345         kernResult = IOServiceGetMatchingServices(masterPort, classesToMatch,
3346                                                   mediaIterator);
3347         if (kernResult != KERN_SUCCESS) {
3348             error_report("Note: IOServiceGetMatchingServices returned %d",
3349                          kernResult);
3350             continue;
3351         }
3352 
3353         /* If a match was found, leave the loop */
3354         if (*mediaIterator != 0) {
3355             trace_file_FindEjectableOpticalMedia(matching_array[index]);
3356             mediaType = g_strdup(matching_array[index]);
3357             break;
3358         }
3359     }
3360     return mediaType;
3361 }
3362 
3363 kern_return_t GetBSDPath(io_iterator_t mediaIterator, char *bsdPath,
3364                          CFIndex maxPathSize, int flags)
3365 {
3366     io_object_t     nextMedia;
3367     kern_return_t   kernResult = KERN_FAILURE;
3368     *bsdPath = '\0';
3369     nextMedia = IOIteratorNext( mediaIterator );
3370     if ( nextMedia )
3371     {
3372         CFTypeRef   bsdPathAsCFString;
3373     bsdPathAsCFString = IORegistryEntryCreateCFProperty( nextMedia, CFSTR( kIOBSDNameKey ), kCFAllocatorDefault, 0 );
3374         if ( bsdPathAsCFString ) {
3375             size_t devPathLength;
3376             strcpy( bsdPath, _PATH_DEV );
3377             if (flags & BDRV_O_NOCACHE) {
3378                 strcat(bsdPath, "r");
3379             }
3380             devPathLength = strlen( bsdPath );
3381             if ( CFStringGetCString( bsdPathAsCFString, bsdPath + devPathLength, maxPathSize - devPathLength, kCFStringEncodingASCII ) ) {
3382                 kernResult = KERN_SUCCESS;
3383             }
3384             CFRelease( bsdPathAsCFString );
3385         }
3386         IOObjectRelease( nextMedia );
3387     }
3388 
3389     return kernResult;
3390 }
3391 
3392 /* Sets up a real cdrom for use in QEMU */
3393 static bool setup_cdrom(char *bsd_path, Error **errp)
3394 {
3395     int index, num_of_test_partitions = 2, fd;
3396     char test_partition[MAXPATHLEN];
3397     bool partition_found = false;
3398 
3399     /* look for a working partition */
3400     for (index = 0; index < num_of_test_partitions; index++) {
3401         snprintf(test_partition, sizeof(test_partition), "%ss%d", bsd_path,
3402                  index);
3403         fd = qemu_open(test_partition, O_RDONLY | O_BINARY | O_LARGEFILE, NULL);
3404         if (fd >= 0) {
3405             partition_found = true;
3406             qemu_close(fd);
3407             break;
3408         }
3409     }
3410 
3411     /* if a working partition on the device was not found */
3412     if (partition_found == false) {
3413         error_setg(errp, "Failed to find a working partition on disc");
3414     } else {
3415         trace_file_setup_cdrom(test_partition);
3416         pstrcpy(bsd_path, MAXPATHLEN, test_partition);
3417     }
3418     return partition_found;
3419 }
3420 
3421 /* Prints directions on mounting and unmounting a device */
3422 static void print_unmounting_directions(const char *file_name)
3423 {
3424     error_report("If device %s is mounted on the desktop, unmount"
3425                  " it first before using it in QEMU", file_name);
3426     error_report("Command to unmount device: diskutil unmountDisk %s",
3427                  file_name);
3428     error_report("Command to mount device: diskutil mountDisk %s", file_name);
3429 }
3430 
3431 #endif /* defined(__APPLE__) && defined(__MACH__) */
3432 
3433 static int hdev_probe_device(const char *filename)
3434 {
3435     struct stat st;
3436 
3437     /* allow a dedicated CD-ROM driver to match with a higher priority */
3438     if (strstart(filename, "/dev/cdrom", NULL))
3439         return 50;
3440 
3441     if (stat(filename, &st) >= 0 &&
3442             (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
3443         return 100;
3444     }
3445 
3446     return 0;
3447 }
3448 
3449 static void hdev_parse_filename(const char *filename, QDict *options,
3450                                 Error **errp)
3451 {
3452     bdrv_parse_filename_strip_prefix(filename, "host_device:", options);
3453 }
3454 
3455 static bool hdev_is_sg(BlockDriverState *bs)
3456 {
3457 
3458 #if defined(__linux__)
3459 
3460     BDRVRawState *s = bs->opaque;
3461     struct stat st;
3462     struct sg_scsi_id scsiid;
3463     int sg_version;
3464     int ret;
3465 
3466     if (stat(bs->filename, &st) < 0 || !S_ISCHR(st.st_mode)) {
3467         return false;
3468     }
3469 
3470     ret = ioctl(s->fd, SG_GET_VERSION_NUM, &sg_version);
3471     if (ret < 0) {
3472         return false;
3473     }
3474 
3475     ret = ioctl(s->fd, SG_GET_SCSI_ID, &scsiid);
3476     if (ret >= 0) {
3477         trace_file_hdev_is_sg(scsiid.scsi_type, sg_version);
3478         return true;
3479     }
3480 
3481 #endif
3482 
3483     return false;
3484 }
3485 
3486 static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
3487                      Error **errp)
3488 {
3489     BDRVRawState *s = bs->opaque;
3490     int ret;
3491 
3492 #if defined(__APPLE__) && defined(__MACH__)
3493     /*
3494      * Caution: while qdict_get_str() is fine, getting non-string types
3495      * would require more care.  When @options come from -blockdev or
3496      * blockdev_add, its members are typed according to the QAPI
3497      * schema, but when they come from -drive, they're all QString.
3498      */
3499     const char *filename = qdict_get_str(options, "filename");
3500     char bsd_path[MAXPATHLEN] = "";
3501     bool error_occurred = false;
3502 
3503     /* If using a real cdrom */
3504     if (strcmp(filename, "/dev/cdrom") == 0) {
3505         char *mediaType = NULL;
3506         kern_return_t ret_val;
3507         io_iterator_t mediaIterator = 0;
3508 
3509         mediaType = FindEjectableOpticalMedia(&mediaIterator);
3510         if (mediaType == NULL) {
3511             error_setg(errp, "Please make sure your CD/DVD is in the optical"
3512                        " drive");
3513             error_occurred = true;
3514             goto hdev_open_Mac_error;
3515         }
3516 
3517         ret_val = GetBSDPath(mediaIterator, bsd_path, sizeof(bsd_path), flags);
3518         if (ret_val != KERN_SUCCESS) {
3519             error_setg(errp, "Could not get BSD path for optical drive");
3520             error_occurred = true;
3521             goto hdev_open_Mac_error;
3522         }
3523 
3524         /* If a real optical drive was not found */
3525         if (bsd_path[0] == '\0') {
3526             error_setg(errp, "Failed to obtain bsd path for optical drive");
3527             error_occurred = true;
3528             goto hdev_open_Mac_error;
3529         }
3530 
3531         /* If using a cdrom disc and finding a partition on the disc failed */
3532         if (strncmp(mediaType, kIOCDMediaClass, 9) == 0 &&
3533             setup_cdrom(bsd_path, errp) == false) {
3534             print_unmounting_directions(bsd_path);
3535             error_occurred = true;
3536             goto hdev_open_Mac_error;
3537         }
3538 
3539         qdict_put_str(options, "filename", bsd_path);
3540 
3541 hdev_open_Mac_error:
3542         g_free(mediaType);
3543         if (mediaIterator) {
3544             IOObjectRelease(mediaIterator);
3545         }
3546         if (error_occurred) {
3547             return -ENOENT;
3548         }
3549     }
3550 #endif /* defined(__APPLE__) && defined(__MACH__) */
3551 
3552     s->type = FTYPE_FILE;
3553 
3554     ret = raw_open_common(bs, options, flags, 0, true, errp);
3555     if (ret < 0) {
3556 #if defined(__APPLE__) && defined(__MACH__)
3557         if (*bsd_path) {
3558             filename = bsd_path;
3559         }
3560         /* if a physical device experienced an error while being opened */
3561         if (strncmp(filename, "/dev/", 5) == 0) {
3562             print_unmounting_directions(filename);
3563         }
3564 #endif /* defined(__APPLE__) && defined(__MACH__) */
3565         return ret;
3566     }
3567 
3568     /* Since this does ioctl the device must be already opened */
3569     bs->sg = hdev_is_sg(bs);
3570 
3571     return ret;
3572 }
3573 
3574 #if defined(__linux__)
3575 static int coroutine_fn
3576 hdev_co_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
3577 {
3578     BDRVRawState *s = bs->opaque;
3579     RawPosixAIOData acb;
3580     int ret;
3581 
3582     ret = fd_open(bs);
3583     if (ret < 0) {
3584         return ret;
3585     }
3586 
3587     if (req == SG_IO && s->pr_mgr) {
3588         struct sg_io_hdr *io_hdr = buf;
3589         if (io_hdr->cmdp[0] == PERSISTENT_RESERVE_OUT ||
3590             io_hdr->cmdp[0] == PERSISTENT_RESERVE_IN) {
3591             return pr_manager_execute(s->pr_mgr, bdrv_get_aio_context(bs),
3592                                       s->fd, io_hdr);
3593         }
3594     }
3595 
3596     acb = (RawPosixAIOData) {
3597         .bs         = bs,
3598         .aio_type   = QEMU_AIO_IOCTL,
3599         .aio_fildes = s->fd,
3600         .aio_offset = 0,
3601         .ioctl      = {
3602             .buf        = buf,
3603             .cmd        = req,
3604         },
3605     };
3606 
3607     return raw_thread_pool_submit(bs, handle_aiocb_ioctl, &acb);
3608 }
3609 #endif /* linux */
3610 
3611 static coroutine_fn int
3612 hdev_co_pdiscard(BlockDriverState *bs, int64_t offset, int64_t bytes)
3613 {
3614     BDRVRawState *s = bs->opaque;
3615     int ret;
3616 
3617     ret = fd_open(bs);
3618     if (ret < 0) {
3619         raw_account_discard(s, bytes, ret);
3620         return ret;
3621     }
3622     return raw_do_pdiscard(bs, offset, bytes, true);
3623 }
3624 
3625 static coroutine_fn int hdev_co_pwrite_zeroes(BlockDriverState *bs,
3626     int64_t offset, int64_t bytes, BdrvRequestFlags flags)
3627 {
3628     int rc;
3629 
3630     rc = fd_open(bs);
3631     if (rc < 0) {
3632         return rc;
3633     }
3634 
3635     return raw_do_pwrite_zeroes(bs, offset, bytes, flags, true);
3636 }
3637 
3638 static BlockDriver bdrv_host_device = {
3639     .format_name        = "host_device",
3640     .protocol_name        = "host_device",
3641     .instance_size      = sizeof(BDRVRawState),
3642     .bdrv_needs_filename = true,
3643     .bdrv_probe_device  = hdev_probe_device,
3644     .bdrv_parse_filename = hdev_parse_filename,
3645     .bdrv_file_open     = hdev_open,
3646     .bdrv_close         = raw_close,
3647     .bdrv_reopen_prepare = raw_reopen_prepare,
3648     .bdrv_reopen_commit  = raw_reopen_commit,
3649     .bdrv_reopen_abort   = raw_reopen_abort,
3650     .bdrv_co_create_opts = bdrv_co_create_opts_simple,
3651     .create_opts         = &bdrv_create_opts_simple,
3652     .mutable_opts        = mutable_opts,
3653     .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3654     .bdrv_co_pwrite_zeroes = hdev_co_pwrite_zeroes,
3655 
3656     .bdrv_co_preadv         = raw_co_preadv,
3657     .bdrv_co_pwritev        = raw_co_pwritev,
3658     .bdrv_co_flush_to_disk  = raw_co_flush_to_disk,
3659     .bdrv_co_pdiscard       = hdev_co_pdiscard,
3660     .bdrv_co_copy_range_from = raw_co_copy_range_from,
3661     .bdrv_co_copy_range_to  = raw_co_copy_range_to,
3662     .bdrv_refresh_limits = raw_refresh_limits,
3663     .bdrv_io_plug = raw_aio_plug,
3664     .bdrv_io_unplug = raw_aio_unplug,
3665     .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3666 
3667     .bdrv_co_truncate       = raw_co_truncate,
3668     .bdrv_getlength	= raw_getlength,
3669     .bdrv_get_info = raw_get_info,
3670     .bdrv_get_allocated_file_size
3671                         = raw_get_allocated_file_size,
3672     .bdrv_get_specific_stats = hdev_get_specific_stats,
3673     .bdrv_check_perm = raw_check_perm,
3674     .bdrv_set_perm   = raw_set_perm,
3675     .bdrv_abort_perm_update = raw_abort_perm_update,
3676     .bdrv_probe_blocksizes = hdev_probe_blocksizes,
3677     .bdrv_probe_geometry = hdev_probe_geometry,
3678 
3679     /* generic scsi device */
3680 #ifdef __linux__
3681     .bdrv_co_ioctl          = hdev_co_ioctl,
3682 #endif
3683 };
3684 
3685 #if defined(__linux__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3686 static void cdrom_parse_filename(const char *filename, QDict *options,
3687                                  Error **errp)
3688 {
3689     bdrv_parse_filename_strip_prefix(filename, "host_cdrom:", options);
3690 }
3691 #endif
3692 
3693 #ifdef __linux__
3694 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3695                       Error **errp)
3696 {
3697     BDRVRawState *s = bs->opaque;
3698 
3699     s->type = FTYPE_CD;
3700 
3701     /* open will not fail even if no CD is inserted, so add O_NONBLOCK */
3702     return raw_open_common(bs, options, flags, O_NONBLOCK, true, errp);
3703 }
3704 
3705 static int cdrom_probe_device(const char *filename)
3706 {
3707     int fd, ret;
3708     int prio = 0;
3709     struct stat st;
3710 
3711     fd = qemu_open(filename, O_RDONLY | O_NONBLOCK, NULL);
3712     if (fd < 0) {
3713         goto out;
3714     }
3715     ret = fstat(fd, &st);
3716     if (ret == -1 || !S_ISBLK(st.st_mode)) {
3717         goto outc;
3718     }
3719 
3720     /* Attempt to detect via a CDROM specific ioctl */
3721     ret = ioctl(fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3722     if (ret >= 0)
3723         prio = 100;
3724 
3725 outc:
3726     qemu_close(fd);
3727 out:
3728     return prio;
3729 }
3730 
3731 static bool cdrom_is_inserted(BlockDriverState *bs)
3732 {
3733     BDRVRawState *s = bs->opaque;
3734     int ret;
3735 
3736     ret = ioctl(s->fd, CDROM_DRIVE_STATUS, CDSL_CURRENT);
3737     return ret == CDS_DISC_OK;
3738 }
3739 
3740 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3741 {
3742     BDRVRawState *s = bs->opaque;
3743 
3744     if (eject_flag) {
3745         if (ioctl(s->fd, CDROMEJECT, NULL) < 0)
3746             perror("CDROMEJECT");
3747     } else {
3748         if (ioctl(s->fd, CDROMCLOSETRAY, NULL) < 0)
3749             perror("CDROMEJECT");
3750     }
3751 }
3752 
3753 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3754 {
3755     BDRVRawState *s = bs->opaque;
3756 
3757     if (ioctl(s->fd, CDROM_LOCKDOOR, locked) < 0) {
3758         /*
3759          * Note: an error can happen if the distribution automatically
3760          * mounts the CD-ROM
3761          */
3762         /* perror("CDROM_LOCKDOOR"); */
3763     }
3764 }
3765 
3766 static BlockDriver bdrv_host_cdrom = {
3767     .format_name        = "host_cdrom",
3768     .protocol_name      = "host_cdrom",
3769     .instance_size      = sizeof(BDRVRawState),
3770     .bdrv_needs_filename = true,
3771     .bdrv_probe_device	= cdrom_probe_device,
3772     .bdrv_parse_filename = cdrom_parse_filename,
3773     .bdrv_file_open     = cdrom_open,
3774     .bdrv_close         = raw_close,
3775     .bdrv_reopen_prepare = raw_reopen_prepare,
3776     .bdrv_reopen_commit  = raw_reopen_commit,
3777     .bdrv_reopen_abort   = raw_reopen_abort,
3778     .bdrv_co_create_opts = bdrv_co_create_opts_simple,
3779     .create_opts         = &bdrv_create_opts_simple,
3780     .mutable_opts        = mutable_opts,
3781     .bdrv_co_invalidate_cache = raw_co_invalidate_cache,
3782 
3783     .bdrv_co_preadv         = raw_co_preadv,
3784     .bdrv_co_pwritev        = raw_co_pwritev,
3785     .bdrv_co_flush_to_disk  = raw_co_flush_to_disk,
3786     .bdrv_refresh_limits = raw_refresh_limits,
3787     .bdrv_io_plug = raw_aio_plug,
3788     .bdrv_io_unplug = raw_aio_unplug,
3789     .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3790 
3791     .bdrv_co_truncate    = raw_co_truncate,
3792     .bdrv_getlength      = raw_getlength,
3793     .has_variable_length = true,
3794     .bdrv_get_allocated_file_size
3795                         = raw_get_allocated_file_size,
3796 
3797     /* removable device support */
3798     .bdrv_is_inserted   = cdrom_is_inserted,
3799     .bdrv_eject         = cdrom_eject,
3800     .bdrv_lock_medium   = cdrom_lock_medium,
3801 
3802     /* generic scsi device */
3803     .bdrv_co_ioctl      = hdev_co_ioctl,
3804 };
3805 #endif /* __linux__ */
3806 
3807 #if defined (__FreeBSD__) || defined(__FreeBSD_kernel__)
3808 static int cdrom_open(BlockDriverState *bs, QDict *options, int flags,
3809                       Error **errp)
3810 {
3811     BDRVRawState *s = bs->opaque;
3812     int ret;
3813 
3814     s->type = FTYPE_CD;
3815 
3816     ret = raw_open_common(bs, options, flags, 0, true, errp);
3817     if (ret) {
3818         return ret;
3819     }
3820 
3821     /* make sure the door isn't locked at this time */
3822     ioctl(s->fd, CDIOCALLOW);
3823     return 0;
3824 }
3825 
3826 static int cdrom_probe_device(const char *filename)
3827 {
3828     if (strstart(filename, "/dev/cd", NULL) ||
3829             strstart(filename, "/dev/acd", NULL))
3830         return 100;
3831     return 0;
3832 }
3833 
3834 static int cdrom_reopen(BlockDriverState *bs)
3835 {
3836     BDRVRawState *s = bs->opaque;
3837     int fd;
3838 
3839     /*
3840      * Force reread of possibly changed/newly loaded disc,
3841      * FreeBSD seems to not notice sometimes...
3842      */
3843     if (s->fd >= 0)
3844         qemu_close(s->fd);
3845     fd = qemu_open(bs->filename, s->open_flags, NULL);
3846     if (fd < 0) {
3847         s->fd = -1;
3848         return -EIO;
3849     }
3850     s->fd = fd;
3851 
3852     /* make sure the door isn't locked at this time */
3853     ioctl(s->fd, CDIOCALLOW);
3854     return 0;
3855 }
3856 
3857 static bool cdrom_is_inserted(BlockDriverState *bs)
3858 {
3859     return raw_getlength(bs) > 0;
3860 }
3861 
3862 static void cdrom_eject(BlockDriverState *bs, bool eject_flag)
3863 {
3864     BDRVRawState *s = bs->opaque;
3865 
3866     if (s->fd < 0)
3867         return;
3868 
3869     (void) ioctl(s->fd, CDIOCALLOW);
3870 
3871     if (eject_flag) {
3872         if (ioctl(s->fd, CDIOCEJECT) < 0)
3873             perror("CDIOCEJECT");
3874     } else {
3875         if (ioctl(s->fd, CDIOCCLOSE) < 0)
3876             perror("CDIOCCLOSE");
3877     }
3878 
3879     cdrom_reopen(bs);
3880 }
3881 
3882 static void cdrom_lock_medium(BlockDriverState *bs, bool locked)
3883 {
3884     BDRVRawState *s = bs->opaque;
3885 
3886     if (s->fd < 0)
3887         return;
3888     if (ioctl(s->fd, (locked ? CDIOCPREVENT : CDIOCALLOW)) < 0) {
3889         /*
3890          * Note: an error can happen if the distribution automatically
3891          * mounts the CD-ROM
3892          */
3893         /* perror("CDROM_LOCKDOOR"); */
3894     }
3895 }
3896 
3897 static BlockDriver bdrv_host_cdrom = {
3898     .format_name        = "host_cdrom",
3899     .protocol_name      = "host_cdrom",
3900     .instance_size      = sizeof(BDRVRawState),
3901     .bdrv_needs_filename = true,
3902     .bdrv_probe_device	= cdrom_probe_device,
3903     .bdrv_parse_filename = cdrom_parse_filename,
3904     .bdrv_file_open     = cdrom_open,
3905     .bdrv_close         = raw_close,
3906     .bdrv_reopen_prepare = raw_reopen_prepare,
3907     .bdrv_reopen_commit  = raw_reopen_commit,
3908     .bdrv_reopen_abort   = raw_reopen_abort,
3909     .bdrv_co_create_opts = bdrv_co_create_opts_simple,
3910     .create_opts         = &bdrv_create_opts_simple,
3911     .mutable_opts       = mutable_opts,
3912 
3913     .bdrv_co_preadv         = raw_co_preadv,
3914     .bdrv_co_pwritev        = raw_co_pwritev,
3915     .bdrv_co_flush_to_disk  = raw_co_flush_to_disk,
3916     .bdrv_refresh_limits = raw_refresh_limits,
3917     .bdrv_io_plug = raw_aio_plug,
3918     .bdrv_io_unplug = raw_aio_unplug,
3919     .bdrv_attach_aio_context = raw_aio_attach_aio_context,
3920 
3921     .bdrv_co_truncate    = raw_co_truncate,
3922     .bdrv_getlength      = raw_getlength,
3923     .has_variable_length = true,
3924     .bdrv_get_allocated_file_size
3925                         = raw_get_allocated_file_size,
3926 
3927     /* removable device support */
3928     .bdrv_is_inserted   = cdrom_is_inserted,
3929     .bdrv_eject         = cdrom_eject,
3930     .bdrv_lock_medium   = cdrom_lock_medium,
3931 };
3932 #endif /* __FreeBSD__ */
3933 
3934 #endif /* HAVE_HOST_BLOCK_DEVICE */
3935 
3936 static void bdrv_file_init(void)
3937 {
3938     /*
3939      * Register all the drivers.  Note that order is important, the driver
3940      * registered last will get probed first.
3941      */
3942     bdrv_register(&bdrv_file);
3943 #if defined(HAVE_HOST_BLOCK_DEVICE)
3944     bdrv_register(&bdrv_host_device);
3945 #ifdef __linux__
3946     bdrv_register(&bdrv_host_cdrom);
3947 #endif
3948 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
3949     bdrv_register(&bdrv_host_cdrom);
3950 #endif
3951 #endif /* HAVE_HOST_BLOCK_DEVICE */
3952 }
3953 
3954 block_init(bdrv_file_init);
3955