2 * Block driver for RAW files (win32)
4 * Copyright (c) 2006 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
26 #include "qapi/error.h"
27 #include "qemu/cutils.h"
28 #include "block/block_int.h"
29 #include "qemu/module.h"
30 #include "qemu/option.h"
31 #include "block/raw-aio.h"
33 #include "block/thread-pool.h"
35 #include "qapi/qmp/qdict.h"
36 #include "qapi/qmp/qstring.h"
42 #define FTYPE_HARDDISK 2
44 typedef struct RawWin32AIOData
{
47 struct iovec
*aio_iov
;
54 typedef struct BDRVRawState
{
57 char drive_path
[16]; /* format: "d:\" */
58 QEMUWin32AIOState
*aio
;
62 * Read/writes the data to/from a given linear buffer.
64 * Returns the number of bytes handles or -errno in case of an error. Short
65 * reads are only returned if the end of the file is reached.
67 static size_t handle_aiocb_rw(RawWin32AIOData
*aiocb
)
72 for (i
= 0; i
< aiocb
->aio_niov
; i
++) {
74 DWORD ret
, ret_count
, len
;
76 memset(&ov
, 0, sizeof(ov
));
77 ov
.Offset
= (aiocb
->aio_offset
+ offset
);
78 ov
.OffsetHigh
= (aiocb
->aio_offset
+ offset
) >> 32;
79 len
= aiocb
->aio_iov
[i
].iov_len
;
80 if (aiocb
->aio_type
& QEMU_AIO_WRITE
) {
81 ret
= WriteFile(aiocb
->hfile
, aiocb
->aio_iov
[i
].iov_base
,
82 len
, &ret_count
, &ov
);
84 ret
= ReadFile(aiocb
->hfile
, aiocb
->aio_iov
[i
].iov_base
,
85 len
, &ret_count
, &ov
);
90 if (ret_count
!= len
) {
100 static int aio_worker(void *arg
)
102 RawWin32AIOData
*aiocb
= arg
;
106 switch (aiocb
->aio_type
& QEMU_AIO_TYPE_MASK
) {
108 count
= handle_aiocb_rw(aiocb
);
109 if (count
< aiocb
->aio_nbytes
) {
110 /* A short read means that we have reached EOF. Pad the buffer
111 * with zeros for bytes after EOF. */
112 iov_memset(aiocb
->aio_iov
, aiocb
->aio_niov
, count
,
113 0, aiocb
->aio_nbytes
- count
);
115 count
= aiocb
->aio_nbytes
;
117 if (count
== aiocb
->aio_nbytes
) {
124 count
= handle_aiocb_rw(aiocb
);
125 if (count
== aiocb
->aio_nbytes
) {
132 if (!FlushFileBuffers(aiocb
->hfile
)) {
137 fprintf(stderr
, "invalid aio request (0x%x)\n", aiocb
->aio_type
);
146 static BlockAIOCB
*paio_submit(BlockDriverState
*bs
, HANDLE hfile
,
147 int64_t offset
, QEMUIOVector
*qiov
, int count
,
148 BlockCompletionFunc
*cb
, void *opaque
, int type
)
150 RawWin32AIOData
*acb
= g_new(RawWin32AIOData
, 1);
155 acb
->aio_type
= type
;
158 acb
->aio_iov
= qiov
->iov
;
159 acb
->aio_niov
= qiov
->niov
;
160 assert(qiov
->size
== count
);
162 acb
->aio_nbytes
= count
;
163 acb
->aio_offset
= offset
;
165 trace_file_paio_submit(acb
, opaque
, offset
, count
, type
);
166 pool
= aio_get_thread_pool(bdrv_get_aio_context(bs
));
167 return thread_pool_submit_aio(pool
, aio_worker
, acb
, cb
, opaque
);
170 int qemu_ftruncate64(int fd
, int64_t length
)
178 if ((GetVersion() & 0x80000000UL
) && (length
>> 32) != 0)
181 h
= (HANDLE
)_get_osfhandle(fd
);
183 /* get current position, ftruncate do not change position */
185 li
.LowPart
= SetFilePointer (h
, 0, &li
.HighPart
, FILE_CURRENT
);
186 if (li
.LowPart
== INVALID_SET_FILE_POINTER
&& GetLastError() != NO_ERROR
) {
191 dw
= SetFilePointer(h
, (DWORD
) length
, &high
, FILE_BEGIN
);
192 if (dw
== INVALID_SET_FILE_POINTER
&& GetLastError() != NO_ERROR
) {
195 res
= SetEndOfFile(h
);
197 /* back to old position */
198 SetFilePointer(h
, li
.LowPart
, &li
.HighPart
, FILE_BEGIN
);
202 static int set_sparse(int fd
)
205 return (int) DeviceIoControl((HANDLE
)_get_osfhandle(fd
), FSCTL_SET_SPARSE
,
206 NULL
, 0, NULL
, 0, &returned
, NULL
);
209 static void raw_detach_aio_context(BlockDriverState
*bs
)
211 BDRVRawState
*s
= bs
->opaque
;
214 win32_aio_detach_aio_context(s
->aio
, bdrv_get_aio_context(bs
));
218 static void raw_attach_aio_context(BlockDriverState
*bs
,
219 AioContext
*new_context
)
221 BDRVRawState
*s
= bs
->opaque
;
224 win32_aio_attach_aio_context(s
->aio
, new_context
);
228 static void raw_probe_alignment(BlockDriverState
*bs
, Error
**errp
)
230 BDRVRawState
*s
= bs
->opaque
;
231 DWORD sectorsPerCluster
, freeClusters
, totalClusters
, count
;
235 if (s
->type
== FTYPE_CD
) {
236 bs
->bl
.request_alignment
= 2048;
239 if (s
->type
== FTYPE_HARDDISK
) {
240 status
= DeviceIoControl(s
->hfile
, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX
,
241 NULL
, 0, &dg
, sizeof(dg
), &count
, NULL
);
243 bs
->bl
.request_alignment
= dg
.Geometry
.BytesPerSector
;
246 /* try GetDiskFreeSpace too */
249 if (s
->drive_path
[0]) {
250 GetDiskFreeSpace(s
->drive_path
, §orsPerCluster
,
251 &dg
.Geometry
.BytesPerSector
,
252 &freeClusters
, &totalClusters
);
253 bs
->bl
.request_alignment
= dg
.Geometry
.BytesPerSector
;
257 /* XXX Does Windows support AIO on less than 512-byte alignment? */
258 bs
->bl
.request_alignment
= 512;
261 static void raw_parse_flags(int flags
, bool use_aio
, int *access_flags
,
264 assert(access_flags
!= NULL
);
265 assert(overlapped
!= NULL
);
267 if (flags
& BDRV_O_RDWR
) {
268 *access_flags
= GENERIC_READ
| GENERIC_WRITE
;
270 *access_flags
= GENERIC_READ
;
273 *overlapped
= FILE_ATTRIBUTE_NORMAL
;
275 *overlapped
|= FILE_FLAG_OVERLAPPED
;
277 if (flags
& BDRV_O_NOCACHE
) {
278 *overlapped
|= FILE_FLAG_NO_BUFFERING
;
282 static void raw_parse_filename(const char *filename
, QDict
*options
,
285 bdrv_parse_filename_strip_prefix(filename
, "file:", options
);
288 static QemuOptsList raw_runtime_opts
= {
290 .head
= QTAILQ_HEAD_INITIALIZER(raw_runtime_opts
.head
),
294 .type
= QEMU_OPT_STRING
,
295 .help
= "File name of the image",
299 .type
= QEMU_OPT_STRING
,
300 .help
= "host AIO implementation (threads, native)",
302 { /* end of list */ }
306 static bool get_aio_option(QemuOpts
*opts
, int flags
, Error
**errp
)
308 BlockdevAioOptions aio
, aio_default
;
310 aio_default
= (flags
& BDRV_O_NATIVE_AIO
) ? BLOCKDEV_AIO_OPTIONS_NATIVE
311 : BLOCKDEV_AIO_OPTIONS_THREADS
;
312 aio
= qapi_enum_parse(&BlockdevAioOptions_lookup
, qemu_opt_get(opts
, "aio"),
316 case BLOCKDEV_AIO_OPTIONS_NATIVE
:
318 case BLOCKDEV_AIO_OPTIONS_THREADS
:
321 error_setg(errp
, "Invalid AIO option");
326 static int raw_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
329 BDRVRawState
*s
= bs
->opaque
;
333 Error
*local_err
= NULL
;
334 const char *filename
;
338 s
->type
= FTYPE_FILE
;
340 opts
= qemu_opts_create(&raw_runtime_opts
, NULL
, 0, &error_abort
);
341 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
343 error_propagate(errp
, local_err
);
348 if (qdict_get_try_bool(options
, "locking", false)) {
349 error_setg(errp
, "locking=on is not supported on Windows");
354 filename
= qemu_opt_get(opts
, "filename");
356 use_aio
= get_aio_option(opts
, flags
, &local_err
);
358 error_propagate(errp
, local_err
);
363 raw_parse_flags(flags
, use_aio
, &access_flags
, &overlapped
);
365 if (filename
[0] && filename
[1] == ':') {
366 snprintf(s
->drive_path
, sizeof(s
->drive_path
), "%c:\\", filename
[0]);
367 } else if (filename
[0] == '\\' && filename
[1] == '\\') {
368 s
->drive_path
[0] = 0;
372 GetCurrentDirectory(MAX_PATH
, buf
);
373 snprintf(s
->drive_path
, sizeof(s
->drive_path
), "%c:\\", buf
[0]);
376 s
->hfile
= CreateFile(filename
, access_flags
,
377 FILE_SHARE_READ
, NULL
,
378 OPEN_EXISTING
, overlapped
, NULL
);
379 if (s
->hfile
== INVALID_HANDLE_VALUE
) {
380 int err
= GetLastError();
382 error_setg_win32(errp
, err
, "Could not open '%s'", filename
);
383 if (err
== ERROR_ACCESS_DENIED
) {
392 s
->aio
= win32_aio_init();
393 if (s
->aio
== NULL
) {
394 CloseHandle(s
->hfile
);
395 error_setg(errp
, "Could not initialize AIO");
400 ret
= win32_aio_attach(s
->aio
, s
->hfile
);
402 win32_aio_cleanup(s
->aio
);
403 CloseHandle(s
->hfile
);
404 error_setg_errno(errp
, -ret
, "Could not enable AIO");
408 win32_aio_attach_aio_context(s
->aio
, bdrv_get_aio_context(bs
));
417 static BlockAIOCB
*raw_aio_preadv(BlockDriverState
*bs
,
418 uint64_t offset
, uint64_t bytes
,
419 QEMUIOVector
*qiov
, int flags
,
420 BlockCompletionFunc
*cb
, void *opaque
)
422 BDRVRawState
*s
= bs
->opaque
;
424 return win32_aio_submit(bs
, s
->aio
, s
->hfile
, offset
, bytes
, qiov
,
425 cb
, opaque
, QEMU_AIO_READ
);
427 return paio_submit(bs
, s
->hfile
, offset
, qiov
, bytes
,
428 cb
, opaque
, QEMU_AIO_READ
);
432 static BlockAIOCB
*raw_aio_pwritev(BlockDriverState
*bs
,
433 uint64_t offset
, uint64_t bytes
,
434 QEMUIOVector
*qiov
, int flags
,
435 BlockCompletionFunc
*cb
, void *opaque
)
437 BDRVRawState
*s
= bs
->opaque
;
439 return win32_aio_submit(bs
, s
->aio
, s
->hfile
, offset
, bytes
, qiov
,
440 cb
, opaque
, QEMU_AIO_WRITE
);
442 return paio_submit(bs
, s
->hfile
, offset
, qiov
, bytes
,
443 cb
, opaque
, QEMU_AIO_WRITE
);
447 static BlockAIOCB
*raw_aio_flush(BlockDriverState
*bs
,
448 BlockCompletionFunc
*cb
, void *opaque
)
450 BDRVRawState
*s
= bs
->opaque
;
451 return paio_submit(bs
, s
->hfile
, 0, NULL
, 0, cb
, opaque
, QEMU_AIO_FLUSH
);
454 static void raw_close(BlockDriverState
*bs
)
456 BDRVRawState
*s
= bs
->opaque
;
459 win32_aio_detach_aio_context(s
->aio
, bdrv_get_aio_context(bs
));
460 win32_aio_cleanup(s
->aio
);
464 CloseHandle(s
->hfile
);
465 if (bs
->open_flags
& BDRV_O_TEMPORARY
) {
466 unlink(bs
->filename
);
470 static int coroutine_fn
raw_co_truncate(BlockDriverState
*bs
, int64_t offset
,
471 bool exact
, PreallocMode prealloc
,
474 BDRVRawState
*s
= bs
->opaque
;
478 if (prealloc
!= PREALLOC_MODE_OFF
) {
479 error_setg(errp
, "Unsupported preallocation mode '%s'",
480 PreallocMode_str(prealloc
));
488 * An error has occurred if the return value is INVALID_SET_FILE_POINTER
489 * and GetLastError doesn't return NO_ERROR.
491 dwPtrLow
= SetFilePointer(s
->hfile
, low
, &high
, FILE_BEGIN
);
492 if (dwPtrLow
== INVALID_SET_FILE_POINTER
&& GetLastError() != NO_ERROR
) {
493 error_setg_win32(errp
, GetLastError(), "SetFilePointer error");
496 if (SetEndOfFile(s
->hfile
) == 0) {
497 error_setg_win32(errp
, GetLastError(), "SetEndOfFile error");
503 static int64_t raw_getlength(BlockDriverState
*bs
)
505 BDRVRawState
*s
= bs
->opaque
;
507 ULARGE_INTEGER available
, total
, total_free
;
514 l
.LowPart
= GetFileSize(s
->hfile
, (PDWORD
)&l
.HighPart
);
515 if (l
.LowPart
== 0xffffffffUL
&& GetLastError() != NO_ERROR
)
519 if (!GetDiskFreeSpaceEx(s
->drive_path
, &available
, &total
, &total_free
))
521 l
.QuadPart
= total
.QuadPart
;
524 status
= DeviceIoControl(s
->hfile
, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX
,
525 NULL
, 0, &dg
, sizeof(dg
), &count
, NULL
);
536 static int64_t raw_get_allocated_file_size(BlockDriverState
*bs
)
538 typedef DWORD (WINAPI
* get_compressed_t
)(const char *filename
,
540 get_compressed_t get_compressed
;
542 const char *filename
= bs
->filename
;
543 /* WinNT support GetCompressedFileSize to determine allocate size */
545 (get_compressed_t
) GetProcAddress(GetModuleHandle("kernel32"),
546 "GetCompressedFileSizeA");
547 if (get_compressed
) {
549 low
= get_compressed(filename
, &high
);
550 if (low
!= 0xFFFFFFFFlu
|| GetLastError() == NO_ERROR
) {
551 return (((int64_t) high
) << 32) + low
;
555 if (_stati64(filename
, &st
) < 0) {
561 static int raw_co_create(BlockdevCreateOptions
*options
, Error
**errp
)
563 BlockdevCreateOptionsFile
*file_opts
;
566 assert(options
->driver
== BLOCKDEV_DRIVER_FILE
);
567 file_opts
= &options
->u
.file
;
569 if (file_opts
->has_preallocation
) {
570 error_setg(errp
, "Preallocation is not supported on Windows");
573 if (file_opts
->has_nocow
) {
574 error_setg(errp
, "nocow is not supported on Windows");
578 fd
= qemu_open(file_opts
->filename
, O_WRONLY
| O_CREAT
| O_TRUNC
| O_BINARY
,
581 error_setg_errno(errp
, errno
, "Could not create file");
585 ftruncate(fd
, file_opts
->size
);
591 static int coroutine_fn
raw_co_create_opts(const char *filename
, QemuOpts
*opts
,
594 BlockdevCreateOptions options
;
595 int64_t total_size
= 0;
597 strstart(filename
, "file:", &filename
);
599 /* Read out options */
600 total_size
= ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
603 options
= (BlockdevCreateOptions
) {
604 .driver
= BLOCKDEV_DRIVER_FILE
,
606 .filename
= (char *) filename
,
608 .has_preallocation
= false,
612 return raw_co_create(&options
, errp
);
615 static QemuOptsList raw_create_opts
= {
616 .name
= "raw-create-opts",
617 .head
= QTAILQ_HEAD_INITIALIZER(raw_create_opts
.head
),
620 .name
= BLOCK_OPT_SIZE
,
621 .type
= QEMU_OPT_SIZE
,
622 .help
= "Virtual disk size"
624 { /* end of list */ }
628 BlockDriver bdrv_file
= {
629 .format_name
= "file",
630 .protocol_name
= "file",
631 .instance_size
= sizeof(BDRVRawState
),
632 .bdrv_needs_filename
= true,
633 .bdrv_parse_filename
= raw_parse_filename
,
634 .bdrv_file_open
= raw_open
,
635 .bdrv_refresh_limits
= raw_probe_alignment
,
636 .bdrv_close
= raw_close
,
637 .bdrv_co_create_opts
= raw_co_create_opts
,
638 .bdrv_has_zero_init
= bdrv_has_zero_init_1
,
639 .bdrv_has_zero_init_truncate
= bdrv_has_zero_init_1
,
641 .bdrv_aio_preadv
= raw_aio_preadv
,
642 .bdrv_aio_pwritev
= raw_aio_pwritev
,
643 .bdrv_aio_flush
= raw_aio_flush
,
645 .bdrv_co_truncate
= raw_co_truncate
,
646 .bdrv_getlength
= raw_getlength
,
647 .bdrv_get_allocated_file_size
648 = raw_get_allocated_file_size
,
650 .create_opts
= &raw_create_opts
,
653 /***********************************************/
656 static int find_cdrom(char *cdrom_name
, int cdrom_name_size
)
658 char drives
[256], *pdrv
= drives
;
661 memset(drives
, 0, sizeof(drives
));
662 GetLogicalDriveStrings(sizeof(drives
), drives
);
663 while(pdrv
[0] != '\0') {
664 type
= GetDriveType(pdrv
);
667 snprintf(cdrom_name
, cdrom_name_size
, "\\\\.\\%c:", pdrv
[0]);
671 pdrv
+= lstrlen(pdrv
) + 1;
676 static int find_device_type(BlockDriverState
*bs
, const char *filename
)
678 BDRVRawState
*s
= bs
->opaque
;
682 if (strstart(filename
, "\\\\.\\", &p
) ||
683 strstart(filename
, "//./", &p
)) {
684 if (stristart(p
, "PhysicalDrive", NULL
))
685 return FTYPE_HARDDISK
;
686 snprintf(s
->drive_path
, sizeof(s
->drive_path
), "%c:\\", p
[0]);
687 type
= GetDriveType(s
->drive_path
);
689 case DRIVE_REMOVABLE
:
691 return FTYPE_HARDDISK
;
702 static int hdev_probe_device(const char *filename
)
704 if (strstart(filename
, "/dev/cdrom", NULL
))
706 if (is_windows_drive(filename
))
711 static void hdev_parse_filename(const char *filename
, QDict
*options
,
714 bdrv_parse_filename_strip_prefix(filename
, "host_device:", options
);
717 static void hdev_refresh_limits(BlockDriverState
*bs
, Error
**errp
)
719 /* XXX Does Windows support AIO on less than 512-byte alignment? */
720 bs
->bl
.request_alignment
= 512;
723 static int hdev_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
726 BDRVRawState
*s
= bs
->opaque
;
727 int access_flags
, create_flags
;
730 char device_name
[64];
732 Error
*local_err
= NULL
;
733 const char *filename
;
736 QemuOpts
*opts
= qemu_opts_create(&raw_runtime_opts
, NULL
, 0,
738 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
740 error_propagate(errp
, local_err
);
745 filename
= qemu_opt_get(opts
, "filename");
747 use_aio
= get_aio_option(opts
, flags
, &local_err
);
748 if (!local_err
&& use_aio
) {
749 error_setg(&local_err
, "AIO is not supported on Windows host devices");
752 error_propagate(errp
, local_err
);
757 if (strstart(filename
, "/dev/cdrom", NULL
)) {
758 if (find_cdrom(device_name
, sizeof(device_name
)) < 0) {
759 error_setg(errp
, "Could not open CD-ROM drive");
763 filename
= device_name
;
765 /* transform drive letters into device name */
766 if (((filename
[0] >= 'a' && filename
[0] <= 'z') ||
767 (filename
[0] >= 'A' && filename
[0] <= 'Z')) &&
768 filename
[1] == ':' && filename
[2] == '\0') {
769 snprintf(device_name
, sizeof(device_name
), "\\\\.\\%c:", filename
[0]);
770 filename
= device_name
;
773 s
->type
= find_device_type(bs
, filename
);
775 raw_parse_flags(flags
, use_aio
, &access_flags
, &overlapped
);
777 create_flags
= OPEN_EXISTING
;
779 s
->hfile
= CreateFile(filename
, access_flags
,
780 FILE_SHARE_READ
, NULL
,
781 create_flags
, overlapped
, NULL
);
782 if (s
->hfile
== INVALID_HANDLE_VALUE
) {
783 int err
= GetLastError();
785 if (err
== ERROR_ACCESS_DENIED
) {
790 error_setg_errno(errp
, -ret
, "Could not open device");
799 static BlockDriver bdrv_host_device
= {
800 .format_name
= "host_device",
801 .protocol_name
= "host_device",
802 .instance_size
= sizeof(BDRVRawState
),
803 .bdrv_needs_filename
= true,
804 .bdrv_parse_filename
= hdev_parse_filename
,
805 .bdrv_probe_device
= hdev_probe_device
,
806 .bdrv_file_open
= hdev_open
,
807 .bdrv_close
= raw_close
,
808 .bdrv_refresh_limits
= hdev_refresh_limits
,
810 .bdrv_aio_preadv
= raw_aio_preadv
,
811 .bdrv_aio_pwritev
= raw_aio_pwritev
,
812 .bdrv_aio_flush
= raw_aio_flush
,
814 .bdrv_detach_aio_context
= raw_detach_aio_context
,
815 .bdrv_attach_aio_context
= raw_attach_aio_context
,
817 .bdrv_getlength
= raw_getlength
,
818 .has_variable_length
= true,
820 .bdrv_get_allocated_file_size
821 = raw_get_allocated_file_size
,
824 static void bdrv_file_init(void)
826 bdrv_register(&bdrv_file
);
827 bdrv_register(&bdrv_host_device
);
830 block_init(bdrv_file_init
);