char/cadence_uart: Implement Tx flow control
[qemu.git] / block / raw-win32.c
blob2bad5a39b4f7f5ccf78596bfb0fc5bac9911280c
1 /*
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
22 * THE SOFTWARE.
24 #include "qemu-common.h"
25 #include "qemu/timer.h"
26 #include "block/block_int.h"
27 #include "qemu/module.h"
28 #include "raw-aio.h"
29 #include "trace.h"
30 #include "block/thread-pool.h"
31 #include "qemu/iov.h"
32 #include <windows.h>
33 #include <winioctl.h>
35 #define FTYPE_FILE 0
36 #define FTYPE_CD 1
37 #define FTYPE_HARDDISK 2
39 static QEMUWin32AIOState *aio;
41 typedef struct RawWin32AIOData {
42 BlockDriverState *bs;
43 HANDLE hfile;
44 struct iovec *aio_iov;
45 int aio_niov;
46 size_t aio_nbytes;
47 off64_t aio_offset;
48 int aio_type;
49 } RawWin32AIOData;
51 typedef struct BDRVRawState {
52 HANDLE hfile;
53 int type;
54 char drive_path[16]; /* format: "d:\" */
55 QEMUWin32AIOState *aio;
56 } BDRVRawState;
59 * Read/writes the data to/from a given linear buffer.
61 * Returns the number of bytes handles or -errno in case of an error. Short
62 * reads are only returned if the end of the file is reached.
64 static size_t handle_aiocb_rw(RawWin32AIOData *aiocb)
66 size_t offset = 0;
67 int i;
69 for (i = 0; i < aiocb->aio_niov; i++) {
70 OVERLAPPED ov;
71 DWORD ret, ret_count, len;
73 memset(&ov, 0, sizeof(ov));
74 ov.Offset = (aiocb->aio_offset + offset);
75 ov.OffsetHigh = (aiocb->aio_offset + offset) >> 32;
76 len = aiocb->aio_iov[i].iov_len;
77 if (aiocb->aio_type & QEMU_AIO_WRITE) {
78 ret = WriteFile(aiocb->hfile, aiocb->aio_iov[i].iov_base,
79 len, &ret_count, &ov);
80 } else {
81 ret = ReadFile(aiocb->hfile, aiocb->aio_iov[i].iov_base,
82 len, &ret_count, &ov);
84 if (!ret) {
85 ret_count = 0;
87 if (ret_count != len) {
88 offset += ret_count;
89 break;
91 offset += len;
94 return offset;
97 static int aio_worker(void *arg)
99 RawWin32AIOData *aiocb = arg;
100 ssize_t ret = 0;
101 size_t count;
103 switch (aiocb->aio_type & QEMU_AIO_TYPE_MASK) {
104 case QEMU_AIO_READ:
105 count = handle_aiocb_rw(aiocb);
106 if (count < aiocb->aio_nbytes && aiocb->bs->growable) {
107 /* A short read means that we have reached EOF. Pad the buffer
108 * with zeros for bytes after EOF. */
109 iov_memset(aiocb->aio_iov, aiocb->aio_niov, count,
110 0, aiocb->aio_nbytes - count);
112 count = aiocb->aio_nbytes;
114 if (count == aiocb->aio_nbytes) {
115 ret = 0;
116 } else {
117 ret = -EINVAL;
119 break;
120 case QEMU_AIO_WRITE:
121 count = handle_aiocb_rw(aiocb);
122 if (count == aiocb->aio_nbytes) {
123 count = 0;
124 } else {
125 count = -EINVAL;
127 break;
128 case QEMU_AIO_FLUSH:
129 if (!FlushFileBuffers(aiocb->hfile)) {
130 return -EIO;
132 break;
133 default:
134 fprintf(stderr, "invalid aio request (0x%x)\n", aiocb->aio_type);
135 ret = -EINVAL;
136 break;
139 g_slice_free(RawWin32AIOData, aiocb);
140 return ret;
143 static BlockDriverAIOCB *paio_submit(BlockDriverState *bs, HANDLE hfile,
144 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
145 BlockDriverCompletionFunc *cb, void *opaque, int type)
147 RawWin32AIOData *acb = g_slice_new(RawWin32AIOData);
148 ThreadPool *pool;
150 acb->bs = bs;
151 acb->hfile = hfile;
152 acb->aio_type = type;
154 if (qiov) {
155 acb->aio_iov = qiov->iov;
156 acb->aio_niov = qiov->niov;
158 acb->aio_nbytes = nb_sectors * 512;
159 acb->aio_offset = sector_num * 512;
161 trace_paio_submit(acb, opaque, sector_num, nb_sectors, type);
162 pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
163 return thread_pool_submit_aio(pool, aio_worker, acb, cb, opaque);
166 int qemu_ftruncate64(int fd, int64_t length)
168 LARGE_INTEGER li;
169 DWORD dw;
170 LONG high;
171 HANDLE h;
172 BOOL res;
174 if ((GetVersion() & 0x80000000UL) && (length >> 32) != 0)
175 return -1;
177 h = (HANDLE)_get_osfhandle(fd);
179 /* get current position, ftruncate do not change position */
180 li.HighPart = 0;
181 li.LowPart = SetFilePointer (h, 0, &li.HighPart, FILE_CURRENT);
182 if (li.LowPart == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
183 return -1;
186 high = length >> 32;
187 dw = SetFilePointer(h, (DWORD) length, &high, FILE_BEGIN);
188 if (dw == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
189 return -1;
191 res = SetEndOfFile(h);
193 /* back to old position */
194 SetFilePointer(h, li.LowPart, &li.HighPart, FILE_BEGIN);
195 return res ? 0 : -1;
198 static int set_sparse(int fd)
200 DWORD returned;
201 return (int) DeviceIoControl((HANDLE)_get_osfhandle(fd), FSCTL_SET_SPARSE,
202 NULL, 0, NULL, 0, &returned, NULL);
205 static void raw_parse_flags(int flags, int *access_flags, DWORD *overlapped)
207 assert(access_flags != NULL);
208 assert(overlapped != NULL);
210 if (flags & BDRV_O_RDWR) {
211 *access_flags = GENERIC_READ | GENERIC_WRITE;
212 } else {
213 *access_flags = GENERIC_READ;
216 *overlapped = FILE_ATTRIBUTE_NORMAL;
217 if (flags & BDRV_O_NATIVE_AIO) {
218 *overlapped |= FILE_FLAG_OVERLAPPED;
220 if (flags & BDRV_O_NOCACHE) {
221 *overlapped |= FILE_FLAG_NO_BUFFERING;
225 static QemuOptsList raw_runtime_opts = {
226 .name = "raw",
227 .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
228 .desc = {
230 .name = "filename",
231 .type = QEMU_OPT_STRING,
232 .help = "File name of the image",
234 { /* end of list */ }
238 static int raw_open(BlockDriverState *bs, QDict *options, int flags,
239 Error **errp)
241 BDRVRawState *s = bs->opaque;
242 int access_flags;
243 DWORD overlapped;
244 QemuOpts *opts;
245 Error *local_err = NULL;
246 const char *filename;
247 int ret;
249 s->type = FTYPE_FILE;
251 opts = qemu_opts_create_nofail(&raw_runtime_opts);
252 qemu_opts_absorb_qdict(opts, options, &local_err);
253 if (error_is_set(&local_err)) {
254 error_propagate(errp, local_err);
255 ret = -EINVAL;
256 goto fail;
259 filename = qemu_opt_get(opts, "filename");
261 raw_parse_flags(flags, &access_flags, &overlapped);
263 if ((flags & BDRV_O_NATIVE_AIO) && aio == NULL) {
264 aio = win32_aio_init();
265 if (aio == NULL) {
266 error_setg(errp, "Could not initialize AIO");
267 ret = -EINVAL;
268 goto fail;
272 s->hfile = CreateFile(filename, access_flags,
273 FILE_SHARE_READ, NULL,
274 OPEN_EXISTING, overlapped, NULL);
275 if (s->hfile == INVALID_HANDLE_VALUE) {
276 int err = GetLastError();
278 if (err == ERROR_ACCESS_DENIED) {
279 ret = -EACCES;
280 } else {
281 ret = -EINVAL;
283 goto fail;
286 if (flags & BDRV_O_NATIVE_AIO) {
287 ret = win32_aio_attach(aio, s->hfile);
288 if (ret < 0) {
289 CloseHandle(s->hfile);
290 error_setg_errno(errp, -ret, "Could not enable AIO");
291 goto fail;
293 s->aio = aio;
296 ret = 0;
297 fail:
298 qemu_opts_del(opts);
299 return ret;
302 static BlockDriverAIOCB *raw_aio_readv(BlockDriverState *bs,
303 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
304 BlockDriverCompletionFunc *cb, void *opaque)
306 BDRVRawState *s = bs->opaque;
307 if (s->aio) {
308 return win32_aio_submit(bs, s->aio, s->hfile, sector_num, qiov,
309 nb_sectors, cb, opaque, QEMU_AIO_READ);
310 } else {
311 return paio_submit(bs, s->hfile, sector_num, qiov, nb_sectors,
312 cb, opaque, QEMU_AIO_READ);
316 static BlockDriverAIOCB *raw_aio_writev(BlockDriverState *bs,
317 int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
318 BlockDriverCompletionFunc *cb, void *opaque)
320 BDRVRawState *s = bs->opaque;
321 if (s->aio) {
322 return win32_aio_submit(bs, s->aio, s->hfile, sector_num, qiov,
323 nb_sectors, cb, opaque, QEMU_AIO_WRITE);
324 } else {
325 return paio_submit(bs, s->hfile, sector_num, qiov, nb_sectors,
326 cb, opaque, QEMU_AIO_WRITE);
330 static BlockDriverAIOCB *raw_aio_flush(BlockDriverState *bs,
331 BlockDriverCompletionFunc *cb, void *opaque)
333 BDRVRawState *s = bs->opaque;
334 return paio_submit(bs, s->hfile, 0, NULL, 0, cb, opaque, QEMU_AIO_FLUSH);
337 static void raw_close(BlockDriverState *bs)
339 BDRVRawState *s = bs->opaque;
340 CloseHandle(s->hfile);
343 static int raw_truncate(BlockDriverState *bs, int64_t offset)
345 BDRVRawState *s = bs->opaque;
346 LONG low, high;
347 DWORD dwPtrLow;
349 low = offset;
350 high = offset >> 32;
353 * An error has occurred if the return value is INVALID_SET_FILE_POINTER
354 * and GetLastError doesn't return NO_ERROR.
356 dwPtrLow = SetFilePointer(s->hfile, low, &high, FILE_BEGIN);
357 if (dwPtrLow == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
358 fprintf(stderr, "SetFilePointer error: %lu\n", GetLastError());
359 return -EIO;
361 if (SetEndOfFile(s->hfile) == 0) {
362 fprintf(stderr, "SetEndOfFile error: %lu\n", GetLastError());
363 return -EIO;
365 return 0;
368 static int64_t raw_getlength(BlockDriverState *bs)
370 BDRVRawState *s = bs->opaque;
371 LARGE_INTEGER l;
372 ULARGE_INTEGER available, total, total_free;
373 DISK_GEOMETRY_EX dg;
374 DWORD count;
375 BOOL status;
377 switch(s->type) {
378 case FTYPE_FILE:
379 l.LowPart = GetFileSize(s->hfile, (PDWORD)&l.HighPart);
380 if (l.LowPart == 0xffffffffUL && GetLastError() != NO_ERROR)
381 return -EIO;
382 break;
383 case FTYPE_CD:
384 if (!GetDiskFreeSpaceEx(s->drive_path, &available, &total, &total_free))
385 return -EIO;
386 l.QuadPart = total.QuadPart;
387 break;
388 case FTYPE_HARDDISK:
389 status = DeviceIoControl(s->hfile, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX,
390 NULL, 0, &dg, sizeof(dg), &count, NULL);
391 if (status != 0) {
392 l = dg.DiskSize;
394 break;
395 default:
396 return -EIO;
398 return l.QuadPart;
401 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
403 typedef DWORD (WINAPI * get_compressed_t)(const char *filename,
404 DWORD * high);
405 get_compressed_t get_compressed;
406 struct _stati64 st;
407 const char *filename = bs->filename;
408 /* WinNT support GetCompressedFileSize to determine allocate size */
409 get_compressed =
410 (get_compressed_t) GetProcAddress(GetModuleHandle("kernel32"),
411 "GetCompressedFileSizeA");
412 if (get_compressed) {
413 DWORD high, low;
414 low = get_compressed(filename, &high);
415 if (low != 0xFFFFFFFFlu || GetLastError() == NO_ERROR) {
416 return (((int64_t) high) << 32) + low;
420 if (_stati64(filename, &st) < 0) {
421 return -1;
423 return st.st_size;
426 static int raw_create(const char *filename, QEMUOptionParameter *options,
427 Error **errp)
429 int fd;
430 int64_t total_size = 0;
432 /* Read out options */
433 while (options && options->name) {
434 if (!strcmp(options->name, BLOCK_OPT_SIZE)) {
435 total_size = options->value.n / 512;
437 options++;
440 fd = qemu_open(filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY,
441 0644);
442 if (fd < 0) {
443 error_setg_errno(errp, errno, "Could not create file");
444 return -EIO;
446 set_sparse(fd);
447 ftruncate(fd, total_size * 512);
448 qemu_close(fd);
449 return 0;
452 static QEMUOptionParameter raw_create_options[] = {
454 .name = BLOCK_OPT_SIZE,
455 .type = OPT_SIZE,
456 .help = "Virtual disk size"
458 { NULL }
461 static BlockDriver bdrv_file = {
462 .format_name = "file",
463 .protocol_name = "file",
464 .instance_size = sizeof(BDRVRawState),
465 .bdrv_needs_filename = true,
466 .bdrv_file_open = raw_open,
467 .bdrv_close = raw_close,
468 .bdrv_create = raw_create,
469 .bdrv_has_zero_init = bdrv_has_zero_init_1,
471 .bdrv_aio_readv = raw_aio_readv,
472 .bdrv_aio_writev = raw_aio_writev,
473 .bdrv_aio_flush = raw_aio_flush,
475 .bdrv_truncate = raw_truncate,
476 .bdrv_getlength = raw_getlength,
477 .bdrv_get_allocated_file_size
478 = raw_get_allocated_file_size,
480 .create_options = raw_create_options,
483 /***********************************************/
484 /* host device */
486 static int find_cdrom(char *cdrom_name, int cdrom_name_size)
488 char drives[256], *pdrv = drives;
489 UINT type;
491 memset(drives, 0, sizeof(drives));
492 GetLogicalDriveStrings(sizeof(drives), drives);
493 while(pdrv[0] != '\0') {
494 type = GetDriveType(pdrv);
495 switch(type) {
496 case DRIVE_CDROM:
497 snprintf(cdrom_name, cdrom_name_size, "\\\\.\\%c:", pdrv[0]);
498 return 0;
499 break;
501 pdrv += lstrlen(pdrv) + 1;
503 return -1;
506 static int find_device_type(BlockDriverState *bs, const char *filename)
508 BDRVRawState *s = bs->opaque;
509 UINT type;
510 const char *p;
512 if (strstart(filename, "\\\\.\\", &p) ||
513 strstart(filename, "//./", &p)) {
514 if (stristart(p, "PhysicalDrive", NULL))
515 return FTYPE_HARDDISK;
516 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", p[0]);
517 type = GetDriveType(s->drive_path);
518 switch (type) {
519 case DRIVE_REMOVABLE:
520 case DRIVE_FIXED:
521 return FTYPE_HARDDISK;
522 case DRIVE_CDROM:
523 return FTYPE_CD;
524 default:
525 return FTYPE_FILE;
527 } else {
528 return FTYPE_FILE;
532 static int hdev_probe_device(const char *filename)
534 if (strstart(filename, "/dev/cdrom", NULL))
535 return 100;
536 if (is_windows_drive(filename))
537 return 100;
538 return 0;
541 static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
542 Error **errp)
544 BDRVRawState *s = bs->opaque;
545 int access_flags, create_flags;
546 int ret = 0;
547 DWORD overlapped;
548 char device_name[64];
550 Error *local_err = NULL;
551 const char *filename;
553 QemuOpts *opts = qemu_opts_create_nofail(&raw_runtime_opts);
554 qemu_opts_absorb_qdict(opts, options, &local_err);
555 if (error_is_set(&local_err)) {
556 error_propagate(errp, local_err);
557 ret = -EINVAL;
558 goto done;
561 filename = qemu_opt_get(opts, "filename");
563 if (strstart(filename, "/dev/cdrom", NULL)) {
564 if (find_cdrom(device_name, sizeof(device_name)) < 0) {
565 error_setg(errp, "Could not open CD-ROM drive");
566 ret = -ENOENT;
567 goto done;
569 filename = device_name;
570 } else {
571 /* transform drive letters into device name */
572 if (((filename[0] >= 'a' && filename[0] <= 'z') ||
573 (filename[0] >= 'A' && filename[0] <= 'Z')) &&
574 filename[1] == ':' && filename[2] == '\0') {
575 snprintf(device_name, sizeof(device_name), "\\\\.\\%c:", filename[0]);
576 filename = device_name;
579 s->type = find_device_type(bs, filename);
581 raw_parse_flags(flags, &access_flags, &overlapped);
583 create_flags = OPEN_EXISTING;
585 s->hfile = CreateFile(filename, access_flags,
586 FILE_SHARE_READ, NULL,
587 create_flags, overlapped, NULL);
588 if (s->hfile == INVALID_HANDLE_VALUE) {
589 int err = GetLastError();
591 if (err == ERROR_ACCESS_DENIED) {
592 ret = -EACCES;
593 } else {
594 ret = -EINVAL;
596 error_setg_errno(errp, -ret, "Could not open device");
597 goto done;
600 done:
601 qemu_opts_del(opts);
602 return ret;
605 static BlockDriver bdrv_host_device = {
606 .format_name = "host_device",
607 .protocol_name = "host_device",
608 .instance_size = sizeof(BDRVRawState),
609 .bdrv_needs_filename = true,
610 .bdrv_probe_device = hdev_probe_device,
611 .bdrv_file_open = hdev_open,
612 .bdrv_close = raw_close,
614 .bdrv_aio_readv = raw_aio_readv,
615 .bdrv_aio_writev = raw_aio_writev,
616 .bdrv_aio_flush = raw_aio_flush,
618 .bdrv_getlength = raw_getlength,
619 .has_variable_length = true,
621 .bdrv_get_allocated_file_size
622 = raw_get_allocated_file_size,
625 static void bdrv_file_init(void)
627 bdrv_register(&bdrv_file);
628 bdrv_register(&bdrv_host_device);
631 block_init(bdrv_file_init);