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_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 static void raw_parse_flags(int flags, bool use_aio, int *access_flags,
260 assert(access_flags != NULL);
261 assert(overlapped != NULL);
263 if (flags & BDRV_O_RDWR) {
264 *access_flags = GENERIC_READ | GENERIC_WRITE;
266 *access_flags = GENERIC_READ;
269 *overlapped = FILE_ATTRIBUTE_NORMAL;
271 *overlapped |= FILE_FLAG_OVERLAPPED;
273 if (flags & BDRV_O_NOCACHE) {
274 *overlapped |= FILE_FLAG_NO_BUFFERING;
278 static void raw_parse_filename(const char *filename, QDict *options,
281 bdrv_parse_filename_strip_prefix(filename, "file:", options);
284 static QemuOptsList raw_runtime_opts = {
286 .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
290 .type = QEMU_OPT_STRING,
291 .help = "File name of the image",
295 .type = QEMU_OPT_STRING,
296 .help = "host AIO implementation (threads, native)",
298 { /* end of list */ }
302 static bool get_aio_option(QemuOpts *opts, int flags, Error **errp)
304 BlockdevAioOptions aio, aio_default;
306 aio_default = (flags & BDRV_O_NATIVE_AIO) ? BLOCKDEV_AIO_OPTIONS_NATIVE
307 : BLOCKDEV_AIO_OPTIONS_THREADS;
308 aio = qapi_enum_parse(&BlockdevAioOptions_lookup, qemu_opt_get(opts, "aio"),
312 case BLOCKDEV_AIO_OPTIONS_NATIVE:
314 case BLOCKDEV_AIO_OPTIONS_THREADS:
317 error_setg(errp, "Invalid AIO option");
322 static int raw_open(BlockDriverState *bs, QDict *options, int flags,
325 BDRVRawState *s = bs->opaque;
329 Error *local_err = NULL;
330 const char *filename;
334 s->type = FTYPE_FILE;
336 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
337 qemu_opts_absorb_qdict(opts, options, &local_err);
339 error_propagate(errp, local_err);
344 if (qdict_get_try_bool(options, "locking", false)) {
345 error_setg(errp, "locking=on is not supported on Windows");
350 filename = qemu_opt_get(opts, "filename");
352 use_aio = get_aio_option(opts, flags, &local_err);
354 error_propagate(errp, local_err);
359 raw_parse_flags(flags, use_aio, &access_flags, &overlapped);
361 if (filename[0] && filename[1] == ':') {
362 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", filename[0]);
363 } else if (filename[0] == '\\' && filename[1] == '\\') {
364 s->drive_path[0] = 0;
368 GetCurrentDirectory(MAX_PATH, buf);
369 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", buf[0]);
372 s->hfile = CreateFile(filename, access_flags,
373 FILE_SHARE_READ, NULL,
374 OPEN_EXISTING, overlapped, NULL);
375 if (s->hfile == INVALID_HANDLE_VALUE) {
376 int err = GetLastError();
378 error_setg_win32(errp, err, "Could not open '%s'", filename);
379 if (err == ERROR_ACCESS_DENIED) {
388 s->aio = win32_aio_init();
389 if (s->aio == NULL) {
390 CloseHandle(s->hfile);
391 error_setg(errp, "Could not initialize AIO");
396 ret = win32_aio_attach(s->aio, s->hfile);
398 win32_aio_cleanup(s->aio);
399 CloseHandle(s->hfile);
400 error_setg_errno(errp, -ret, "Could not enable AIO");
404 win32_aio_attach_aio_context(s->aio, bdrv_get_aio_context(bs));
413 static BlockAIOCB *raw_aio_readv(BlockDriverState *bs,
414 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
415 BlockCompletionFunc *cb, void *opaque)
417 BDRVRawState *s = bs->opaque;
419 return win32_aio_submit(bs, s->aio, s->hfile, sector_num, qiov,
420 nb_sectors, cb, opaque, QEMU_AIO_READ);
422 return paio_submit(bs, s->hfile, sector_num << BDRV_SECTOR_BITS, qiov,
423 nb_sectors << BDRV_SECTOR_BITS,
424 cb, opaque, QEMU_AIO_READ);
428 static BlockAIOCB *raw_aio_writev(BlockDriverState *bs,
429 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
430 BlockCompletionFunc *cb, void *opaque)
432 BDRVRawState *s = bs->opaque;
434 return win32_aio_submit(bs, s->aio, s->hfile, sector_num, qiov,
435 nb_sectors, cb, opaque, QEMU_AIO_WRITE);
437 return paio_submit(bs, s->hfile, sector_num << BDRV_SECTOR_BITS, qiov,
438 nb_sectors << BDRV_SECTOR_BITS,
439 cb, opaque, QEMU_AIO_WRITE);
443 static BlockAIOCB *raw_aio_flush(BlockDriverState *bs,
444 BlockCompletionFunc *cb, void *opaque)
446 BDRVRawState *s = bs->opaque;
447 return paio_submit(bs, s->hfile, 0, NULL, 0, cb, opaque, QEMU_AIO_FLUSH);
450 static void raw_close(BlockDriverState *bs)
452 BDRVRawState *s = bs->opaque;
455 win32_aio_detach_aio_context(s->aio, bdrv_get_aio_context(bs));
456 win32_aio_cleanup(s->aio);
460 CloseHandle(s->hfile);
461 if (bs->open_flags & BDRV_O_TEMPORARY) {
462 unlink(bs->filename);
466 static int raw_truncate(BlockDriverState *bs, int64_t offset,
467 PreallocMode prealloc, Error **errp)
469 BDRVRawState *s = bs->opaque;
473 if (prealloc != PREALLOC_MODE_OFF) {
474 error_setg(errp, "Unsupported preallocation mode '%s'",
475 PreallocMode_str(prealloc));
483 * An error has occurred if the return value is INVALID_SET_FILE_POINTER
484 * and GetLastError doesn't return NO_ERROR.
486 dwPtrLow = SetFilePointer(s->hfile, low, &high, FILE_BEGIN);
487 if (dwPtrLow == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
488 error_setg_win32(errp, GetLastError(), "SetFilePointer error");
491 if (SetEndOfFile(s->hfile) == 0) {
492 error_setg_win32(errp, GetLastError(), "SetEndOfFile error");
498 static int64_t raw_getlength(BlockDriverState *bs)
500 BDRVRawState *s = bs->opaque;
502 ULARGE_INTEGER available, total, total_free;
509 l.LowPart = GetFileSize(s->hfile, (PDWORD)&l.HighPart);
510 if (l.LowPart == 0xffffffffUL && GetLastError() != NO_ERROR)
514 if (!GetDiskFreeSpaceEx(s->drive_path, &available, &total, &total_free))
516 l.QuadPart = total.QuadPart;
519 status = DeviceIoControl(s->hfile, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX,
520 NULL, 0, &dg, sizeof(dg), &count, NULL);
531 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
533 typedef DWORD (WINAPI * get_compressed_t)(const char *filename,
535 get_compressed_t get_compressed;
537 const char *filename = bs->filename;
538 /* WinNT support GetCompressedFileSize to determine allocate size */
540 (get_compressed_t) GetProcAddress(GetModuleHandle("kernel32"),
541 "GetCompressedFileSizeA");
542 if (get_compressed) {
544 low = get_compressed(filename, &high);
545 if (low != 0xFFFFFFFFlu || GetLastError() == NO_ERROR) {
546 return (((int64_t) high) << 32) + low;
550 if (_stati64(filename, &st) < 0) {
556 static int raw_co_create(BlockdevCreateOptions *options, Error **errp)
558 BlockdevCreateOptionsFile *file_opts;
561 assert(options->driver == BLOCKDEV_DRIVER_FILE);
562 file_opts = &options->u.file;
564 if (file_opts->has_preallocation) {
565 error_setg(errp, "Preallocation is not supported on Windows");
568 if (file_opts->has_nocow) {
569 error_setg(errp, "nocow is not supported on Windows");
573 fd = qemu_open(file_opts->filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY,
576 error_setg_errno(errp, errno, "Could not create file");
580 ftruncate(fd, file_opts->size);
586 static int coroutine_fn raw_co_create_opts(const char *filename, QemuOpts *opts,
589 BlockdevCreateOptions options;
590 int64_t total_size = 0;
592 strstart(filename, "file:", &filename);
594 /* Read out options */
595 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
598 options = (BlockdevCreateOptions) {
599 .driver = BLOCKDEV_DRIVER_FILE,
601 .filename = (char *) filename,
603 .has_preallocation = false,
607 return raw_co_create(&options, errp);
610 static QemuOptsList raw_create_opts = {
611 .name = "raw-create-opts",
612 .head = QTAILQ_HEAD_INITIALIZER(raw_create_opts.head),
615 .name = BLOCK_OPT_SIZE,
616 .type = QEMU_OPT_SIZE,
617 .help = "Virtual disk size"
619 { /* end of list */ }
623 BlockDriver bdrv_file = {
624 .format_name = "file",
625 .protocol_name = "file",
626 .instance_size = sizeof(BDRVRawState),
627 .bdrv_needs_filename = true,
628 .bdrv_parse_filename = raw_parse_filename,
629 .bdrv_file_open = raw_open,
630 .bdrv_refresh_limits = raw_probe_alignment,
631 .bdrv_close = raw_close,
632 .bdrv_co_create_opts = raw_co_create_opts,
633 .bdrv_has_zero_init = bdrv_has_zero_init_1,
635 .bdrv_aio_readv = raw_aio_readv,
636 .bdrv_aio_writev = raw_aio_writev,
637 .bdrv_aio_flush = raw_aio_flush,
639 .bdrv_truncate = raw_truncate,
640 .bdrv_getlength = raw_getlength,
641 .bdrv_get_allocated_file_size
642 = raw_get_allocated_file_size,
644 .create_opts = &raw_create_opts,
647 /***********************************************/
650 static int find_cdrom(char *cdrom_name, int cdrom_name_size)
652 char drives[256], *pdrv = drives;
655 memset(drives, 0, sizeof(drives));
656 GetLogicalDriveStrings(sizeof(drives), drives);
657 while(pdrv[0] != '\0') {
658 type = GetDriveType(pdrv);
661 snprintf(cdrom_name, cdrom_name_size, "\\\\.\\%c:", pdrv[0]);
665 pdrv += lstrlen(pdrv) + 1;
670 static int find_device_type(BlockDriverState *bs, const char *filename)
672 BDRVRawState *s = bs->opaque;
676 if (strstart(filename, "\\\\.\\", &p) ||
677 strstart(filename, "//./", &p)) {
678 if (stristart(p, "PhysicalDrive", NULL))
679 return FTYPE_HARDDISK;
680 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", p[0]);
681 type = GetDriveType(s->drive_path);
683 case DRIVE_REMOVABLE:
685 return FTYPE_HARDDISK;
696 static int hdev_probe_device(const char *filename)
698 if (strstart(filename, "/dev/cdrom", NULL))
700 if (is_windows_drive(filename))
705 static void hdev_parse_filename(const char *filename, QDict *options,
708 bdrv_parse_filename_strip_prefix(filename, "host_device:", options);
711 static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
714 BDRVRawState *s = bs->opaque;
715 int access_flags, create_flags;
718 char device_name[64];
720 Error *local_err = NULL;
721 const char *filename;
724 QemuOpts *opts = qemu_opts_create(&raw_runtime_opts, NULL, 0,
726 qemu_opts_absorb_qdict(opts, options, &local_err);
728 error_propagate(errp, local_err);
733 filename = qemu_opt_get(opts, "filename");
735 use_aio = get_aio_option(opts, flags, &local_err);
736 if (!local_err && use_aio) {
737 error_setg(&local_err, "AIO is not supported on Windows host devices");
740 error_propagate(errp, local_err);
745 if (strstart(filename, "/dev/cdrom", NULL)) {
746 if (find_cdrom(device_name, sizeof(device_name)) < 0) {
747 error_setg(errp, "Could not open CD-ROM drive");
751 filename = device_name;
753 /* transform drive letters into device name */
754 if (((filename[0] >= 'a' && filename[0] <= 'z') ||
755 (filename[0] >= 'A' && filename[0] <= 'Z')) &&
756 filename[1] == ':' && filename[2] == '\0') {
757 snprintf(device_name, sizeof(device_name), "\\\\.\\%c:", filename[0]);
758 filename = device_name;
761 s->type = find_device_type(bs, filename);
763 raw_parse_flags(flags, use_aio, &access_flags, &overlapped);
765 create_flags = OPEN_EXISTING;
767 s->hfile = CreateFile(filename, access_flags,
768 FILE_SHARE_READ, NULL,
769 create_flags, overlapped, NULL);
770 if (s->hfile == INVALID_HANDLE_VALUE) {
771 int err = GetLastError();
773 if (err == ERROR_ACCESS_DENIED) {
778 error_setg_errno(errp, -ret, "Could not open device");
787 static BlockDriver bdrv_host_device = {
788 .format_name = "host_device",
789 .protocol_name = "host_device",
790 .instance_size = sizeof(BDRVRawState),
791 .bdrv_needs_filename = true,
792 .bdrv_parse_filename = hdev_parse_filename,
793 .bdrv_probe_device = hdev_probe_device,
794 .bdrv_file_open = hdev_open,
795 .bdrv_close = raw_close,
797 .bdrv_aio_readv = raw_aio_readv,
798 .bdrv_aio_writev = raw_aio_writev,
799 .bdrv_aio_flush = raw_aio_flush,
801 .bdrv_detach_aio_context = raw_detach_aio_context,
802 .bdrv_attach_aio_context = raw_attach_aio_context,
804 .bdrv_getlength = raw_getlength,
805 .has_variable_length = true,
807 .bdrv_get_allocated_file_size
808 = raw_get_allocated_file_size,
811 static void bdrv_file_init(void)
813 bdrv_register(&bdrv_file);
814 bdrv_register(&bdrv_host_device);
817 block_init(bdrv_file_init);