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_int.h"
  27 #include <assert.h>
  28 #include <windows.h>
  29 #include <winioctl.h>
  30
  31 //#define WIN32_AIO
  32
  33 #define FTYPE_FILE 0
  34 #define FTYPE_CD     1
  35 #define FTYPE_HARDDISK 2
  36
  37 typedef struct BDRVRawState {
  38     HANDLE hfile;
  39     int type;
  40     char drive_path[16]; /* format: "d:\" */
  41 } BDRVRawState;
  42
  43 typedef struct RawAIOCB {
  44     BlockDriverAIOCB common;
  45     HANDLE hEvent;
  46     OVERLAPPED ov;
  47     int count;
  48 } RawAIOCB;
  49
  50 int qemu_ftruncate64(int fd, int64_t length)
  51 {
  52     LARGE_INTEGER li;
  53     LONG high;
  54     HANDLE h;
  55     BOOL res;
  56
  57     if ((GetVersion() & 0x80000000UL) && (length >> 32) != 0)
  58         return -1;
  59
  60     h = (HANDLE)_get_osfhandle(fd);
  61
  62     /* get current position, ftruncate do not change position */
  63     li.HighPart = 0;
  64     li.LowPart = SetFilePointer (h, 0, &li.HighPart, FILE_CURRENT);
  65     if (li.LowPart == 0xffffffffUL && GetLastError() != NO_ERROR)
  66         return -1;
  67
  68     high = length >> 32;
  69     if (!SetFilePointer(h, (DWORD) length, &high, FILE_BEGIN))
  70         return -1;
  71     res = SetEndOfFile(h);
  72
  73     /* back to old position */
  74     SetFilePointer(h, li.LowPart, &li.HighPart, FILE_BEGIN);
  75     return res ? 0 : -1;
  76 }
  77
  78 static int set_sparse(int fd)
  79 {
  80     DWORD returned;
  81     return (int) DeviceIoControl((HANDLE)_get_osfhandle(fd), FSCTL_SET_SPARSE,
  82                                  NULL, 0, NULL, 0, &returned, NULL);
  83 }
  84
  85 static int raw_open(BlockDriverState *bs, const char *filename, int flags)
  86 {
  87     BDRVRawState *s = bs->opaque;
  88     int access_flags, create_flags;
  89     DWORD overlapped;
  90
  91     s->type = FTYPE_FILE;
  92
  93     if ((flags & BDRV_O_ACCESS) == O_RDWR) {
  94         access_flags = GENERIC_READ | GENERIC_WRITE;
  95     } else {
  96         access_flags = GENERIC_READ;
  97     }
  98     if (flags & BDRV_O_CREAT) {
  99         create_flags = CREATE_ALWAYS;
 100     } else {
 101         create_flags = OPEN_EXISTING;
 102     }
 103 #ifdef WIN32_AIO
 104     overlapped = FILE_FLAG_OVERLAPPED;
 105 #else
 106     overlapped = FILE_ATTRIBUTE_NORMAL;
 107 #endif
 108     if ((flags & BDRV_O_NOCACHE))
 109         overlapped |= FILE_FLAG_NO_BUFFERING | FILE_FLAG_WRITE_THROUGH;
 110     else if (!(flags & BDRV_O_CACHE_WB))
 111         overlapped |= FILE_FLAG_WRITE_THROUGH;
 112     s->hfile = CreateFile(filename, access_flags,
 113                           FILE_SHARE_READ, NULL,
 114                           create_flags, overlapped, NULL);
 115     if (s->hfile == INVALID_HANDLE_VALUE) {
 116         int err = GetLastError();
 117
 118         if (err == ERROR_ACCESS_DENIED)
 119             return -EACCES;
 120         return -1;
 121     }
 122     return 0;
 123 }
 124
 125 static int raw_read(BlockDriverState *bs, int64_t sector_num,
 126                     uint8_t *buf, int nb_sectors)
 127 {
 128     BDRVRawState *s = bs->opaque;
 129     OVERLAPPED ov;
 130     DWORD ret_count;
 131     int ret;
 132     int64_t offset = sector_num * 512;
 133     int count = nb_sectors * 512;
 134
 135     memset(&ov, 0, sizeof(ov));
 136     ov.Offset = offset;
 137     ov.OffsetHigh = offset >> 32;
 138     ret = ReadFile(s->hfile, buf, count, &ret_count, &ov);
 139     if (!ret) {
 140 #ifdef WIN32_AIO
 141         ret = GetOverlappedResult(s->hfile, &ov, &ret_count, TRUE);
 142         if (!ret)
 143             return -EIO;
 144         else
 145 #endif
 146             return ret_count;
 147     }
 148     return ret_count;
 149 }
 150
 151 static int raw_write(BlockDriverState *bs, int64_t sector_num,
 152                      const uint8_t *buf, int nb_sectors)
 153 {
 154     BDRVRawState *s = bs->opaque;
 155     OVERLAPPED ov;
 156     DWORD ret_count;
 157     int ret;
 158     int64_t offset = sector_num * 512;
 159     int count = nb_sectors * 512;
 160
 161     memset(&ov, 0, sizeof(ov));
 162     ov.Offset = offset;
 163     ov.OffsetHigh = offset >> 32;
 164     ret = WriteFile(s->hfile, buf, count, &ret_count, &ov);
 165     if (!ret) {
 166 #ifdef WIN32_AIO
 167         ret = GetOverlappedResult(s->hfile, &ov, &ret_count, TRUE);
 168         if (!ret)
 169             return -EIO;
 170         else
 171 #endif
 172             return ret_count;
 173     }
 174     return ret_count;
 175 }
 176
 177 #ifdef WIN32_AIO
 178 static void raw_aio_cb(void *opaque)
 179 {
 180     RawAIOCB *acb = opaque;
 181     BlockDriverState *bs = acb->common.bs;
 182     BDRVRawState *s = bs->opaque;
 183     DWORD ret_count;
 184     int ret;
 185
 186     ret = GetOverlappedResult(s->hfile, &acb->ov, &ret_count, TRUE);
 187     if (!ret || ret_count != acb->count) {
 188         acb->common.cb(acb->common.opaque, -EIO);
 189     } else {
 190         acb->common.cb(acb->common.opaque, 0);
 191     }
 192 }
 193
 194 static RawAIOCB *raw_aio_setup(BlockDriverState *bs,
 195         int64_t sector_num, uint8_t *buf, int nb_sectors,
 196         BlockDriverCompletionFunc *cb, void *opaque)
 197 {
 198     RawAIOCB *acb;
 199     int64_t offset;
 200
 201     acb = qemu_aio_get(bs, cb, opaque);
 202     if (acb->hEvent) {
 203         acb->hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
 204         if (!acb->hEvent) {
 205             qemu_aio_release(acb);
 206             return NULL;
 207         }
 208     }
 209     memset(&acb->ov, 0, sizeof(acb->ov));
 210     offset = sector_num * 512;
 211     acb->ov.Offset = offset;
 212     acb->ov.OffsetHigh = offset >> 32;
 213     acb->ov.hEvent = acb->hEvent;
 214     acb->count = nb_sectors * 512;
 215     qemu_add_wait_object(acb->ov.hEvent, raw_aio_cb, acb);
 216     return acb;
 217 }
 218
 219 static BlockDriverAIOCB *raw_aio_read(BlockDriverState *bs,
 220         int64_t sector_num, uint8_t *buf, int nb_sectors,
 221         BlockDriverCompletionFunc *cb, void *opaque)
 222 {
 223     BDRVRawState *s = bs->opaque;
 224     RawAIOCB *acb;
 225     int ret;
 226
 227     acb = raw_aio_setup(bs, sector_num, buf, nb_sectors, cb, opaque);
 228     if (!acb)
 229         return NULL;
 230     ret = ReadFile(s->hfile, buf, acb->count, NULL, &acb->ov);
 231     if (!ret) {
 232         qemu_aio_release(acb);
 233         return NULL;
 234     }
 235     qemu_aio_release(acb);
 236     return (BlockDriverAIOCB *)acb;
 237 }
 238
 239 static BlockDriverAIOCB *raw_aio_write(BlockDriverState *bs,
 240         int64_t sector_num, uint8_t *buf, int nb_sectors,
 241         BlockDriverCompletionFunc *cb, void *opaque)
 242 {
 243     BDRVRawState *s = bs->opaque;
 244     RawAIOCB *acb;
 245     int ret;
 246
 247     acb = raw_aio_setup(bs, sector_num, buf, nb_sectors, cb, opaque);
 248     if (!acb)
 249         return NULL;
 250     ret = WriteFile(s->hfile, buf, acb->count, NULL, &acb->ov);
 251     if (!ret) {
 252         qemu_aio_release(acb);
 253         return NULL;
 254     }
 255     qemu_aio_release(acb);
 256     return (BlockDriverAIOCB *)acb;
 257 }
 258
 259 static void raw_aio_cancel(BlockDriverAIOCB *blockacb)
 260 {
 261     RawAIOCB *acb = (RawAIOCB *)blockacb;
 262     BlockDriverState *bs = acb->common.bs;
 263     BDRVRawState *s = bs->opaque;
 264
 265     qemu_del_wait_object(acb->ov.hEvent, raw_aio_cb, acb);
 266     /* XXX: if more than one async I/O it is not correct */
 267     CancelIo(s->hfile);
 268     qemu_aio_release(acb);
 269 }
 270 #endif /* #if WIN32_AIO */
 271
 272 static void raw_flush(BlockDriverState *bs)
 273 {
 274     BDRVRawState *s = bs->opaque;
 275     FlushFileBuffers(s->hfile);
 276 }
 277
 278 static void raw_close(BlockDriverState *bs)
 279 {
 280     BDRVRawState *s = bs->opaque;
 281     CloseHandle(s->hfile);
 282 }
 283
 284 static int raw_truncate(BlockDriverState *bs, int64_t offset)
 285 {
 286     BDRVRawState *s = bs->opaque;
 287     DWORD low, high;
 288
 289     low = offset;
 290     high = offset >> 32;
 291     if (!SetFilePointer(s->hfile, low, &high, FILE_BEGIN))
 292         return -EIO;
 293     if (!SetEndOfFile(s->hfile))
 294         return -EIO;
 295     return 0;
 296 }
 297
 298 static int64_t raw_getlength(BlockDriverState *bs)
 299 {
 300     BDRVRawState *s = bs->opaque;
 301     LARGE_INTEGER l;
 302     ULARGE_INTEGER available, total, total_free;
 303     DISK_GEOMETRY_EX dg;
 304     DWORD count;
 305     BOOL status;
 306
 307     switch(s->type) {
 308     case FTYPE_FILE:
 309         l.LowPart = GetFileSize(s->hfile, &l.HighPart);
 310         if (l.LowPart == 0xffffffffUL && GetLastError() != NO_ERROR)
 311             return -EIO;
 312         break;
 313     case FTYPE_CD:
 314         if (!GetDiskFreeSpaceEx(s->drive_path, &available, &total, &total_free))
 315             return -EIO;
 316         l.QuadPart = total.QuadPart;
 317         break;
 318     case FTYPE_HARDDISK:
 319         status = DeviceIoControl(s->hfile, IOCTL_DISK_GET_DRIVE_GEOMETRY_EX,
 320                                  NULL, 0, &dg, sizeof(dg), &count, NULL);
 321         if (status != 0) {
 322             l = dg.DiskSize;
 323         }
 324         break;
 325     default:
 326         return -EIO;
 327     }
 328     return l.QuadPart;
 329 }
 330
 331 static int raw_create(const char *filename, int64_t total_size,
 332                       const char *backing_file, int flags)
 333 {
 334     int fd;
 335
 336     if (flags || backing_file)
 337         return -ENOTSUP;
 338
 339     fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY,
 340               0644);
 341     if (fd < 0)
 342         return -EIO;
 343     set_sparse(fd);
 344     ftruncate(fd, total_size * 512);
 345     close(fd);
 346     return 0;
 347 }
 348
 349 BlockDriver bdrv_raw = {
 350     "raw",
 351     sizeof(BDRVRawState),
 352     NULL, /* no probe for protocols */
 353     raw_open,
 354     NULL,
 355     NULL,
 356     raw_close,
 357     raw_create,
 358     raw_flush,
 359
 360 #ifdef WIN32_AIO
 361     .bdrv_aio_read = raw_aio_read,
 362     .bdrv_aio_write = raw_aio_write,
 363     .bdrv_aio_cancel = raw_aio_cancel,
 364     .aiocb_size = sizeof(RawAIOCB);
 365 #endif
 366     .bdrv_read = raw_read,
 367     .bdrv_write = raw_write,
 368     .bdrv_truncate = raw_truncate,
 369     .bdrv_getlength = raw_getlength,
 370 };
 371
 372 /***********************************************/
 373 /* host device */
 374
 375 static int find_cdrom(char *cdrom_name, int cdrom_name_size)
 376 {
 377     char drives[256], *pdrv = drives;
 378     UINT type;
 379
 380     memset(drives, 0, sizeof(drives));
 381     GetLogicalDriveStrings(sizeof(drives), drives);
 382     while(pdrv[0] != '\0') {
 383         type = GetDriveType(pdrv);
 384         switch(type) {
 385         case DRIVE_CDROM:
 386             snprintf(cdrom_name, cdrom_name_size, "\\\\.\\%c:", pdrv[0]);
 387             return 0;
 388             break;
 389         }
 390         pdrv += lstrlen(pdrv) + 1;
 391     }
 392     return -1;
 393 }
 394
 395 static int find_device_type(BlockDriverState *bs, const char *filename)
 396 {
 397     BDRVRawState *s = bs->opaque;
 398     UINT type;
 399     const char *p;
 400
 401     if (strstart(filename, "\\\\.\\", &p) ||
 402         strstart(filename, "//./", &p)) {
 403         if (stristart(p, "PhysicalDrive", NULL))
 404             return FTYPE_HARDDISK;
 405         snprintf(s->drive_path, sizeof(s->drive_path), "%c:\\", p[0]);
 406         type = GetDriveType(s->drive_path);
 407         if (type == DRIVE_CDROM)
 408             return FTYPE_CD;
 409         else
 410             return FTYPE_FILE;
 411     } else {
 412         return FTYPE_FILE;
 413     }
 414 }
 415
 416 static int hdev_open(BlockDriverState *bs, const char *filename, int flags)
 417 {
 418     BDRVRawState *s = bs->opaque;
 419     int access_flags, create_flags;
 420     DWORD overlapped;
 421     char device_name[64];
 422
 423     if (strstart(filename, "/dev/cdrom", NULL)) {
 424         if (find_cdrom(device_name, sizeof(device_name)) < 0)
 425             return -ENOENT;
 426         filename = device_name;
 427     } else {
 428         /* transform drive letters into device name */
 429         if (((filename[0] >= 'a' && filename[0] <= 'z') ||
 430              (filename[0] >= 'A' && filename[0] <= 'Z')) &&
 431             filename[1] == ':' && filename[2] == '\0') {
 432             snprintf(device_name, sizeof(device_name), "\\\\.\\%c:", filename[0]);
 433             filename = device_name;
 434         }
 435     }
 436     s->type = find_device_type(bs, filename);
 437
 438     if ((flags & BDRV_O_ACCESS) == O_RDWR) {
 439         access_flags = GENERIC_READ | GENERIC_WRITE;
 440     } else {
 441         access_flags = GENERIC_READ;
 442     }
 443     create_flags = OPEN_EXISTING;
 444
 445 #ifdef WIN32_AIO
 446     overlapped = FILE_FLAG_OVERLAPPED;
 447 #else
 448     overlapped = FILE_ATTRIBUTE_NORMAL;
 449 #endif
 450     if ((flags & BDRV_O_NOCACHE))
 451         overlapped |= FILE_FLAG_NO_BUFFERING | FILE_FLAG_WRITE_THROUGH;
 452     else if (!(flags & BDRV_O_CACHE_WB))
 453         overlapped |= FILE_FLAG_WRITE_THROUGH;
 454     s->hfile = CreateFile(filename, access_flags,
 455                           FILE_SHARE_READ, NULL,
 456                           create_flags, overlapped, NULL);
 457     if (s->hfile == INVALID_HANDLE_VALUE) {
 458         int err = GetLastError();
 459
 460         if (err == ERROR_ACCESS_DENIED)
 461             return -EACCES;
 462         return -1;
 463     }
 464     return 0;
 465 }
 466
 467 #if 0
 468 /***********************************************/
 469 /* removable device additional commands */
 470
 471 static int raw_is_inserted(BlockDriverState *bs)
 472 {
 473     return 1;
 474 }
 475
 476 static int raw_media_changed(BlockDriverState *bs)
 477 {
 478     return -ENOTSUP;
 479 }
 480
 481 static int raw_eject(BlockDriverState *bs, int eject_flag)
 482 {
 483     DWORD ret_count;
 484
 485     if (s->type == FTYPE_FILE)
 486         return -ENOTSUP;
 487     if (eject_flag) {
 488         DeviceIoControl(s->hfile, IOCTL_STORAGE_EJECT_MEDIA,
 489                         NULL, 0, NULL, 0, &lpBytesReturned, NULL);
 490     } else {
 491         DeviceIoControl(s->hfile, IOCTL_STORAGE_LOAD_MEDIA,
 492                         NULL, 0, NULL, 0, &lpBytesReturned, NULL);
 493     }
 494 }
 495
 496 static int raw_set_locked(BlockDriverState *bs, int locked)
 497 {
 498     return -ENOTSUP;
 499 }
 500 #endif
 501
 502 BlockDriver bdrv_host_device = {
 503     .format_name        = "host_device",
 504     .instance_size      = sizeof(BDRVRawState),
 505     .bdrv_open          = hdev_open,
 506     .bdrv_close         = raw_close,
 507     .bdrv_flush         = raw_flush,
 508
 509 #ifdef WIN32_AIO
 510     .bdrv_aio_read      = raw_aio_read,
 511     .bdrv_aio_write     = raw_aio_write,
 512     .bdrv_aio_cancel    = raw_aio_cancel,
 513     .aiocb_size         = sizeof(RawAIOCB);
 514 #endif
 515     .bdrv_read          = raw_read,
 516     .bdrv_write         = raw_write,
 517     .bdrv_getlength     = raw_getlength,
 518 };