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