block/raw-win32.c

   1 /*
   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  */
  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>
  34
  35 #define FTYPE_FILE 0
  36 #define FTYPE_CD     1
  37 #define FTYPE_HARDDISK 2
  38
  39 static QEMUWin32AIOState *aio;
  40
  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;
  50
  51 typedef struct BDRVRawState {
  52     HANDLE hfile;
  53     int type;
  54     char drive_path[16]; /* format: "d:\" */
  55     QEMUWin32AIOState *aio;
  56 } BDRVRawState;
  57
  58 /*
  59  * Read/writes the data to/from a given linear buffer.
  60  *
  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.
  63  */
  64 static size_t handle_aiocb_rw(RawWin32AIOData *aiocb)
  65 {
  66     size_t offset = 0;
  67     int i;
  68
  69     for (i = 0; i < aiocb->aio_niov; i++) {
  70         OVERLAPPED ov;
  71         DWORD ret, ret_count, len;
  72
  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);
  83         }
  84         if (!ret) {
  85             ret_count = 0;
  86         }
  87         if (ret_count != len) {
  88             break;
  89         }
  90         offset += len;
  91     }
  92
  93     return offset;
  94 }
  95
  96 static int aio_worker(void *arg)
  97 {
  98     RawWin32AIOData *aiocb = arg;
  99     ssize_t ret = 0;
 100     size_t count;
 101
 102     switch (aiocb->aio_type & QEMU_AIO_TYPE_MASK) {
 103     case QEMU_AIO_READ:
 104         count = handle_aiocb_rw(aiocb);
 105         if (count < aiocb->aio_nbytes && aiocb->bs->growable) {
 106             /* A short read means that we have reached EOF. Pad the buffer
 107              * with zeros for bytes after EOF. */
 108             iov_memset(aiocb->aio_iov, aiocb->aio_niov, count,
 109                       0, aiocb->aio_nbytes - count);
 110
 111             count = aiocb->aio_nbytes;
 112         }
 113         if (count == aiocb->aio_nbytes) {
 114             ret = 0;
 115         } else {
 116             ret = -EINVAL;
 117         }
 118         break;
 119     case QEMU_AIO_WRITE:
 120         count = handle_aiocb_rw(aiocb);
 121         if (count == aiocb->aio_nbytes) {
 122             count = 0;
 123         } else {
 124             count = -EINVAL;
 125         }
 126         break;
 127     case QEMU_AIO_FLUSH:
 128         if (!FlushFileBuffers(aiocb->hfile)) {
 129             return -EIO;
 130         }
 131         break;
 132     default:
 133         fprintf(stderr, "invalid aio request (0x%x)\n", aiocb->aio_type);
 134         ret = -EINVAL;
 135         break;
 136     }
 137
 138     g_slice_free(RawWin32AIOData, aiocb);
 139     return ret;
 140 }
 141
 142 static BlockDriverAIOCB *paio_submit(BlockDriverState *bs, HANDLE hfile,
 143         int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
 144         BlockDriverCompletionFunc *cb, void *opaque, int type)
 145 {
 146     RawWin32AIOData *acb = g_slice_new(RawWin32AIOData);
 147     ThreadPool *pool;
 148
 149     acb->bs = bs;
 150     acb->hfile = hfile;
 151     acb->aio_type = type;
 152
 153     if (qiov) {
 154         acb->aio_iov = qiov->iov;
 155         acb->aio_niov = qiov->niov;
 156     }
 157     acb->aio_nbytes = nb_sectors * 512;
 158     acb->aio_offset = sector_num * 512;
 159
 160     trace_paio_submit(acb, opaque, sector_num, nb_sectors, type);
 161     pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
 162     return thread_pool_submit_aio(pool, aio_worker, acb, cb, opaque);
 163 }
 164
 165 int qemu_ftruncate64(int fd, int64_t length)
 166 {
 167     LARGE_INTEGER li;
 168     DWORD dw;
 169     LONG high;
 170     HANDLE h;
 171     BOOL res;
 172
 173     if ((GetVersion() & 0x80000000UL) && (length >> 32) != 0)
 174         return -1;
 175
 176     h = (HANDLE)_get_osfhandle(fd);
 177
 178     /* get current position, ftruncate do not change position */
 179     li.HighPart = 0;
 180     li.LowPart = SetFilePointer (h, 0, &li.HighPart, FILE_CURRENT);
 181     if (li.LowPart == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
 182         return -1;
 183     }
 184
 185     high = length >> 32;
 186     dw = SetFilePointer(h, (DWORD) length, &high, FILE_BEGIN);
 187     if (dw == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
 188         return -1;
 189     }
 190     res = SetEndOfFile(h);
 191
 192     /* back to old position */
 193     SetFilePointer(h, li.LowPart, &li.HighPart, FILE_BEGIN);
 194     return res ? 0 : -1;
 195 }
 196
 197 static int set_sparse(int fd)
 198 {
 199     DWORD returned;
 200     return (int) DeviceIoControl((HANDLE)_get_osfhandle(fd), FSCTL_SET_SPARSE,
 201                                  NULL, 0, NULL, 0, &returned, NULL);
 202 }
 203
 204 static void raw_parse_flags(int flags, int *access_flags, DWORD *overlapped)
 205 {
 206     assert(access_flags != NULL);
 207     assert(overlapped != NULL);
 208
 209     if (flags & BDRV_O_RDWR) {
 210         *access_flags = GENERIC_READ | GENERIC_WRITE;
 211     } else {
 212         *access_flags = GENERIC_READ;
 213     }
 214
 215     *overlapped = FILE_ATTRIBUTE_NORMAL;
 216     if (flags & BDRV_O_NATIVE_AIO) {
 217         *overlapped |= FILE_FLAG_OVERLAPPED;
 218     }
 219     if (flags & BDRV_O_NOCACHE) {
 220         *overlapped |= FILE_FLAG_NO_BUFFERING;
 221     }
 222 }
 223
 224 static QemuOptsList raw_runtime_opts = {
 225     .name = "raw",
 226     .head = QTAILQ_HEAD_INITIALIZER(raw_runtime_opts.head),
 227     .desc = {
 228         {
 229             .name = "filename",
 230             .type = QEMU_OPT_STRING,
 231             .help = "File name of the image",
 232         },
 233         { /* end of list */ }
 234     },
 235 };
 236
 237 static int raw_open(BlockDriverState *bs, const char *unused,
 238                     QDict *options, int flags)
 239 {
 240     BDRVRawState *s = bs->opaque;
 241     int access_flags;
 242     DWORD overlapped;
 243     QemuOpts *opts;
 244     Error *local_err = NULL;
 245     const char *filename;
 246     int ret;
 247
 248     s->type = FTYPE_FILE;
 249
 250     opts = qemu_opts_create_nofail(&raw_runtime_opts);
 251     qemu_opts_absorb_qdict(opts, options, &local_err);
 252     if (error_is_set(&local_err)) {
 253         qerror_report_err(local_err);
 254         error_free(local_err);
 255         ret = -EINVAL;
 256         goto fail;
 257     }
 258
 259     filename = qemu_opt_get(opts, "filename");
 260
 261     raw_parse_flags(flags, &access_flags, &overlapped);
 262
 263     if ((flags & BDRV_O_NATIVE_AIO) && aio == NULL) {
 264         aio = win32_aio_init();
 265         if (aio == NULL) {
 266             ret = -EINVAL;
 267             goto fail;
 268         }
 269     }
 270
 271     s->hfile = CreateFile(filename, access_flags,
 272                           FILE_SHARE_READ, NULL,
 273                           OPEN_EXISTING, overlapped, NULL);
 274     if (s->hfile == INVALID_HANDLE_VALUE) {
 275         int err = GetLastError();
 276
 277         if (err == ERROR_ACCESS_DENIED) {
 278             ret = -EACCES;
 279         } else {
 280             ret = -EINVAL;
 281         }
 282         goto fail;
 283     }
 284
 285     if (flags & BDRV_O_NATIVE_AIO) {
 286         ret = win32_aio_attach(aio, s->hfile);
 287         if (ret < 0) {
 288             CloseHandle(s->hfile);
 289             goto fail;
 290         }
 291         s->aio = aio;
 292     }
 293
 294     ret = 0;
 295 fail:
 296     qemu_opts_del(opts);
 297     return ret;
 298 }
 299
 300 static BlockDriverAIOCB *raw_aio_readv(BlockDriverState *bs,
 301                          int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
 302                          BlockDriverCompletionFunc *cb, void *opaque)
 303 {
 304     BDRVRawState *s = bs->opaque;
 305     if (s->aio) {
 306         return win32_aio_submit(bs, s->aio, s->hfile, sector_num, qiov,
 307                                 nb_sectors, cb, opaque, QEMU_AIO_READ);
 308     } else {
 309         return paio_submit(bs, s->hfile, sector_num, qiov, nb_sectors,
 310                            cb, opaque, QEMU_AIO_READ);
 311     }
 312 }
 313
 314 static BlockDriverAIOCB *raw_aio_writev(BlockDriverState *bs,
 315                           int64_t sector_num, QEMUIOVector *qiov, int nb_sectors,
 316                           BlockDriverCompletionFunc *cb, void *opaque)
 317 {
 318     BDRVRawState *s = bs->opaque;
 319     if (s->aio) {
 320         return win32_aio_submit(bs, s->aio, s->hfile, sector_num, qiov,
 321                                 nb_sectors, cb, opaque, QEMU_AIO_WRITE);
 322     } else {
 323         return paio_submit(bs, s->hfile, sector_num, qiov, nb_sectors,
 324                            cb, opaque, QEMU_AIO_WRITE);
 325     }
 326 }
 327
 328 static BlockDriverAIOCB *raw_aio_flush(BlockDriverState *bs,
 329                          BlockDriverCompletionFunc *cb, void *opaque)
 330 {
 331     BDRVRawState *s = bs->opaque;
 332     return paio_submit(bs, s->hfile, 0, NULL, 0, cb, opaque, QEMU_AIO_FLUSH);
 333 }
 334
 335 static void raw_close(BlockDriverState *bs)
 336 {
 337     BDRVRawState *s = bs->opaque;
 338     CloseHandle(s->hfile);
 339 }
 340
 341 static int raw_truncate(BlockDriverState *bs, int64_t offset)
 342 {
 343     BDRVRawState *s = bs->opaque;
 344     LONG low, high;
 345     DWORD dwPtrLow;
 346
 347     low = offset;
 348     high = offset >> 32;
 349
 350     /*
 351      * An error has occurred if the return value is INVALID_SET_FILE_POINTER
 352      * and GetLastError doesn't return NO_ERROR.
 353      */
 354     dwPtrLow = SetFilePointer(s->hfile, low, &high, FILE_BEGIN);
 355     if (dwPtrLow == INVALID_SET_FILE_POINTER && GetLastError() != NO_ERROR) {
 356         fprintf(stderr, "SetFilePointer error: %lu\n", GetLastError());
 357         return -EIO;
 358     }
 359     if (SetEndOfFile(s->hfile) == 0) {
 360         fprintf(stderr, "SetEndOfFile error: %lu\n", GetLastError());
 361         return -EIO;
 362     }
 363     return 0;
 364 }
 365
 366 static int64_t raw_getlength(BlockDriverState *bs)
 367 {
 368     BDRVRawState *s = bs->opaque;
 369     LARGE_INTEGER l;
 370     ULARGE_INTEGER available, total, total_free;
 371     DISK_GEOMETRY_EX dg;
 372     DWORD count;
 373     BOOL status;
 374
 375     switch(s->type) {
 376     case FTYPE_FILE:
 377         l.LowPart = GetFileSize(s->hfile, (PDWORD)&l.HighPart);
 378         if (l.LowPart == 0xffffffffUL && GetLastError() != NO_ERROR)
 379             return -EIO;
 380         break;
 381     case FTYPE_CD:
 382         if (!GetDiskFreeSpaceEx(s->drive_path, &available, &total, &total_free))
 383             return -EIO;
 384         l.QuadPart = total.QuadPart;
 385         break;
 386     case FTYPE_HARDDISK:
 387         status = DeviceIoControl(s->hfile, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX,
 388                                  NULL, 0, &dg, sizeof(dg), &count, NULL);
 389         if (status != 0) {
 390             l = dg.DiskSize;
 391         }
 392         break;
 393     default:
 394         return -EIO;
 395     }
 396     return l.QuadPart;
 397 }
 398
 399 static int64_t raw_get_allocated_file_size(BlockDriverState *bs)
 400 {
 401     typedef DWORD (WINAPI * get_compressed_t)(const char *filename,
 402                                               DWORD * high);
 403     get_compressed_t get_compressed;
 404     struct _stati64 st;
 405     const char *filename = bs->filename;
 406     /* WinNT support GetCompressedFileSize to determine allocate size */
 407     get_compressed =
 408         (get_compressed_t) GetProcAddress(GetModuleHandle("kernel32"),
 409                                             "GetCompressedFileSizeA");
 410     if (get_compressed) {
 411         DWORD high, low;
 412         low = get_compressed(filename, &high);
 413         if (low != 0xFFFFFFFFlu || GetLastError() == NO_ERROR) {
 414             return (((int64_t) high) << 32) + low;
 415         }
 416     }
 417
 418     if (_stati64(filename, &st) < 0) {
 419         return -1;
 420     }
 421     return st.st_size;
 422 }
 423
 424 static int raw_create(const char *filename, QEMUOptionParameter *options)
 425 {
 426     int fd;
 427     int64_t total_size = 0;
 428
 429     /* Read out options */
 430     while (options && options->name) {
 431         if (!strcmp(options->name, BLOCK_OPT_SIZE)) {
 432             total_size = options->value.n / 512;
 433         }
 434         options++;
 435     }
 436
 437     fd = qemu_open(filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY,
 438                    0644);
 439     if (fd < 0)
 440         return -EIO;
 441     set_sparse(fd);
 442     ftruncate(fd, total_size * 512);
 443     qemu_close(fd);
 444     return 0;
 445 }
 446
 447 static QEMUOptionParameter raw_create_options[] = {
 448     {
 449         .name = BLOCK_OPT_SIZE,
 450         .type = OPT_SIZE,
 451         .help = "Virtual disk size"
 452     },
 453     { NULL }
 454 };
 455
 456 static BlockDriver bdrv_file = {
 457     .format_name        = "file",
 458     .protocol_name      = "file",
 459     .instance_size      = sizeof(BDRVRawState),
 460     .bdrv_file_open     = raw_open,
 461     .bdrv_close         = raw_close,
 462     .bdrv_create        = raw_create,
 463
 464     .bdrv_aio_readv     = raw_aio_readv,
 465     .bdrv_aio_writev    = raw_aio_writev,
 466     .bdrv_aio_flush     = raw_aio_flush,
 467
 468     .bdrv_truncate      = raw_truncate,
 469     .bdrv_getlength     = raw_getlength,
 470     .bdrv_get_allocated_file_size
 471                         = raw_get_allocated_file_size,
 472
 473     .create_options = raw_create_options,
 474 };
 475
 476 /***********************************************/
 477 /* host device */
 478
 479 static int find_cdrom(char *cdrom_name, int cdrom_name_size)
 480 {
 481     char drives[256], *pdrv = drives;
 482     UINT type;
 483
 484     memset(drives, 0, sizeof(drives));
 485     GetLogicalDriveStrings(sizeof(drives), drives);
 486     while(pdrv[0] != '\0') {
 487         type = GetDriveType(pdrv);
 488         switch(type) {
 489         case DRIVE_CDROM:
 490             snprintf(cdrom_name, cdrom_name_size, "\\\\.\\%c:", pdrv[0]);
 491             return 0;
 492             break;
 493         }
 494         pdrv += lstrlen(pdrv) + 1;
 495     }
 496     return -1;
 497 }
 498
 499 static int find_device_type(BlockDriverState *bs, const char *filename)
 500 {
 501     BDRVRawState *s = bs->opaque;
 502     UINT type;
 503     const char *p;
 504
 505     if (strstart(filename, "\\\\.\\", &p) ||
 506         strstart(filename, "//./", &p)) {
 507         if (stristart(p, "PhysicalDrive", NULL))
 508             return FTYPE_HARDDISK;
 509         snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", p[0]);
 510         type = GetDriveType(s->drive_path);
 511         switch (type) {
 512         case DRIVE_REMOVABLE:
 513         case DRIVE_FIXED:
 514             return FTYPE_HARDDISK;
 515         case DRIVE_CDROM:
 516             return FTYPE_CD;
 517         default:
 518             return FTYPE_FILE;
 519         }
 520     } else {
 521         return FTYPE_FILE;
 522     }
 523 }
 524
 525 static int hdev_probe_device(const char *filename)
 526 {
 527     if (strstart(filename, "/dev/cdrom", NULL))
 528         return 100;
 529     if (is_windows_drive(filename))
 530         return 100;
 531     return 0;
 532 }
 533
 534 static int hdev_open(BlockDriverState *bs, const char *dummy,
 535                      QDict *options, int flags)
 536 {
 537     BDRVRawState *s = bs->opaque;
 538     int access_flags, create_flags;
 539     DWORD overlapped;
 540     char device_name[64];
 541     const char *filename = qdict_get_str(options, "filename");
 542
 543     if (strstart(filename, "/dev/cdrom", NULL)) {
 544         if (find_cdrom(device_name, sizeof(device_name)) < 0)
 545             return -ENOENT;
 546         filename = device_name;
 547     } else {
 548         /* transform drive letters into device name */
 549         if (((filename[0] >= 'a' && filename[0] <= 'z') ||
 550              (filename[0] >= 'A' && filename[0] <= 'Z')) &&
 551             filename[1] == ':' && filename[2] == '\0') {
 552             snprintf(device_name, sizeof(device_name), "\\\\.\\%c:", filename[0]);
 553             filename = device_name;
 554         }
 555     }
 556     s->type = find_device_type(bs, filename);
 557
 558     raw_parse_flags(flags, &access_flags, &overlapped);
 559
 560     create_flags = OPEN_EXISTING;
 561
 562     s->hfile = CreateFile(filename, access_flags,
 563                           FILE_SHARE_READ, NULL,
 564                           create_flags, overlapped, NULL);
 565     if (s->hfile == INVALID_HANDLE_VALUE) {
 566         int err = GetLastError();
 567
 568         if (err == ERROR_ACCESS_DENIED)
 569             return -EACCES;
 570         return -1;
 571     }
 572     return 0;
 573 }
 574
 575 static int hdev_has_zero_init(BlockDriverState *bs)
 576 {
 577     return 0;
 578 }
 579
 580 static BlockDriver bdrv_host_device = {
 581     .format_name        = "host_device",
 582     .protocol_name      = "host_device",
 583     .instance_size      = sizeof(BDRVRawState),
 584     .bdrv_probe_device  = hdev_probe_device,
 585     .bdrv_file_open     = hdev_open,
 586     .bdrv_close         = raw_close,
 587     .bdrv_has_zero_init = hdev_has_zero_init,
 588
 589     .bdrv_aio_readv     = raw_aio_readv,
 590     .bdrv_aio_writev    = raw_aio_writev,
 591     .bdrv_aio_flush     = raw_aio_flush,
 592
 593     .bdrv_getlength     = raw_getlength,
 594     .bdrv_get_allocated_file_size
 595                         = raw_get_allocated_file_size,
 596 };
 597
 598 static void bdrv_file_init(void)
 599 {
 600     bdrv_register(&bdrv_file);
 601     bdrv_register(&bdrv_host_device);
 602 }
 603
 604 block_init(bdrv_file_init);