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
24 #include "qemu/osdep.h"
25 #include "qapi/error.h"
26 #include "qemu/cutils.h"
27 #include "qemu/timer.h"
28 #include "block/block_int.h"
29 #include "qemu/module.h"
30 #include "block/raw-aio.h"
32 #include "block/thread-pool.h"
34 #include "qapi/qmp/qstring.h"
35 #include "qapi/util.h"
41 #define FTYPE_HARDDISK 2
43 typedef struct RawWin32AIOData {
46 struct iovec *aio_iov;
53 typedef struct BDRVRawState {
56 char drive_path[16]; /* format: "d:\" */
57 QEMUWin32AIOState *aio;
61 * Read/writes the data to/from a given linear buffer.
63 * Returns the number of bytes handles or -errno in case of an error. Short
64 * reads are only returned if the end of the file is reached.
66 static size_t handle_aiocb_rw(RawWin32AIOData *aiocb)
71 for (i = 0; i < aiocb->aio_niov; i++) {
73 DWORD ret, ret_count, len;
75 memset(&ov, 0, sizeof(ov));
76 ov.Offset = (aiocb->aio_offset + offset);
77 ov.OffsetHigh = (aiocb->aio_offset + offset) >> 32;
78 len = aiocb->aio_iov[i].iov_len;
79 if (aiocb->aio_type & QEMU_AIO_WRITE) {
80 ret = WriteFile(aiocb->hfile, aiocb->aio_iov[i].iov_base,
81 len, &ret_count, &ov);
83 ret = ReadFile(aiocb->hfile, aiocb->aio_iov[i].iov_base,
84 len, &ret_count, &ov);
89 if (ret_count != len) {
99 static int aio_worker(void *arg)
101 RawWin32AIOData *aiocb = arg;
105 switch (aiocb->aio_type & QEMU_AIO_TYPE_MASK) {
107 count = handle_aiocb_rw(aiocb);
108 if (count < aiocb->aio_nbytes) {
109 /* A short read means that we have reached EOF. Pad the buffer
110 * with zeros for bytes after EOF. */
111 iov_memset(aiocb->aio_iov, aiocb->aio_niov, count,
112 0, aiocb->aio_nbytes - count);
114 count = aiocb->aio_nbytes;
116 if (count == aiocb->aio_nbytes) {
123 count = handle_aiocb_rw(aiocb);
124 if (count == aiocb->aio_nbytes) {
131 if (!FlushFileBuffers(aiocb->hfile)) {
136 fprintf(stderr, "invalid aio request (0x%x)\n", aiocb->aio_type);
145 static BlockAIOCB *paio_submit(BlockDriverState *bs, HANDLE hfile,
146 int64_t offset, QEMUIOVector *qiov, int count,
147 BlockCompletionFunc *cb, void *opaque, int type)
149 RawWin32AIOData *acb = g_new(RawWin32AIOData, 1);
154 acb->aio_type = type;
157 acb->aio_iov = qiov->iov;
158 acb->aio_niov = qiov->niov;
159 assert(qiov->size == count);
161 acb->aio_nbytes = count;
162 acb->aio_offset = offset;
164 trace_paio_submit(acb, opaque, offset, count, type);
165 pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
166 return thread_pool_submit_aio(pool, aio_worker, acb, cb, opaque);
169 int qemu_ftruncate64(int fd, int64_t length)
177 if ((GetVersion() & 0x80000000UL) && (length >> 32) != 0)
180 h = (HANDLE)_get_osfhandle(fd);
182 /* get current position, ftruncate do not change position */
184 li.LowPart = SetFilePointer (h, 0, &li.HighPart, FILE_CURRENT);
185 if (li.LowPart == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
190 dw = SetFilePointer(h, (DWORD) length, &high, FILE_BEGIN);
191 if (dw == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
194 res = SetEndOfFile(h);
196 /* back to old position */
197 SetFilePointer(h, li.LowPart, &li.HighPart, FILE_BEGIN);
201 static int set_sparse(int fd)
204 return (int) DeviceIoControl((HANDLE)_get_osfhandle(fd), FSCTL_SET_SPARSE,
205 NULL, 0, NULL, 0, &returned, NULL);
208 static void raw_detach_aio_context(BlockDriverState *bs)
210 BDRVRawState *s = bs->opaque;
213 win32_aio_detach_aio_context(s->aio, bdrv_get_aio_context(bs));
217 static void raw_attach_aio_context(BlockDriverState *bs,
218 AioContext *new_context)
220 BDRVRawState *s = bs->opaque;
223 win32_aio_attach_aio_context(s->aio, new_context);
227 static void raw_probe_alignment(BlockDriverState *bs, Error **errp)
229 BDRVRawState *s = bs->opaque;
230 DWORD sectorsPerCluster, freeClusters, totalClusters, count;
234 if (s->type == FTYPE_CD) {
235 bs->bl.request_alignment = 2048;
238 if (s->type == FTYPE_HARDDISK) {
239 status = DeviceIoControl(s->hfile, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX,
240 NULL, 0, &dg, sizeof(dg), &count, NULL);
242 bs->bl.request_alignment = dg.Geometry.BytesPerSector;
245 /* try GetDiskFreeSpace too */
248 if (s->drive_path[0]) {
249 GetDiskFreeSpace(s->drive_path, §orsPerCluster,
250 &dg.Geometry.BytesPerSector,
251 &freeClusters, &totalClusters);
252 bs->bl.request_alignment = dg.Geometry.BytesPerSector;
256 static void raw_parse_flags(int flags, bool use_aio, int *access_flags,
259 assert(access_flags != NULL);
260 assert(overlapped != NULL);
262 if (flags & BDRV_O_RDWR) {
263 *access_flags = GENERIC_READ | GENERIC_WRITE;
265 *access_flags = GENERIC_READ;
268 *overlapped = FILE_ATTRIBUTE_NORMAL;
270 *overlapped |= FILE_FLAG_OVERLAPPED;
272 if (flags & BDRV_O_NOCACHE) {
273 *overlapped |= FILE_FLAG_NO_BUFFERING;
277 static void raw_parse_filename(const char *filename, QDict *options,
280 /* The filename does not have to be prefixed by the protocol name, since
281 * "file" is the default protocol; therefore, the return value of this
282 * function call can be ignored. */
283 strstart(filename, "file:", &filename);
285 qdict_put_obj(options, "filename", QOBJECT(qstring_from_str(filename)));
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"),
313 BLOCKDEV_AIO_OPTIONS__MAX, aio_default, errp);
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 filename = qemu_opt_get(opts, "filename");
350 use_aio = get_aio_option(opts, flags, &local_err);
352 error_propagate(errp, local_err);
357 raw_parse_flags(flags, use_aio, &access_flags, &overlapped);
359 if (filename[0] && filename[1] == ':') {
360 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", filename[0]);
361 } else if (filename[0] == '\\' && filename[1] == '\\') {
362 s->drive_path[0] = 0;
366 GetCurrentDirectory(MAX_PATH, buf);
367 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", buf[0]);
370 s->hfile = CreateFile(filename, access_flags,
371 FILE_SHARE_READ, NULL,
372 OPEN_EXISTING, overlapped, NULL);
373 if (s->hfile == INVALID_HANDLE_VALUE) {
374 int err = GetLastError();
376 if (err == ERROR_ACCESS_DENIED) {
385 s->aio = win32_aio_init();
386 if (s->aio == NULL) {
387 CloseHandle(s->hfile);
388 error_setg(errp, "Could not initialize AIO");
393 ret = win32_aio_attach(s->aio, s->hfile);
395 win32_aio_cleanup(s->aio);
396 CloseHandle(s->hfile);
397 error_setg_errno(errp, -ret, "Could not enable AIO");
401 win32_aio_attach_aio_context(s->aio, bdrv_get_aio_context(bs));
410 static BlockAIOCB *raw_aio_readv(BlockDriverState *bs,
411 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
412 BlockCompletionFunc *cb, void *opaque)
414 BDRVRawState *s = bs->opaque;
416 return win32_aio_submit(bs, s->aio, s->hfile, sector_num, qiov,
417 nb_sectors, cb, opaque, QEMU_AIO_READ);
419 return paio_submit(bs, s->hfile, sector_num << BDRV_SECTOR_BITS, qiov,
420 nb_sectors << BDRV_SECTOR_BITS,
421 cb, opaque, QEMU_AIO_READ);
425 static BlockAIOCB *raw_aio_writev(BlockDriverState *bs,
426 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
427 BlockCompletionFunc *cb, void *opaque)
429 BDRVRawState *s = bs->opaque;
431 return win32_aio_submit(bs, s->aio, s->hfile, sector_num, qiov,
432 nb_sectors, cb, opaque, QEMU_AIO_WRITE);
434 return paio_submit(bs, s->hfile, sector_num << BDRV_SECTOR_BITS, qiov,
435 nb_sectors << BDRV_SECTOR_BITS,
436 cb, opaque, QEMU_AIO_WRITE);
440 static BlockAIOCB *raw_aio_flush(BlockDriverState *bs,
441 BlockCompletionFunc *cb, void *opaque)
443 BDRVRawState *s = bs->opaque;
444 return paio_submit(bs, s->hfile, 0, NULL, 0, cb, opaque, QEMU_AIO_FLUSH);
447 static void raw_close(BlockDriverState *bs)
449 BDRVRawState *s = bs->opaque;
452 win32_aio_detach_aio_context(s->aio, bdrv_get_aio_context(bs));
453 win32_aio_cleanup(s->aio);
457 CloseHandle(s->hfile);
458 if (bs->open_flags & BDRV_O_TEMPORARY) {
459 unlink(bs->filename);
463 static int raw_truncate(BlockDriverState *bs, int64_t offset)
465 BDRVRawState *s = bs->opaque;
473 * An error has occurred if the return value is INVALID_SET_FILE_POINTER
474 * and GetLastError doesn't return NO_ERROR.
476 dwPtrLow = SetFilePointer(s->hfile, low, &high, FILE_BEGIN);
477 if (dwPtrLow == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
478 fprintf(stderr, "SetFilePointer error: %lu\n", GetLastError());
481 if (SetEndOfFile(s->hfile) == 0) {
482 fprintf(stderr, "SetEndOfFile error: %lu\n", GetLastError());
488 static int64_t raw_getlength(BlockDriverState *bs)
490 BDRVRawState *s = bs->opaque;
492 ULARGE_INTEGER available, total, total_free;
499 l.LowPart = GetFileSize(s->hfile, (PDWORD)&l.HighPart);
500 if (l.LowPart == 0xffffffffUL && GetLastError() != NO_ERROR)
504 if (!GetDiskFreeSpaceEx(s->drive_path, &available, &total, &total_free))
506 l.QuadPart = total.QuadPart;
509 status = DeviceIoControl(s->hfile, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX,
510 NULL, 0, &dg, sizeof(dg), &count, NULL);
521 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
523 typedef DWORD (WINAPI * get_compressed_t)(const char *filename,
525 get_compressed_t get_compressed;
527 const char *filename = bs->filename;
528 /* WinNT support GetCompressedFileSize to determine allocate size */
530 (get_compressed_t) GetProcAddress(GetModuleHandle("kernel32"),
531 "GetCompressedFileSizeA");
532 if (get_compressed) {
534 low = get_compressed(filename, &high);
535 if (low != 0xFFFFFFFFlu || GetLastError() == NO_ERROR) {
536 return (((int64_t) high) << 32) + low;
540 if (_stati64(filename, &st) < 0) {
546 static int raw_create(const char *filename, QemuOpts *opts, Error **errp)
549 int64_t total_size = 0;
551 strstart(filename, "file:", &filename);
553 /* Read out options */
554 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
557 fd = qemu_open(filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY,
560 error_setg_errno(errp, errno, "Could not create file");
564 ftruncate(fd, total_size);
570 static QemuOptsList raw_create_opts = {
571 .name = "raw-create-opts",
572 .head = QTAILQ_HEAD_INITIALIZER(raw_create_opts.head),
575 .name = BLOCK_OPT_SIZE,
576 .type = QEMU_OPT_SIZE,
577 .help = "Virtual disk size"
579 { /* end of list */ }
583 BlockDriver bdrv_file = {
584 .format_name = "file",
585 .protocol_name = "file",
586 .instance_size = sizeof(BDRVRawState),
587 .bdrv_needs_filename = true,
588 .bdrv_parse_filename = raw_parse_filename,
589 .bdrv_file_open = raw_open,
590 .bdrv_refresh_limits = raw_probe_alignment,
591 .bdrv_close = raw_close,
592 .bdrv_create = raw_create,
593 .bdrv_has_zero_init = bdrv_has_zero_init_1,
595 .bdrv_aio_readv = raw_aio_readv,
596 .bdrv_aio_writev = raw_aio_writev,
597 .bdrv_aio_flush = raw_aio_flush,
599 .bdrv_truncate = raw_truncate,
600 .bdrv_getlength = raw_getlength,
601 .bdrv_get_allocated_file_size
602 = raw_get_allocated_file_size,
604 .create_opts = &raw_create_opts,
607 /***********************************************/
610 static int find_cdrom(char *cdrom_name, int cdrom_name_size)
612 char drives[256], *pdrv = drives;
615 memset(drives, 0, sizeof(drives));
616 GetLogicalDriveStrings(sizeof(drives), drives);
617 while(pdrv[0] != '\0') {
618 type = GetDriveType(pdrv);
621 snprintf(cdrom_name, cdrom_name_size, "\\\\.\\%c:", pdrv[0]);
625 pdrv += lstrlen(pdrv) + 1;
630 static int find_device_type(BlockDriverState *bs, const char *filename)
632 BDRVRawState *s = bs->opaque;
636 if (strstart(filename, "\\\\.\\", &p) ||
637 strstart(filename, "//./", &p)) {
638 if (stristart(p, "PhysicalDrive", NULL))
639 return FTYPE_HARDDISK;
640 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", p[0]);
641 type = GetDriveType(s->drive_path);
643 case DRIVE_REMOVABLE:
645 return FTYPE_HARDDISK;
656 static int hdev_probe_device(const char *filename)
658 if (strstart(filename, "/dev/cdrom", NULL))
660 if (is_windows_drive(filename))
665 static void hdev_parse_filename(const char *filename, QDict *options,
668 /* The prefix is optional, just as for "file". */
669 strstart(filename, "host_device:", &filename);
671 qdict_put_obj(options, "filename", QOBJECT(qstring_from_str(filename)));
674 static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
677 BDRVRawState *s = bs->opaque;
678 int access_flags, create_flags;
681 char device_name[64];
683 Error *local_err = NULL;
684 const char *filename;
687 QemuOpts *opts = qemu_opts_create(&raw_runtime_opts, NULL, 0,
689 qemu_opts_absorb_qdict(opts, options, &local_err);
691 error_propagate(errp, local_err);
696 filename = qemu_opt_get(opts, "filename");
698 use_aio = get_aio_option(opts, flags, &local_err);
699 if (!local_err && use_aio) {
700 error_setg(&local_err, "AIO is not supported on Windows host devices");
703 error_propagate(errp, local_err);
708 if (strstart(filename, "/dev/cdrom", NULL)) {
709 if (find_cdrom(device_name, sizeof(device_name)) < 0) {
710 error_setg(errp, "Could not open CD-ROM drive");
714 filename = device_name;
716 /* transform drive letters into device name */
717 if (((filename[0] >= 'a' && filename[0] <= 'z') ||
718 (filename[0] >= 'A' && filename[0] <= 'Z')) &&
719 filename[1] == ':' && filename[2] == '\0') {
720 snprintf(device_name, sizeof(device_name), "\\\\.\\%c:", filename[0]);
721 filename = device_name;
724 s->type = find_device_type(bs, filename);
726 raw_parse_flags(flags, use_aio, &access_flags, &overlapped);
728 create_flags = OPEN_EXISTING;
730 s->hfile = CreateFile(filename, access_flags,
731 FILE_SHARE_READ, NULL,
732 create_flags, overlapped, NULL);
733 if (s->hfile == INVALID_HANDLE_VALUE) {
734 int err = GetLastError();
736 if (err == ERROR_ACCESS_DENIED) {
741 error_setg_errno(errp, -ret, "Could not open device");
750 static BlockDriver bdrv_host_device = {
751 .format_name = "host_device",
752 .protocol_name = "host_device",
753 .instance_size = sizeof(BDRVRawState),
754 .bdrv_needs_filename = true,
755 .bdrv_parse_filename = hdev_parse_filename,
756 .bdrv_probe_device = hdev_probe_device,
757 .bdrv_file_open = hdev_open,
758 .bdrv_close = raw_close,
760 .bdrv_aio_readv = raw_aio_readv,
761 .bdrv_aio_writev = raw_aio_writev,
762 .bdrv_aio_flush = raw_aio_flush,
764 .bdrv_detach_aio_context = raw_detach_aio_context,
765 .bdrv_attach_aio_context = raw_attach_aio_context,
767 .bdrv_getlength = raw_getlength,
768 .has_variable_length = true,
770 .bdrv_get_allocated_file_size
771 = raw_get_allocated_file_size,
774 static void bdrv_file_init(void)
776 bdrv_register(&bdrv_file);
777 bdrv_register(&bdrv_host_device);
780 block_init(bdrv_file_init);