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"
40 #define FTYPE_HARDDISK 2
42 typedef struct RawWin32AIOData {
45 struct iovec *aio_iov;
52 typedef struct BDRVRawState {
55 char drive_path[16]; /* format: "d:\" */
56 QEMUWin32AIOState *aio;
60 * Read/writes the data to/from a given linear buffer.
62 * Returns the number of bytes handles or -errno in case of an error. Short
63 * reads are only returned if the end of the file is reached.
65 static size_t handle_aiocb_rw(RawWin32AIOData *aiocb)
70 for (i = 0; i < aiocb->aio_niov; i++) {
72 DWORD ret, ret_count, len;
74 memset(&ov, 0, sizeof(ov));
75 ov.Offset = (aiocb->aio_offset + offset);
76 ov.OffsetHigh = (aiocb->aio_offset + offset) >> 32;
77 len = aiocb->aio_iov[i].iov_len;
78 if (aiocb->aio_type & QEMU_AIO_WRITE) {
79 ret = WriteFile(aiocb->hfile, aiocb->aio_iov[i].iov_base,
80 len, &ret_count, &ov);
82 ret = ReadFile(aiocb->hfile, aiocb->aio_iov[i].iov_base,
83 len, &ret_count, &ov);
88 if (ret_count != len) {
98 static int aio_worker(void *arg)
100 RawWin32AIOData *aiocb = arg;
104 switch (aiocb->aio_type & QEMU_AIO_TYPE_MASK) {
106 count = handle_aiocb_rw(aiocb);
107 if (count < aiocb->aio_nbytes) {
108 /* A short read means that we have reached EOF. Pad the buffer
109 * with zeros for bytes after EOF. */
110 iov_memset(aiocb->aio_iov, aiocb->aio_niov, count,
111 0, aiocb->aio_nbytes - count);
113 count = aiocb->aio_nbytes;
115 if (count == aiocb->aio_nbytes) {
122 count = handle_aiocb_rw(aiocb);
123 if (count == aiocb->aio_nbytes) {
130 if (!FlushFileBuffers(aiocb->hfile)) {
135 fprintf(stderr, "invalid aio request (0x%x)\n", aiocb->aio_type);
144 static BlockAIOCB *paio_submit(BlockDriverState *bs, HANDLE hfile,
145 int64_t offset, QEMUIOVector *qiov, int count,
146 BlockCompletionFunc *cb, void *opaque, int type)
148 RawWin32AIOData *acb = g_new(RawWin32AIOData, 1);
153 acb->aio_type = type;
156 acb->aio_iov = qiov->iov;
157 acb->aio_niov = qiov->niov;
158 assert(qiov->size == count);
160 acb->aio_nbytes = count;
161 acb->aio_offset = offset;
163 trace_paio_submit(acb, opaque, offset, count, type);
164 pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
165 return thread_pool_submit_aio(pool, aio_worker, acb, cb, opaque);
168 int qemu_ftruncate64(int fd, int64_t length)
176 if ((GetVersion() & 0x80000000UL) && (length >> 32) != 0)
179 h = (HANDLE)_get_osfhandle(fd);
181 /* get current position, ftruncate do not change position */
183 li.LowPart = SetFilePointer (h, 0, &li.HighPart, FILE_CURRENT);
184 if (li.LowPart == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
189 dw = SetFilePointer(h, (DWORD) length, &high, FILE_BEGIN);
190 if (dw == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
193 res = SetEndOfFile(h);
195 /* back to old position */
196 SetFilePointer(h, li.LowPart, &li.HighPart, FILE_BEGIN);
200 static int set_sparse(int fd)
203 return (int) DeviceIoControl((HANDLE)_get_osfhandle(fd), FSCTL_SET_SPARSE,
204 NULL, 0, NULL, 0, &returned, NULL);
207 static void raw_detach_aio_context(BlockDriverState *bs)
209 BDRVRawState *s = bs->opaque;
212 win32_aio_detach_aio_context(s->aio, bdrv_get_aio_context(bs));
216 static void raw_attach_aio_context(BlockDriverState *bs,
217 AioContext *new_context)
219 BDRVRawState *s = bs->opaque;
222 win32_aio_attach_aio_context(s->aio, new_context);
226 static void raw_probe_alignment(BlockDriverState *bs, Error **errp)
228 BDRVRawState *s = bs->opaque;
229 DWORD sectorsPerCluster, freeClusters, totalClusters, count;
233 if (s->type == FTYPE_CD) {
234 bs->bl.request_alignment = 2048;
237 if (s->type == FTYPE_HARDDISK) {
238 status = DeviceIoControl(s->hfile, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX,
239 NULL, 0, &dg, sizeof(dg), &count, NULL);
241 bs->bl.request_alignment = dg.Geometry.BytesPerSector;
244 /* try GetDiskFreeSpace too */
247 if (s->drive_path[0]) {
248 GetDiskFreeSpace(s->drive_path, §orsPerCluster,
249 &dg.Geometry.BytesPerSector,
250 &freeClusters, &totalClusters);
251 bs->bl.request_alignment = dg.Geometry.BytesPerSector;
255 static void raw_parse_flags(int flags, int *access_flags, DWORD *overlapped)
257 assert(access_flags != NULL);
258 assert(overlapped != NULL);
260 if (flags & BDRV_O_RDWR) {
261 *access_flags = GENERIC_READ | GENERIC_WRITE;
263 *access_flags = GENERIC_READ;
266 *overlapped = FILE_ATTRIBUTE_NORMAL;
267 if (flags & BDRV_O_NATIVE_AIO) {
268 *overlapped |= FILE_FLAG_OVERLAPPED;
270 if (flags & BDRV_O_NOCACHE) {
271 *overlapped |= FILE_FLAG_NO_BUFFERING;
275 static void raw_parse_filename(const char *filename, QDict *options,
278 /* The filename does not have to be prefixed by the protocol name, since
279 * "file" is the default protocol; therefore, the return value of this
280 * function call can be ignored. */
281 strstart(filename, "file:", &filename);
283 qdict_put_obj(options, "filename", QOBJECT(qstring_from_str(filename)));
286 static QemuOptsList raw_runtime_opts = {
288 .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
292 .type = QEMU_OPT_STRING,
293 .help = "File name of the image",
295 { /* end of list */ }
299 static int raw_open(BlockDriverState *bs, QDict *options, int flags,
302 BDRVRawState *s = bs->opaque;
304 Error *local_err = NULL;
305 const char *filename;
310 s->type = FTYPE_FILE;
312 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
313 qemu_opts_absorb_qdict(opts, options, &local_err);
315 error_propagate(errp, local_err);
320 filename = qemu_opt_get(opts, "filename");
322 raw_parse_flags(flags, &access_flags, &overlapped);
324 if (filename[0] && filename[1] == ':') {
325 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", filename[0]);
326 } else if (filename[0] == '\\' && filename[1] == '\\') {
327 s->drive_path[0] = 0;
331 GetCurrentDirectory(MAX_PATH, buf);
332 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", buf[0]);
335 s->hfile = CreateFile(filename, access_flags,
336 FILE_SHARE_READ, NULL,
337 OPEN_EXISTING, overlapped, NULL);
338 if (s->hfile == INVALID_HANDLE_VALUE) {
339 int err = GetLastError();
341 if (err == ERROR_ACCESS_DENIED) {
349 if (flags & BDRV_O_NATIVE_AIO) {
350 s->aio = win32_aio_init();
351 if (s->aio == NULL) {
352 CloseHandle(s->hfile);
353 error_setg(errp, "Could not initialize AIO");
358 ret = win32_aio_attach(s->aio, s->hfile);
360 win32_aio_cleanup(s->aio);
361 CloseHandle(s->hfile);
362 error_setg_errno(errp, -ret, "Could not enable AIO");
366 win32_aio_attach_aio_context(s->aio, bdrv_get_aio_context(bs));
375 static BlockAIOCB *raw_aio_readv(BlockDriverState *bs,
376 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
377 BlockCompletionFunc *cb, void *opaque)
379 BDRVRawState *s = bs->opaque;
381 return win32_aio_submit(bs, s->aio, s->hfile, sector_num, qiov,
382 nb_sectors, cb, opaque, QEMU_AIO_READ);
384 return paio_submit(bs, s->hfile, sector_num << BDRV_SECTOR_BITS, qiov,
385 nb_sectors << BDRV_SECTOR_BITS,
386 cb, opaque, QEMU_AIO_READ);
390 static BlockAIOCB *raw_aio_writev(BlockDriverState *bs,
391 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
392 BlockCompletionFunc *cb, void *opaque)
394 BDRVRawState *s = bs->opaque;
396 return win32_aio_submit(bs, s->aio, s->hfile, sector_num, qiov,
397 nb_sectors, cb, opaque, QEMU_AIO_WRITE);
399 return paio_submit(bs, s->hfile, sector_num << BDRV_SECTOR_BITS, qiov,
400 nb_sectors << BDRV_SECTOR_BITS,
401 cb, opaque, QEMU_AIO_WRITE);
405 static BlockAIOCB *raw_aio_flush(BlockDriverState *bs,
406 BlockCompletionFunc *cb, void *opaque)
408 BDRVRawState *s = bs->opaque;
409 return paio_submit(bs, s->hfile, 0, NULL, 0, cb, opaque, QEMU_AIO_FLUSH);
412 static void raw_close(BlockDriverState *bs)
414 BDRVRawState *s = bs->opaque;
417 win32_aio_detach_aio_context(s->aio, bdrv_get_aio_context(bs));
418 win32_aio_cleanup(s->aio);
422 CloseHandle(s->hfile);
423 if (bs->open_flags & BDRV_O_TEMPORARY) {
424 unlink(bs->filename);
428 static int raw_truncate(BlockDriverState *bs, int64_t offset)
430 BDRVRawState *s = bs->opaque;
438 * An error has occurred if the return value is INVALID_SET_FILE_POINTER
439 * and GetLastError doesn't return NO_ERROR.
441 dwPtrLow = SetFilePointer(s->hfile, low, &high, FILE_BEGIN);
442 if (dwPtrLow == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
443 fprintf(stderr, "SetFilePointer error: %lu\n", GetLastError());
446 if (SetEndOfFile(s->hfile) == 0) {
447 fprintf(stderr, "SetEndOfFile error: %lu\n", GetLastError());
453 static int64_t raw_getlength(BlockDriverState *bs)
455 BDRVRawState *s = bs->opaque;
457 ULARGE_INTEGER available, total, total_free;
464 l.LowPart = GetFileSize(s->hfile, (PDWORD)&l.HighPart);
465 if (l.LowPart == 0xffffffffUL && GetLastError() != NO_ERROR)
469 if (!GetDiskFreeSpaceEx(s->drive_path, &available, &total, &total_free))
471 l.QuadPart = total.QuadPart;
474 status = DeviceIoControl(s->hfile, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX,
475 NULL, 0, &dg, sizeof(dg), &count, NULL);
486 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
488 typedef DWORD (WINAPI * get_compressed_t)(const char *filename,
490 get_compressed_t get_compressed;
492 const char *filename = bs->filename;
493 /* WinNT support GetCompressedFileSize to determine allocate size */
495 (get_compressed_t) GetProcAddress(GetModuleHandle("kernel32"),
496 "GetCompressedFileSizeA");
497 if (get_compressed) {
499 low = get_compressed(filename, &high);
500 if (low != 0xFFFFFFFFlu || GetLastError() == NO_ERROR) {
501 return (((int64_t) high) << 32) + low;
505 if (_stati64(filename, &st) < 0) {
511 static int raw_create(const char *filename, QemuOpts *opts, Error **errp)
514 int64_t total_size = 0;
516 strstart(filename, "file:", &filename);
518 /* Read out options */
519 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
522 fd = qemu_open(filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY,
525 error_setg_errno(errp, errno, "Could not create file");
529 ftruncate(fd, total_size);
535 static QemuOptsList raw_create_opts = {
536 .name = "raw-create-opts",
537 .head = QTAILQ_HEAD_INITIALIZER(raw_create_opts.head),
540 .name = BLOCK_OPT_SIZE,
541 .type = QEMU_OPT_SIZE,
542 .help = "Virtual disk size"
544 { /* end of list */ }
548 BlockDriver bdrv_file = {
549 .format_name = "file",
550 .protocol_name = "file",
551 .instance_size = sizeof(BDRVRawState),
552 .bdrv_needs_filename = true,
553 .bdrv_parse_filename = raw_parse_filename,
554 .bdrv_file_open = raw_open,
555 .bdrv_refresh_limits = raw_probe_alignment,
556 .bdrv_close = raw_close,
557 .bdrv_create = raw_create,
558 .bdrv_has_zero_init = bdrv_has_zero_init_1,
560 .bdrv_aio_readv = raw_aio_readv,
561 .bdrv_aio_writev = raw_aio_writev,
562 .bdrv_aio_flush = raw_aio_flush,
564 .bdrv_truncate = raw_truncate,
565 .bdrv_getlength = raw_getlength,
566 .bdrv_get_allocated_file_size
567 = raw_get_allocated_file_size,
569 .create_opts = &raw_create_opts,
572 /***********************************************/
575 static int find_cdrom(char *cdrom_name, int cdrom_name_size)
577 char drives[256], *pdrv = drives;
580 memset(drives, 0, sizeof(drives));
581 GetLogicalDriveStrings(sizeof(drives), drives);
582 while(pdrv[0] != '\0') {
583 type = GetDriveType(pdrv);
586 snprintf(cdrom_name, cdrom_name_size, "\\\\.\\%c:", pdrv[0]);
590 pdrv += lstrlen(pdrv) + 1;
595 static int find_device_type(BlockDriverState *bs, const char *filename)
597 BDRVRawState *s = bs->opaque;
601 if (strstart(filename, "\\\\.\\", &p) ||
602 strstart(filename, "//./", &p)) {
603 if (stristart(p, "PhysicalDrive", NULL))
604 return FTYPE_HARDDISK;
605 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", p[0]);
606 type = GetDriveType(s->drive_path);
608 case DRIVE_REMOVABLE:
610 return FTYPE_HARDDISK;
621 static int hdev_probe_device(const char *filename)
623 if (strstart(filename, "/dev/cdrom", NULL))
625 if (is_windows_drive(filename))
630 static void hdev_parse_filename(const char *filename, QDict *options,
633 /* The prefix is optional, just as for "file". */
634 strstart(filename, "host_device:", &filename);
636 qdict_put_obj(options, "filename", QOBJECT(qstring_from_str(filename)));
639 static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
642 BDRVRawState *s = bs->opaque;
643 int access_flags, create_flags;
646 char device_name[64];
648 Error *local_err = NULL;
649 const char *filename;
651 QemuOpts *opts = qemu_opts_create(&raw_runtime_opts, NULL, 0,
653 qemu_opts_absorb_qdict(opts, options, &local_err);
655 error_propagate(errp, local_err);
660 filename = qemu_opt_get(opts, "filename");
662 if (strstart(filename, "/dev/cdrom", NULL)) {
663 if (find_cdrom(device_name, sizeof(device_name)) < 0) {
664 error_setg(errp, "Could not open CD-ROM drive");
668 filename = device_name;
670 /* transform drive letters into device name */
671 if (((filename[0] >= 'a' && filename[0] <= 'z') ||
672 (filename[0] >= 'A' && filename[0] <= 'Z')) &&
673 filename[1] == ':' && filename[2] == '\0') {
674 snprintf(device_name, sizeof(device_name), "\\\\.\\%c:", filename[0]);
675 filename = device_name;
678 s->type = find_device_type(bs, filename);
680 raw_parse_flags(flags, &access_flags, &overlapped);
682 create_flags = OPEN_EXISTING;
684 s->hfile = CreateFile(filename, access_flags,
685 FILE_SHARE_READ, NULL,
686 create_flags, overlapped, NULL);
687 if (s->hfile == INVALID_HANDLE_VALUE) {
688 int err = GetLastError();
690 if (err == ERROR_ACCESS_DENIED) {
695 error_setg_errno(errp, -ret, "Could not open device");
705 static BlockDriver bdrv_host_device = {
706 .format_name = "host_device",
707 .protocol_name = "host_device",
708 .instance_size = sizeof(BDRVRawState),
709 .bdrv_needs_filename = true,
710 .bdrv_parse_filename = hdev_parse_filename,
711 .bdrv_probe_device = hdev_probe_device,
712 .bdrv_file_open = hdev_open,
713 .bdrv_close = raw_close,
715 .bdrv_aio_readv = raw_aio_readv,
716 .bdrv_aio_writev = raw_aio_writev,
717 .bdrv_aio_flush = raw_aio_flush,
719 .bdrv_detach_aio_context = raw_detach_aio_context,
720 .bdrv_attach_aio_context = raw_attach_aio_context,
722 .bdrv_getlength = raw_getlength,
723 .has_variable_length = true,
725 .bdrv_get_allocated_file_size
726 = raw_get_allocated_file_size,
729 static void bdrv_file_init(void)
731 bdrv_register(&bdrv_file);
732 bdrv_register(&bdrv_host_device);
735 block_init(bdrv_file_init);