blob: 2642088bd6eecb87e9032b135ccc6ec629c8f27b [file] [log] [blame]
ths223d4672007-12-15 17:28:36 +00001/*
2 * Block driver for RAW files (win32)
3 *
4 * Copyright (c) 2006 Fabrice Bellard
5 *
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:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
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.
23 */
Markus Armbruster922a01a2018-02-01 12:18:46 +010024
Peter Maydell80c71a22016-01-18 18:01:42 +000025#include "qemu/osdep.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010026#include "qapi/error.h"
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020027#include "qemu/cutils.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010028#include "block/block_int.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010029#include "qemu/module.h"
Markus Armbruster922a01a2018-02-01 12:18:46 +010030#include "qemu/option.h"
Paolo Bonzini0187f5c2016-07-04 18:33:20 +020031#include "block/raw-aio.h"
Paolo Bonzinifc4edb82012-06-09 04:48:28 +020032#include "trace.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010033#include "block/thread-pool.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010034#include "qemu/iov.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010035#include "qapi/qmp/qdict.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010036#include "qapi/qmp/qstring.h"
aliguori49dc7682009-03-08 16:26:59 +000037#include <windows.h>
ths223d4672007-12-15 17:28:36 +000038#include <winioctl.h>
39
40#define FTYPE_FILE 0
41#define FTYPE_CD 1
42#define FTYPE_HARDDISK 2
43
Paolo Bonzinifc4edb82012-06-09 04:48:28 +020044typedef struct RawWin32AIOData {
45 BlockDriverState *bs;
46 HANDLE hfile;
47 struct iovec *aio_iov;
48 int aio_niov;
49 size_t aio_nbytes;
50 off64_t aio_offset;
51 int aio_type;
52} RawWin32AIOData;
53
ths223d4672007-12-15 17:28:36 +000054typedef struct BDRVRawState {
55 HANDLE hfile;
56 int type;
57 char drive_path[16]; /* format: "d:\" */
Paolo Bonzinia2736522012-10-26 11:43:58 +020058 QEMUWin32AIOState *aio;
ths223d4672007-12-15 17:28:36 +000059} BDRVRawState;
60
Paolo Bonzinifc4edb82012-06-09 04:48:28 +020061/*
62 * Read/writes the data to/from a given linear buffer.
63 *
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.
66 */
67static size_t handle_aiocb_rw(RawWin32AIOData *aiocb)
68{
69 size_t offset = 0;
70 int i;
71
72 for (i = 0; i < aiocb->aio_niov; i++) {
73 OVERLAPPED ov;
74 DWORD ret, ret_count, len;
75
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);
83 } else {
84 ret = ReadFile(aiocb->hfile, aiocb->aio_iov[i].iov_base,
85 len, &ret_count, &ov);
86 }
87 if (!ret) {
88 ret_count = 0;
89 }
90 if (ret_count != len) {
Tal Kain56e023a2013-09-09 11:14:55 +020091 offset += ret_count;
Paolo Bonzinifc4edb82012-06-09 04:48:28 +020092 break;
93 }
94 offset += len;
95 }
96
97 return offset;
98}
99
100static int aio_worker(void *arg)
101{
102 RawWin32AIOData *aiocb = arg;
103 ssize_t ret = 0;
104 size_t count;
105
106 switch (aiocb->aio_type & QEMU_AIO_TYPE_MASK) {
107 case QEMU_AIO_READ:
108 count = handle_aiocb_rw(aiocb);
Max Reitzc0191e72015-02-05 13:58:24 -0500109 if (count < aiocb->aio_nbytes) {
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200110 /* 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);
114
115 count = aiocb->aio_nbytes;
116 }
117 if (count == aiocb->aio_nbytes) {
118 ret = 0;
119 } else {
120 ret = -EINVAL;
121 }
122 break;
123 case QEMU_AIO_WRITE:
124 count = handle_aiocb_rw(aiocb);
125 if (count == aiocb->aio_nbytes) {
Kevin Wolf5d555032015-09-23 14:58:21 +0200126 ret = 0;
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200127 } else {
Kevin Wolf5d555032015-09-23 14:58:21 +0200128 ret = -EINVAL;
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200129 }
130 break;
131 case QEMU_AIO_FLUSH:
132 if (!FlushFileBuffers(aiocb->hfile)) {
133 return -EIO;
134 }
135 break;
136 default:
137 fprintf(stderr, "invalid aio request (0x%x)\n", aiocb->aio_type);
138 ret = -EINVAL;
139 break;
140 }
141
Paolo Bonzinic84b3192015-10-01 13:04:39 +0200142 g_free(aiocb);
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200143 return ret;
144}
145
Markus Armbruster7c84b1b2014-10-07 13:59:14 +0200146static BlockAIOCB *paio_submit(BlockDriverState *bs, HANDLE hfile,
Eric Blake36e3b2e2016-07-15 17:22:55 -0600147 int64_t offset, QEMUIOVector *qiov, int count,
Markus Armbruster097310b2014-10-07 13:59:15 +0200148 BlockCompletionFunc *cb, void *opaque, int type)
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200149{
Paolo Bonzinic84b3192015-10-01 13:04:39 +0200150 RawWin32AIOData *acb = g_new(RawWin32AIOData, 1);
Stefan Hajnoczic4d9d192013-03-07 13:41:49 +0100151 ThreadPool *pool;
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200152
153 acb->bs = bs;
154 acb->hfile = hfile;
155 acb->aio_type = type;
156
157 if (qiov) {
158 acb->aio_iov = qiov->iov;
159 acb->aio_niov = qiov->niov;
Eric Blake36e3b2e2016-07-15 17:22:55 -0600160 assert(qiov->size == count);
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200161 }
Eric Blake36e3b2e2016-07-15 17:22:55 -0600162 acb->aio_nbytes = count;
163 acb->aio_offset = offset;
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200164
Fam Zhengf8a30872018-07-10 14:31:15 +0800165 trace_file_paio_submit(acb, opaque, offset, count, type);
Stefan Hajnoczic4d9d192013-03-07 13:41:49 +0100166 pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
167 return thread_pool_submit_aio(pool, aio_worker, acb, cb, opaque);
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200168}
169
ths223d4672007-12-15 17:28:36 +0000170int qemu_ftruncate64(int fd, int64_t length)
171{
172 LARGE_INTEGER li;
Stefan Weil2c993ec2011-08-20 12:10:05 +0200173 DWORD dw;
ths223d4672007-12-15 17:28:36 +0000174 LONG high;
175 HANDLE h;
176 BOOL res;
177
178 if ((GetVersion() & 0x80000000UL) && (length >> 32) != 0)
Paolo Bonzini7d374352018-12-13 23:37:37 +0100179 return -1;
ths223d4672007-12-15 17:28:36 +0000180
181 h = (HANDLE)_get_osfhandle(fd);
182
183 /* get current position, ftruncate do not change position */
184 li.HighPart = 0;
185 li.LowPart = SetFilePointer (h, 0, &li.HighPart, FILE_CURRENT);
Stefan Weil2c993ec2011-08-20 12:10:05 +0200186 if (li.LowPart == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
Paolo Bonzini7d374352018-12-13 23:37:37 +0100187 return -1;
Stefan Weil2c993ec2011-08-20 12:10:05 +0200188 }
ths223d4672007-12-15 17:28:36 +0000189
190 high = length >> 32;
Stefan Weil2c993ec2011-08-20 12:10:05 +0200191 dw = SetFilePointer(h, (DWORD) length, &high, FILE_BEGIN);
192 if (dw == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
Paolo Bonzini7d374352018-12-13 23:37:37 +0100193 return -1;
Stefan Weil2c993ec2011-08-20 12:10:05 +0200194 }
ths223d4672007-12-15 17:28:36 +0000195 res = SetEndOfFile(h);
196
197 /* back to old position */
198 SetFilePointer(h, li.LowPart, &li.HighPart, FILE_BEGIN);
199 return res ? 0 : -1;
200}
201
202static int set_sparse(int fd)
203{
204 DWORD returned;
205 return (int) DeviceIoControl((HANDLE)_get_osfhandle(fd), FSCTL_SET_SPARSE,
Paolo Bonzini7d374352018-12-13 23:37:37 +0100206 NULL, 0, NULL, 0, &returned, NULL);
ths223d4672007-12-15 17:28:36 +0000207}
208
Stefan Hajnoczi85ebd382014-05-08 16:34:50 +0200209static void raw_detach_aio_context(BlockDriverState *bs)
210{
211 BDRVRawState *s = bs->opaque;
212
213 if (s->aio) {
214 win32_aio_detach_aio_context(s->aio, bdrv_get_aio_context(bs));
215 }
216}
217
218static void raw_attach_aio_context(BlockDriverState *bs,
219 AioContext *new_context)
220{
221 BDRVRawState *s = bs->opaque;
222
223 if (s->aio) {
224 win32_aio_attach_aio_context(s->aio, new_context);
225 }
226}
227
Eric Blake2914a1d2016-06-23 16:37:16 -0600228static void raw_probe_alignment(BlockDriverState *bs, Error **errp)
Paolo Bonzinic25f53b2011-11-29 12:42:20 +0100229{
230 BDRVRawState *s = bs->opaque;
231 DWORD sectorsPerCluster, freeClusters, totalClusters, count;
232 DISK_GEOMETRY_EX dg;
233 BOOL status;
234
235 if (s->type == FTYPE_CD) {
Eric Blakea5b8dd22016-06-23 16:37:24 -0600236 bs->bl.request_alignment = 2048;
Paolo Bonzinic25f53b2011-11-29 12:42:20 +0100237 return;
238 }
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);
242 if (status != 0) {
Eric Blakea5b8dd22016-06-23 16:37:24 -0600243 bs->bl.request_alignment = dg.Geometry.BytesPerSector;
Paolo Bonzinic25f53b2011-11-29 12:42:20 +0100244 return;
245 }
246 /* try GetDiskFreeSpace too */
247 }
248
249 if (s->drive_path[0]) {
250 GetDiskFreeSpace(s->drive_path, &sectorsPerCluster,
251 &dg.Geometry.BytesPerSector,
252 &freeClusters, &totalClusters);
Eric Blakea5b8dd22016-06-23 16:37:24 -0600253 bs->bl.request_alignment = dg.Geometry.BytesPerSector;
Eric Blakede7056a2018-04-24 14:25:02 -0500254 return;
Paolo Bonzinic25f53b2011-11-29 12:42:20 +0100255 }
Eric Blakede7056a2018-04-24 14:25:02 -0500256
257 /* XXX Does Windows support AIO on less than 512-byte alignment? */
258 bs->bl.request_alignment = 512;
Paolo Bonzinic25f53b2011-11-29 12:42:20 +0100259}
260
Kevin Wolf0a4279d2016-09-08 15:09:01 +0200261static void raw_parse_flags(int flags, bool use_aio, int *access_flags,
262 DWORD *overlapped)
Jeff Cody6a8dc042012-09-20 15:13:21 -0400263{
264 assert(access_flags != NULL);
265 assert(overlapped != NULL);
266
267 if (flags & BDRV_O_RDWR) {
268 *access_flags = GENERIC_READ | GENERIC_WRITE;
269 } else {
270 *access_flags = GENERIC_READ;
271 }
272
273 *overlapped = FILE_ATTRIBUTE_NORMAL;
Kevin Wolf0a4279d2016-09-08 15:09:01 +0200274 if (use_aio) {
Paolo Bonzinia2736522012-10-26 11:43:58 +0200275 *overlapped |= FILE_FLAG_OVERLAPPED;
276 }
Jeff Cody6a8dc042012-09-20 15:13:21 -0400277 if (flags & BDRV_O_NOCACHE) {
278 *overlapped |= FILE_FLAG_NO_BUFFERING;
279 }
Jeff Cody6a8dc042012-09-20 15:13:21 -0400280}
281
Max Reitz7dc74db2014-03-05 22:41:39 +0100282static void raw_parse_filename(const char *filename, QDict *options,
283 Error **errp)
284{
Max Reitz03c320d2017-05-22 21:52:16 +0200285 bdrv_parse_filename_strip_prefix(filename, "file:", options);
Max Reitz7dc74db2014-03-05 22:41:39 +0100286}
287
Kevin Wolf8a793802013-04-10 11:34:56 +0200288static QemuOptsList raw_runtime_opts = {
289 .name = "raw",
290 .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
291 .desc = {
292 {
293 .name = "filename",
294 .type = QEMU_OPT_STRING,
295 .help = "File name of the image",
296 },
Kevin Wolf0a4279d2016-09-08 15:09:01 +0200297 {
298 .name = "aio",
299 .type = QEMU_OPT_STRING,
300 .help = "host AIO implementation (threads, native)",
301 },
Kevin Wolf3b079ac2020-09-07 11:27:39 +0200302 {
303 .name = "locking",
304 .type = QEMU_OPT_STRING,
305 .help = "file locking mode (on/off/auto, default: auto)",
306 },
Kevin Wolf8a793802013-04-10 11:34:56 +0200307 { /* end of list */ }
308 },
309};
310
Kevin Wolf0a4279d2016-09-08 15:09:01 +0200311static bool get_aio_option(QemuOpts *opts, int flags, Error **errp)
312{
313 BlockdevAioOptions aio, aio_default;
314
315 aio_default = (flags & BDRV_O_NATIVE_AIO) ? BLOCKDEV_AIO_OPTIONS_NATIVE
316 : BLOCKDEV_AIO_OPTIONS_THREADS;
Marc-AndrƩ Lureauf7abe0e2017-08-24 10:46:10 +0200317 aio = qapi_enum_parse(&BlockdevAioOptions_lookup, qemu_opt_get(opts, "aio"),
Markus Armbruster06c60b62017-08-24 10:45:57 +0200318 aio_default, errp);
Kevin Wolf0a4279d2016-09-08 15:09:01 +0200319
320 switch (aio) {
321 case BLOCKDEV_AIO_OPTIONS_NATIVE:
322 return true;
323 case BLOCKDEV_AIO_OPTIONS_THREADS:
324 return false;
325 default:
326 error_setg(errp, "Invalid AIO option");
327 }
328 return false;
329}
330
Max Reitz015a1032013-09-05 14:22:29 +0200331static int raw_open(BlockDriverState *bs, QDict *options, int flags,
332 Error **errp)
ths223d4672007-12-15 17:28:36 +0000333{
334 BDRVRawState *s = bs->opaque;
Christoph Hellwig9a2d77a2010-01-20 18:13:42 +0100335 int access_flags;
ths223d4672007-12-15 17:28:36 +0000336 DWORD overlapped;
Kevin Wolf8a793802013-04-10 11:34:56 +0200337 QemuOpts *opts;
338 Error *local_err = NULL;
339 const char *filename;
Kevin Wolf0a4279d2016-09-08 15:09:01 +0200340 bool use_aio;
Kevin Wolf3b079ac2020-09-07 11:27:39 +0200341 OnOffAuto locking;
Kevin Wolf8a793802013-04-10 11:34:56 +0200342 int ret;
ths223d4672007-12-15 17:28:36 +0000343
344 s->type = FTYPE_FILE;
345
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800346 opts = qemu_opts_create(&raw_runtime_opts, NULL, 0, &error_abort);
Markus Armbrusteraf175e82020-07-07 18:06:03 +0200347 if (!qemu_opts_absorb_qdict(opts, options, errp)) {
Kevin Wolf8a793802013-04-10 11:34:56 +0200348 ret = -EINVAL;
349 goto fail;
350 }
351
Kevin Wolf3b079ac2020-09-07 11:27:39 +0200352 locking = qapi_enum_parse(&OnOffAuto_lookup,
353 qemu_opt_get(opts, "locking"),
354 ON_OFF_AUTO_AUTO, &local_err);
355 if (local_err) {
356 error_propagate(errp, local_err);
357 ret = -EINVAL;
358 goto fail;
359 }
360 switch (locking) {
361 case ON_OFF_AUTO_ON:
Fam Zheng1c3a5552017-05-03 00:35:51 +0800362 error_setg(errp, "locking=on is not supported on Windows");
Gerd Hoffmanncdece042017-05-16 09:42:55 +0200363 ret = -EINVAL;
Fam Zheng1c3a5552017-05-03 00:35:51 +0800364 goto fail;
Kevin Wolf3b079ac2020-09-07 11:27:39 +0200365 case ON_OFF_AUTO_OFF:
366 case ON_OFF_AUTO_AUTO:
367 break;
368 default:
369 g_assert_not_reached();
Fam Zheng1c3a5552017-05-03 00:35:51 +0800370 }
371
Kevin Wolf8a793802013-04-10 11:34:56 +0200372 filename = qemu_opt_get(opts, "filename");
373
Kevin Wolf0a4279d2016-09-08 15:09:01 +0200374 use_aio = get_aio_option(opts, flags, &local_err);
375 if (local_err) {
376 error_propagate(errp, local_err);
377 ret = -EINVAL;
378 goto fail;
379 }
380
381 raw_parse_flags(flags, use_aio, &access_flags, &overlapped);
Kevin Wolf8a793802013-04-10 11:34:56 +0200382
Paolo Bonzinic25f53b2011-11-29 12:42:20 +0100383 if (filename[0] && filename[1] == ':') {
384 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", filename[0]);
385 } else if (filename[0] == '\\' && filename[1] == '\\') {
386 s->drive_path[0] = 0;
387 } else {
388 /* Relative path. */
389 char buf[MAX_PATH];
390 GetCurrentDirectory(MAX_PATH, buf);
391 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", buf[0]);
392 }
393
ths223d4672007-12-15 17:28:36 +0000394 s->hfile = CreateFile(filename, access_flags,
395 FILE_SHARE_READ, NULL,
Christoph Hellwig9a2d77a2010-01-20 18:13:42 +0100396 OPEN_EXISTING, overlapped, NULL);
ths223d4672007-12-15 17:28:36 +0000397 if (s->hfile == INVALID_HANDLE_VALUE) {
398 int err = GetLastError();
399
Halil Pasic09237752016-10-11 16:12:35 +0200400 error_setg_win32(errp, err, "Could not open '%s'", filename);
Kevin Wolf8a793802013-04-10 11:34:56 +0200401 if (err == ERROR_ACCESS_DENIED) {
402 ret = -EACCES;
403 } else {
404 ret = -EINVAL;
405 }
406 goto fail;
Paolo Bonzinia2736522012-10-26 11:43:58 +0200407 }
408
Kevin Wolf0a4279d2016-09-08 15:09:01 +0200409 if (use_aio) {
Stefan Hajnoczi99cc5982014-05-08 16:34:49 +0200410 s->aio = win32_aio_init();
411 if (s->aio == NULL) {
412 CloseHandle(s->hfile);
413 error_setg(errp, "Could not initialize AIO");
414 ret = -EINVAL;
415 goto fail;
416 }
417
418 ret = win32_aio_attach(s->aio, s->hfile);
Paolo Bonzinia2736522012-10-26 11:43:58 +0200419 if (ret < 0) {
Stefan Hajnoczi99cc5982014-05-08 16:34:49 +0200420 win32_aio_cleanup(s->aio);
Paolo Bonzinia2736522012-10-26 11:43:58 +0200421 CloseHandle(s->hfile);
Max Reitzc6252b72013-10-10 15:44:02 +0200422 error_setg_errno(errp, -ret, "Could not enable AIO");
Kevin Wolf8a793802013-04-10 11:34:56 +0200423 goto fail;
Paolo Bonzinia2736522012-10-26 11:43:58 +0200424 }
Stefan Hajnoczi85ebd382014-05-08 16:34:50 +0200425
426 win32_aio_attach_aio_context(s->aio, bdrv_get_aio_context(bs));
ths223d4672007-12-15 17:28:36 +0000427 }
Kevin Wolf8a793802013-04-10 11:34:56 +0200428
Eric Blake8e519792020-04-28 15:28:58 -0500429 /* When extending regular files, we get zeros from the OS */
430 bs->supported_truncate_flags = BDRV_REQ_ZERO_WRITE;
431
Kevin Wolf8a793802013-04-10 11:34:56 +0200432 ret = 0;
433fail:
434 qemu_opts_del(opts);
435 return ret;
ths223d4672007-12-15 17:28:36 +0000436}
437
Eric Blakede7056a2018-04-24 14:25:02 -0500438static BlockAIOCB *raw_aio_preadv(BlockDriverState *bs,
439 uint64_t offset, uint64_t bytes,
440 QEMUIOVector *qiov, int flags,
441 BlockCompletionFunc *cb, void *opaque)
ths223d4672007-12-15 17:28:36 +0000442{
443 BDRVRawState *s = bs->opaque;
Paolo Bonzinia2736522012-10-26 11:43:58 +0200444 if (s->aio) {
Eric Blakede7056a2018-04-24 14:25:02 -0500445 return win32_aio_submit(bs, s->aio, s->hfile, offset, bytes, qiov,
446 cb, opaque, QEMU_AIO_READ);
Paolo Bonzinia2736522012-10-26 11:43:58 +0200447 } else {
Eric Blakede7056a2018-04-24 14:25:02 -0500448 return paio_submit(bs, s->hfile, offset, qiov, bytes,
Paolo Bonzinia2736522012-10-26 11:43:58 +0200449 cb, opaque, QEMU_AIO_READ);
450 }
ths223d4672007-12-15 17:28:36 +0000451}
452
Eric Blakede7056a2018-04-24 14:25:02 -0500453static BlockAIOCB *raw_aio_pwritev(BlockDriverState *bs,
454 uint64_t offset, uint64_t bytes,
455 QEMUIOVector *qiov, int flags,
456 BlockCompletionFunc *cb, void *opaque)
ths223d4672007-12-15 17:28:36 +0000457{
458 BDRVRawState *s = bs->opaque;
Paolo Bonzinia2736522012-10-26 11:43:58 +0200459 if (s->aio) {
Eric Blakede7056a2018-04-24 14:25:02 -0500460 return win32_aio_submit(bs, s->aio, s->hfile, offset, bytes, qiov,
461 cb, opaque, QEMU_AIO_WRITE);
Paolo Bonzinia2736522012-10-26 11:43:58 +0200462 } else {
Eric Blakede7056a2018-04-24 14:25:02 -0500463 return paio_submit(bs, s->hfile, offset, qiov, bytes,
Paolo Bonzinia2736522012-10-26 11:43:58 +0200464 cb, opaque, QEMU_AIO_WRITE);
465 }
ths223d4672007-12-15 17:28:36 +0000466}
467
Markus Armbruster7c84b1b2014-10-07 13:59:14 +0200468static BlockAIOCB *raw_aio_flush(BlockDriverState *bs,
Markus Armbruster097310b2014-10-07 13:59:15 +0200469 BlockCompletionFunc *cb, void *opaque)
ths223d4672007-12-15 17:28:36 +0000470{
471 BDRVRawState *s = bs->opaque;
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200472 return paio_submit(bs, s->hfile, 0, NULL, 0, cb, opaque, QEMU_AIO_FLUSH);
ths223d4672007-12-15 17:28:36 +0000473}
474
475static void raw_close(BlockDriverState *bs)
476{
477 BDRVRawState *s = bs->opaque;
Stefan Hajnoczi99cc5982014-05-08 16:34:49 +0200478
479 if (s->aio) {
Stefan Hajnoczi85ebd382014-05-08 16:34:50 +0200480 win32_aio_detach_aio_context(s->aio, bdrv_get_aio_context(bs));
Stefan Hajnoczi99cc5982014-05-08 16:34:49 +0200481 win32_aio_cleanup(s->aio);
482 s->aio = NULL;
483 }
484
ths223d4672007-12-15 17:28:36 +0000485 CloseHandle(s->hfile);
Kevin Wolf8bfea152014-04-11 19:16:36 +0200486 if (bs->open_flags & BDRV_O_TEMPORARY) {
487 unlink(bs->filename);
488 }
ths223d4672007-12-15 17:28:36 +0000489}
490
Kevin Wolf061ca8a2018-06-21 17:54:35 +0200491static int coroutine_fn raw_co_truncate(BlockDriverState *bs, int64_t offset,
Max Reitzc80d8b02019-09-18 11:51:40 +0200492 bool exact, PreallocMode prealloc,
Kevin Wolf92b92792020-04-24 14:54:39 +0200493 BdrvRequestFlags flags, Error **errp)
ths223d4672007-12-15 17:28:36 +0000494{
495 BDRVRawState *s = bs->opaque;
blueswir1b9e82a52009-04-05 18:03:31 +0000496 LONG low, high;
Fabien Chouteaufbcad042012-12-10 12:56:22 +0100497 DWORD dwPtrLow;
ths223d4672007-12-15 17:28:36 +0000498
Max Reitz8243ccb2017-06-13 22:20:52 +0200499 if (prealloc != PREALLOC_MODE_OFF) {
500 error_setg(errp, "Unsupported preallocation mode '%s'",
Markus Armbruster977c7362017-08-24 10:46:08 +0200501 PreallocMode_str(prealloc));
Max Reitz8243ccb2017-06-13 22:20:52 +0200502 return -ENOTSUP;
503 }
504
ths223d4672007-12-15 17:28:36 +0000505 low = offset;
506 high = offset >> 32;
Fabien Chouteaufbcad042012-12-10 12:56:22 +0100507
508 /*
509 * An error has occurred if the return value is INVALID_SET_FILE_POINTER
510 * and GetLastError doesn't return NO_ERROR.
511 */
512 dwPtrLow = SetFilePointer(s->hfile, low, &high, FILE_BEGIN);
513 if (dwPtrLow == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
Max Reitz4bff28b2017-03-28 22:51:28 +0200514 error_setg_win32(errp, GetLastError(), "SetFilePointer error");
ths223d4672007-12-15 17:28:36 +0000515 return -EIO;
Fabien Chouteaufbcad042012-12-10 12:56:22 +0100516 }
517 if (SetEndOfFile(s->hfile) == 0) {
Max Reitz4bff28b2017-03-28 22:51:28 +0200518 error_setg_win32(errp, GetLastError(), "SetEndOfFile error");
Fabien Chouteaufbcad042012-12-10 12:56:22 +0100519 return -EIO;
520 }
ths223d4672007-12-15 17:28:36 +0000521 return 0;
522}
523
524static int64_t raw_getlength(BlockDriverState *bs)
525{
526 BDRVRawState *s = bs->opaque;
527 LARGE_INTEGER l;
528 ULARGE_INTEGER available, total, total_free;
529 DISK_GEOMETRY_EX dg;
530 DWORD count;
531 BOOL status;
532
533 switch(s->type) {
534 case FTYPE_FILE:
blueswir1b9e82a52009-04-05 18:03:31 +0000535 l.LowPart = GetFileSize(s->hfile, (PDWORD)&l.HighPart);
ths223d4672007-12-15 17:28:36 +0000536 if (l.LowPart == 0xffffffffUL && GetLastError() != NO_ERROR)
537 return -EIO;
538 break;
539 case FTYPE_CD:
540 if (!GetDiskFreeSpaceEx(s->drive_path, &available, &total, &total_free))
541 return -EIO;
542 l.QuadPart = total.QuadPart;
543 break;
544 case FTYPE_HARDDISK:
545 status = DeviceIoControl(s->hfile, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX,
546 NULL, 0, &dg, sizeof(dg), &count, NULL);
547 if (status != 0) {
548 l = dg.DiskSize;
549 }
550 break;
551 default:
552 return -EIO;
553 }
554 return l.QuadPart;
555}
556
Fam Zheng4a1d5e12011-07-12 19:56:39 +0800557static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
558{
559 typedef DWORD (WINAPI * get_compressed_t)(const char *filename,
560 DWORD * high);
561 get_compressed_t get_compressed;
562 struct _stati64 st;
563 const char *filename = bs->filename;
564 /* WinNT support GetCompressedFileSize to determine allocate size */
565 get_compressed =
566 (get_compressed_t) GetProcAddress(GetModuleHandle("kernel32"),
567 "GetCompressedFileSizeA");
568 if (get_compressed) {
569 DWORD high, low;
570 low = get_compressed(filename, &high);
571 if (low != 0xFFFFFFFFlu || GetLastError() == NO_ERROR) {
572 return (((int64_t) high) << 32) + low;
573 }
574 }
575
576 if (_stati64(filename, &st) < 0) {
577 return -1;
578 }
579 return st.st_size;
580}
581
Kevin Wolf3766ef52018-02-05 16:24:32 +0100582static int raw_co_create(BlockdevCreateOptions *options, Error **errp)
583{
584 BlockdevCreateOptionsFile *file_opts;
585 int fd;
586
587 assert(options->driver == BLOCKDEV_DRIVER_FILE);
588 file_opts = &options->u.file;
589
590 if (file_opts->has_preallocation) {
591 error_setg(errp, "Preallocation is not supported on Windows");
592 return -EINVAL;
593 }
594 if (file_opts->has_nocow) {
595 error_setg(errp, "nocow is not supported on Windows");
596 return -EINVAL;
597 }
598
Daniel P. BerrangƩb18a24a2020-07-01 15:22:43 +0100599 fd = qemu_create(file_opts->filename, O_WRONLY | O_TRUNC | O_BINARY,
600 0644, errp);
Kevin Wolf3766ef52018-02-05 16:24:32 +0100601 if (fd < 0) {
Kevin Wolf3766ef52018-02-05 16:24:32 +0100602 return -EIO;
603 }
604 set_sparse(fd);
605 ftruncate(fd, file_opts->size);
606 qemu_close(fd);
607
608 return 0;
609}
610
Maxim Levitskyb92902d2020-03-26 03:12:17 +0200611static int coroutine_fn raw_co_create_opts(BlockDriver *drv,
612 const char *filename,
613 QemuOpts *opts,
Stefan Hajnocziefc75e22018-01-18 13:43:45 +0100614 Error **errp)
ths223d4672007-12-15 17:28:36 +0000615{
Kevin Wolf3766ef52018-02-05 16:24:32 +0100616 BlockdevCreateOptions options;
Kevin Wolf0e7e1982009-05-18 16:42:10 +0200617 int64_t total_size = 0;
ths223d4672007-12-15 17:28:36 +0000618
Max Reitzd5546c52014-03-05 22:41:40 +0100619 strstart(filename, "file:", &filename);
620
Kevin Wolf0e7e1982009-05-18 16:42:10 +0200621 /* Read out options */
Hu Tao180e9522014-09-10 17:05:46 +0800622 total_size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
623 BDRV_SECTOR_SIZE);
ths223d4672007-12-15 17:28:36 +0000624
Kevin Wolf3766ef52018-02-05 16:24:32 +0100625 options = (BlockdevCreateOptions) {
626 .driver = BLOCKDEV_DRIVER_FILE,
627 .u.file = {
628 .filename = (char *) filename,
629 .size = total_size,
630 .has_preallocation = false,
631 .has_nocow = false,
632 },
633 };
634 return raw_co_create(&options, errp);
ths223d4672007-12-15 17:28:36 +0000635}
636
Chunyan Liuddef7692014-06-05 17:21:02 +0800637static QemuOptsList raw_create_opts = {
638 .name = "raw-create-opts",
639 .head = QTAILQ_HEAD_INITIALIZER(raw_create_opts.head),
640 .desc = {
641 {
642 .name = BLOCK_OPT_SIZE,
643 .type = QEMU_OPT_SIZE,
644 .help = "Virtual disk size"
645 },
646 { /* end of list */ }
647 }
Kevin Wolf0e7e1982009-05-18 16:42:10 +0200648};
649
Max Reitz5f535a92014-12-02 18:32:41 +0100650BlockDriver bdrv_file = {
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200651 .format_name = "file",
652 .protocol_name = "file",
aliguorif1b2f712009-04-07 18:23:51 +0000653 .instance_size = sizeof(BDRVRawState),
BenoƮt Canet030be322013-09-24 17:07:04 +0200654 .bdrv_needs_filename = true,
Max Reitz7dc74db2014-03-05 22:41:39 +0100655 .bdrv_parse_filename = raw_parse_filename,
Chunyan Liuddef7692014-06-05 17:21:02 +0800656 .bdrv_file_open = raw_open,
Eric Blake2914a1d2016-06-23 16:37:16 -0600657 .bdrv_refresh_limits = raw_probe_alignment,
Chunyan Liuddef7692014-06-05 17:21:02 +0800658 .bdrv_close = raw_close,
Stefan Hajnocziefc75e22018-01-18 13:43:45 +0100659 .bdrv_co_create_opts = raw_co_create_opts,
Peter Lieven3ac21622013-06-28 12:47:42 +0200660 .bdrv_has_zero_init = bdrv_has_zero_init_1,
Kevin Wolfc68b89a2011-11-10 17:25:44 +0100661
Eric Blakede7056a2018-04-24 14:25:02 -0500662 .bdrv_aio_preadv = raw_aio_preadv,
663 .bdrv_aio_pwritev = raw_aio_pwritev,
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200664 .bdrv_aio_flush = raw_aio_flush,
Kevin Wolfc68b89a2011-11-10 17:25:44 +0100665
Kevin Wolf061ca8a2018-06-21 17:54:35 +0200666 .bdrv_co_truncate = raw_co_truncate,
aliguorif1b2f712009-04-07 18:23:51 +0000667 .bdrv_getlength = raw_getlength,
Fam Zheng4a1d5e12011-07-12 19:56:39 +0800668 .bdrv_get_allocated_file_size
669 = raw_get_allocated_file_size,
Kevin Wolf0e7e1982009-05-18 16:42:10 +0200670
Chunyan Liuddef7692014-06-05 17:21:02 +0800671 .create_opts = &raw_create_opts,
ths223d4672007-12-15 17:28:36 +0000672};
673
674/***********************************************/
675/* host device */
676
677static int find_cdrom(char *cdrom_name, int cdrom_name_size)
678{
679 char drives[256], *pdrv = drives;
680 UINT type;
681
682 memset(drives, 0, sizeof(drives));
683 GetLogicalDriveStrings(sizeof(drives), drives);
684 while(pdrv[0] != '\0') {
685 type = GetDriveType(pdrv);
686 switch(type) {
687 case DRIVE_CDROM:
688 snprintf(cdrom_name, cdrom_name_size, "\\\\.\\%c:", pdrv[0]);
689 return 0;
690 break;
691 }
692 pdrv += lstrlen(pdrv) + 1;
693 }
694 return -1;
695}
696
697static int find_device_type(BlockDriverState *bs, const char *filename)
698{
699 BDRVRawState *s = bs->opaque;
700 UINT type;
701 const char *p;
702
703 if (strstart(filename, "\\\\.\\", &p) ||
704 strstart(filename, "//./", &p)) {
705 if (stristart(p, "PhysicalDrive", NULL))
706 return FTYPE_HARDDISK;
707 snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", p[0]);
708 type = GetDriveType(s->drive_path);
aliguori3060cd12009-04-07 01:24:53 +0000709 switch (type) {
710 case DRIVE_REMOVABLE:
711 case DRIVE_FIXED:
712 return FTYPE_HARDDISK;
713 case DRIVE_CDROM:
ths223d4672007-12-15 17:28:36 +0000714 return FTYPE_CD;
aliguori3060cd12009-04-07 01:24:53 +0000715 default:
ths223d4672007-12-15 17:28:36 +0000716 return FTYPE_FILE;
aliguori3060cd12009-04-07 01:24:53 +0000717 }
ths223d4672007-12-15 17:28:36 +0000718 } else {
719 return FTYPE_FILE;
720 }
721}
722
Christoph Hellwig508c7cb2009-06-15 14:04:22 +0200723static int hdev_probe_device(const char *filename)
724{
725 if (strstart(filename, "/dev/cdrom", NULL))
726 return 100;
727 if (is_windows_drive(filename))
728 return 100;
729 return 0;
730}
731
Max Reitz57ed25b2014-03-08 00:39:45 +0100732static void hdev_parse_filename(const char *filename, QDict *options,
733 Error **errp)
734{
Max Reitz03c320d2017-05-22 21:52:16 +0200735 bdrv_parse_filename_strip_prefix(filename, "host_device:", options);
Max Reitz57ed25b2014-03-08 00:39:45 +0100736}
737
Eric Blakede7056a2018-04-24 14:25:02 -0500738static void hdev_refresh_limits(BlockDriverState *bs, Error **errp)
739{
740 /* XXX Does Windows support AIO on less than 512-byte alignment? */
741 bs->bl.request_alignment = 512;
742}
743
Max Reitz015a1032013-09-05 14:22:29 +0200744static int hdev_open(BlockDriverState *bs, QDict *options, int flags,
745 Error **errp)
ths223d4672007-12-15 17:28:36 +0000746{
747 BDRVRawState *s = bs->opaque;
748 int access_flags, create_flags;
Stefan Weil68dc0362013-09-01 22:59:25 +0200749 int ret = 0;
ths223d4672007-12-15 17:28:36 +0000750 DWORD overlapped;
751 char device_name[64];
Stefan Weil68dc0362013-09-01 22:59:25 +0200752
753 Error *local_err = NULL;
754 const char *filename;
Kevin Wolf0a4279d2016-09-08 15:09:01 +0200755 bool use_aio;
Stefan Weil68dc0362013-09-01 22:59:25 +0200756
Peter Crosthwaite87ea75d2014-01-01 18:49:17 -0800757 QemuOpts *opts = qemu_opts_create(&raw_runtime_opts, NULL, 0,
758 &error_abort);
Markus Armbrusteraf175e82020-07-07 18:06:03 +0200759 if (!qemu_opts_absorb_qdict(opts, options, errp)) {
Stefan Weil68dc0362013-09-01 22:59:25 +0200760 ret = -EINVAL;
761 goto done;
762 }
763
764 filename = qemu_opt_get(opts, "filename");
ths223d4672007-12-15 17:28:36 +0000765
Kevin Wolf0a4279d2016-09-08 15:09:01 +0200766 use_aio = get_aio_option(opts, flags, &local_err);
767 if (!local_err && use_aio) {
768 error_setg(&local_err, "AIO is not supported on Windows host devices");
769 }
770 if (local_err) {
771 error_propagate(errp, local_err);
772 ret = -EINVAL;
773 goto done;
774 }
775
ths223d4672007-12-15 17:28:36 +0000776 if (strstart(filename, "/dev/cdrom", NULL)) {
Stefan Weil68dc0362013-09-01 22:59:25 +0200777 if (find_cdrom(device_name, sizeof(device_name)) < 0) {
Max Reitzc6252b72013-10-10 15:44:02 +0200778 error_setg(errp, "Could not open CD-ROM drive");
Stefan Weil68dc0362013-09-01 22:59:25 +0200779 ret = -ENOENT;
780 goto done;
781 }
ths223d4672007-12-15 17:28:36 +0000782 filename = device_name;
783 } else {
784 /* transform drive letters into device name */
785 if (((filename[0] >= 'a' && filename[0] <= 'z') ||
786 (filename[0] >= 'A' && filename[0] <= 'Z')) &&
787 filename[1] == ':' && filename[2] == '\0') {
788 snprintf(device_name, sizeof(device_name), "\\\\.\\%c:", filename[0]);
789 filename = device_name;
790 }
791 }
792 s->type = find_device_type(bs, filename);
793
Kevin Wolf0a4279d2016-09-08 15:09:01 +0200794 raw_parse_flags(flags, use_aio, &access_flags, &overlapped);
Jeff Cody6a8dc042012-09-20 15:13:21 -0400795
ths223d4672007-12-15 17:28:36 +0000796 create_flags = OPEN_EXISTING;
797
ths223d4672007-12-15 17:28:36 +0000798 s->hfile = CreateFile(filename, access_flags,
799 FILE_SHARE_READ, NULL,
800 create_flags, overlapped, NULL);
801 if (s->hfile == INVALID_HANDLE_VALUE) {
802 int err = GetLastError();
803
Stefan Weil68dc0362013-09-01 22:59:25 +0200804 if (err == ERROR_ACCESS_DENIED) {
805 ret = -EACCES;
806 } else {
Max Reitz45d57f62013-10-11 14:30:16 +0200807 ret = -EINVAL;
Stefan Weil68dc0362013-09-01 22:59:25 +0200808 }
Max Reitz45d57f62013-10-11 14:30:16 +0200809 error_setg_errno(errp, -ret, "Could not open device");
Stefan Weil68dc0362013-09-01 22:59:25 +0200810 goto done;
ths223d4672007-12-15 17:28:36 +0000811 }
Stefan Weil68dc0362013-09-01 22:59:25 +0200812
813done:
814 qemu_opts_del(opts);
815 return ret;
ths223d4672007-12-15 17:28:36 +0000816}
817
Anthony Liguori5efa9d52009-05-09 17:03:42 -0500818static BlockDriver bdrv_host_device = {
aurel32e60f4692009-03-07 22:00:29 +0000819 .format_name = "host_device",
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200820 .protocol_name = "host_device",
aurel32e60f4692009-03-07 22:00:29 +0000821 .instance_size = sizeof(BDRVRawState),
BenoƮt Canet030be322013-09-24 17:07:04 +0200822 .bdrv_needs_filename = true,
Max Reitz57ed25b2014-03-08 00:39:45 +0100823 .bdrv_parse_filename = hdev_parse_filename,
Christoph Hellwig508c7cb2009-06-15 14:04:22 +0200824 .bdrv_probe_device = hdev_probe_device,
Kevin Wolf66f82ce2010-04-14 14:17:38 +0200825 .bdrv_file_open = hdev_open,
aurel32e60f4692009-03-07 22:00:29 +0000826 .bdrv_close = raw_close,
Eric Blakede7056a2018-04-24 14:25:02 -0500827 .bdrv_refresh_limits = hdev_refresh_limits,
ths223d4672007-12-15 17:28:36 +0000828
Eric Blakede7056a2018-04-24 14:25:02 -0500829 .bdrv_aio_preadv = raw_aio_preadv,
830 .bdrv_aio_pwritev = raw_aio_pwritev,
Paolo Bonzinifc4edb82012-06-09 04:48:28 +0200831 .bdrv_aio_flush = raw_aio_flush,
Kevin Wolfc68b89a2011-11-10 17:25:44 +0100832
Stefan Hajnoczi85ebd382014-05-08 16:34:50 +0200833 .bdrv_detach_aio_context = raw_detach_aio_context,
834 .bdrv_attach_aio_context = raw_attach_aio_context,
835
Kevin Wolfb94a2612013-10-29 12:18:58 +0100836 .bdrv_getlength = raw_getlength,
837 .has_variable_length = true,
838
Fam Zheng4a1d5e12011-07-12 19:56:39 +0800839 .bdrv_get_allocated_file_size
840 = raw_get_allocated_file_size,
ths223d4672007-12-15 17:28:36 +0000841};
Anthony Liguori5efa9d52009-05-09 17:03:42 -0500842
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200843static void bdrv_file_init(void)
Anthony Liguori5efa9d52009-05-09 17:03:42 -0500844{
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200845 bdrv_register(&bdrv_file);
Anthony Liguori5efa9d52009-05-09 17:03:42 -0500846 bdrv_register(&bdrv_host_device);
847}
848
Christoph Hellwig84a12e62010-04-07 22:30:24 +0200849block_init(bdrv_file_init);