engines/windowsaio.c

   1 /*
   2  * Native Windows async IO engine
   3  * Copyright (C) 2011 Bruce Cran <bruce@cran.org.uk>
   4  */
   5
   6 #include <stdio.h>
   7 #include <stdlib.h>
   8 #include <unistd.h>
   9 #include <signal.h>
  10 #include <errno.h>
  11 #include <windows.h>
  12
  13 #include "../fio.h"
  14
  15 typedef BOOL (WINAPI *CANCELIOEX)(HANDLE hFile, LPOVERLAPPED lpOverlapped);
  16
  17 struct fio_overlapped {
  18         OVERLAPPED o;
  19         struct io_u *io_u;
  20         BOOL io_complete;
  21         BOOL io_free;
  22 };
  23
  24 struct windowsaio_data {
  25         struct fio_overlapped *ovls;
  26         struct io_u **aio_events;
  27         HANDLE iothread;
  28         HANDLE iocomplete_event;
  29         CANCELIOEX pCancelIoEx;
  30         BOOL iothread_running;
  31 };
  32
  33 struct thread_ctx {
  34         HANDLE iocp;
  35         struct windowsaio_data *wd;
  36 };
  37
  38 static int fio_windowsaio_cancel(struct thread_data *td,
  39                                struct io_u *io_u);
  40 static BOOL timeout_expired(DWORD start_count, DWORD end_count);
  41 static int fio_windowsaio_getevents(struct thread_data *td, unsigned int min,
  42                                     unsigned int max, struct timespec *t);
  43 static struct io_u *fio_windowsaio_event(struct thread_data *td, int event);
  44 static int fio_windowsaio_queue(struct thread_data *td,
  45                               struct io_u *io_u);
  46 static void fio_windowsaio_cleanup(struct thread_data *td);
  47 static DWORD WINAPI IoCompletionRoutine(LPVOID lpParameter);
  48 static int fio_windowsaio_init(struct thread_data *td);
  49 static int fio_windowsaio_open_file(struct thread_data *td, struct fio_file *f);
  50 static int fio_windowsaio_close_file(struct thread_data fio_unused *td, struct fio_file *f);
  51
  52 int sync_file_range(int fd, off64_t offset, off64_t nbytes,
  53                            unsigned int flags)
  54 {
  55         errno = ENOSYS;
  56         return -1;
  57 }
  58
  59 static int fio_windowsaio_init(struct thread_data *td)
  60 {
  61         struct windowsaio_data *wd;
  62         HANDLE hKernel32Dll;
  63         int rc = 0;
  64         int i;
  65
  66         wd = malloc(sizeof(struct windowsaio_data));
  67         if (wd != NULL)
  68                 ZeroMemory(wd, sizeof(struct windowsaio_data));
  69         else
  70                 rc = 1;
  71
  72         if (!rc) {
  73                 wd->aio_events = malloc(td->o.iodepth * sizeof(struct io_u*));
  74                 if (wd->aio_events == NULL)
  75                         rc = 1;
  76         }
  77
  78         if (!rc) {
  79                 wd->ovls = malloc(td->o.iodepth * sizeof(struct fio_overlapped));
  80                 if (wd->ovls == NULL)
  81                         rc = 1;
  82         }
  83
  84         if (!rc) {
  85             for (i = 0; i < td->o.iodepth; i++) {
  86                 wd->ovls[i].io_free = TRUE;
  87                 wd->ovls[i].io_complete = FALSE;
  88
  89                         wd->ovls[i].o.hEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
  90                         if (wd->ovls[i].o.hEvent == NULL) {
  91                                 rc = 1;
  92                                 break;
  93                         }
  94             }
  95         }
  96
  97         if (!rc) {
  98                 /* Create an auto-reset event */
  99                 wd->iocomplete_event = CreateEvent(NULL, FALSE, FALSE, NULL);
 100                 if (wd->iocomplete_event == NULL)
 101                         rc = 1;
 102         }
 103
 104         if (rc) {
 105                 if (wd != NULL) {
 106                         if (wd->ovls != NULL)
 107                                 free(wd->ovls);
 108                         if (wd->aio_events != NULL)
 109                                 free(wd->aio_events);
 110
 111                         free(wd);
 112                 }
 113         }
 114
 115         hKernel32Dll = GetModuleHandle("kernel32.dll");
 116         wd->pCancelIoEx = GetProcAddress(hKernel32Dll, "CancelIoEx");
 117
 118         td->io_ops->data = wd;
 119         return rc;
 120 }
 121
 122 static void fio_windowsaio_cleanup(struct thread_data *td)
 123 {
 124         int i;
 125         struct windowsaio_data *wd;
 126
 127         wd = td->io_ops->data;
 128
 129         if (wd != NULL) {
 130                 wd->iothread_running = FALSE;
 131                 WaitForSingleObject(wd->iothread, INFINITE);
 132
 133                 CloseHandle(wd->iothread);
 134                 CloseHandle(wd->iocomplete_event);
 135
 136                 for (i = 0; i < td->o.iodepth; i++)
 137                         CloseHandle(wd->ovls[i].o.hEvent);
 138
 139                 free(wd->aio_events);
 140                 free(wd->ovls);
 141                 free(wd);
 142
 143                 td->io_ops->data = NULL;
 144         }
 145 }
 146
 147
 148 static int fio_windowsaio_open_file(struct thread_data *td, struct fio_file *f)
 149 {
 150         int rc = 0;
 151         HANDLE hFile;
 152         DWORD flags = FILE_FLAG_POSIX_SEMANTICS | FILE_FLAG_OVERLAPPED;
 153         DWORD sharemode = FILE_SHARE_READ | FILE_SHARE_WRITE;
 154         DWORD openmode = OPEN_ALWAYS;
 155         DWORD access;
 156
 157         dprint(FD_FILE, "fd open %s\n", f->file_name);
 158
 159         if (f->filetype == FIO_TYPE_PIPE) {
 160                 log_err("fio: windowsaio doesn't support pipes\n");
 161                 return 1;
 162         }
 163
 164         if (!strcmp(f->file_name, "-")) {
 165                 log_err("fio: can't read/write to stdin/out\n");
 166                 return 1;
 167         }
 168
 169         if (td->o.odirect)
 170                 flags |= FILE_FLAG_NO_BUFFERING;
 171         if (td->o.sync_io)
 172                 flags |= FILE_FLAG_WRITE_THROUGH;
 173
 174         if (td->o.td_ddir == TD_DDIR_READ  ||
 175                 td->o.td_ddir == TD_DDIR_WRITE)
 176                 flags |= FILE_FLAG_SEQUENTIAL_SCAN;
 177         else
 178                 flags |= FILE_FLAG_RANDOM_ACCESS;
 179
 180         if (!td_write(td) || read_only)
 181                 access = GENERIC_READ;
 182         else
 183                 access = (GENERIC_READ | GENERIC_WRITE);
 184
 185         if (td->o.create_on_open > 0)
 186                 openmode = OPEN_ALWAYS;
 187         else
 188                 openmode = OPEN_EXISTING;
 189
 190         f->hFile = CreateFile(f->file_name, access, sharemode,
 191                 NULL, openmode, flags, NULL);
 192
 193         if (f->hFile == INVALID_HANDLE_VALUE)
 194                 rc = 1;
 195
 196         /* Only set up the competion port and thread if we're not just
 197          * querying the device size */
 198         if (!rc && td->io_ops->data != NULL) {
 199                 struct thread_ctx *ctx;
 200                 struct windowsaio_data *wd;
 201
 202                 hFile = CreateIoCompletionPort(f->hFile, NULL, 0, 0);
 203
 204                 wd = td->io_ops->data;
 205                 wd->iothread_running = TRUE;
 206
 207                 if (!rc) {
 208                         ctx = malloc(sizeof(struct thread_ctx));
 209                         ctx->iocp = hFile;
 210                         ctx->wd = wd;
 211
 212                         wd->iothread = CreateThread(NULL, 0, IoCompletionRoutine, ctx, 0, NULL);
 213                 }
 214
 215                 if (rc || wd->iothread == NULL)
 216                         rc = 1;
 217         }
 218
 219         return rc;
 220 }
 221
 222 static int fio_windowsaio_close_file(struct thread_data fio_unused *td, struct fio_file *f)
 223 {
 224         int rc = 0;
 225
 226         dprint(FD_FILE, "fd close %s\n", f->file_name);
 227
 228         if (f->hFile != INVALID_HANDLE_VALUE) {
 229                 if (!CloseHandle(f->hFile))
 230                         rc = 1;
 231         }
 232
 233         f->hFile = INVALID_HANDLE_VALUE;
 234         return rc;
 235 }
 236
 237 static BOOL timeout_expired(DWORD start_count, DWORD end_count)
 238 {
 239         BOOL expired = FALSE;
 240         DWORD current_time;
 241
 242         current_time = GetTickCount();
 243
 244         if ((end_count > start_count) && current_time >= end_count)
 245                 expired = TRUE;
 246         else if (current_time < start_count && current_time > end_count)
 247                 expired = TRUE;
 248
 249         return expired;
 250 }
 251
 252 static struct io_u* fio_windowsaio_event(struct thread_data *td, int event)
 253 {
 254         struct windowsaio_data *wd = td->io_ops->data;
 255         return wd->aio_events[event];
 256 }
 257
 258 static int fio_windowsaio_getevents(struct thread_data *td, unsigned int min,
 259                                     unsigned int max, struct timespec *t)
 260 {
 261         struct windowsaio_data *wd = td->io_ops->data;
 262         struct flist_head *entry;
 263         unsigned int dequeued = 0;
 264         struct io_u *io_u;
 265         struct fio_overlapped *fov;
 266         DWORD start_count = 0;
 267         DWORD end_count = 0;
 268         DWORD status;
 269         DWORD mswait = 250;
 270
 271         if (t != NULL) {
 272                 mswait = (t->tv_sec * 1000) + (t->tv_nsec / 1000000);
 273                 start_count = GetTickCount();
 274                 end_count = start_count + (t->tv_sec * 1000) + (t->tv_nsec / 1000000);
 275         }
 276
 277         do {
 278                 flist_for_each(entry, &td->io_u_busylist) {
 279                         io_u = flist_entry(entry, struct io_u, list);
 280                         fov = (struct fio_overlapped*)io_u->engine_data;
 281
 282                         if (fov->io_complete) {
 283                                 fov->io_complete = FALSE;
 284                                 fov->io_free  = TRUE;
 285                                 wd->aio_events[dequeued] = io_u;
 286                                 dequeued++;
 287                         }
 288
 289                         if (dequeued >= min)
 290                                 break;
 291                 }
 292
 293                 if (dequeued < min) {
 294                         status = WaitForSingleObject(wd->iocomplete_event, mswait);
 295                         if (status != WAIT_OBJECT_0 && dequeued > 0)
 296                             break;
 297                 }
 298
 299                 if (dequeued >= min || (t != NULL && timeout_expired(start_count, end_count)))
 300                         break;
 301         } while (1);
 302
 303         return dequeued;
 304 }
 305
 306 static int fio_windowsaio_queue(struct thread_data *td, struct io_u *io_u)
 307 {
 308         LPOVERLAPPED lpOvl = NULL;
 309         struct windowsaio_data *wd;
 310         DWORD iobytes;
 311         BOOL success;
 312         int index;
 313         int rc = FIO_Q_COMPLETED;
 314
 315         fio_ro_check(td, io_u);
 316
 317         wd = td->io_ops->data;
 318
 319         for (index = 0; index < td->o.iodepth; index++) {
 320                 if (wd->ovls[index].io_free) {
 321                         wd->ovls[index].io_free = FALSE;
 322                         ResetEvent(wd->ovls[index].o.hEvent);
 323                         break;
 324                 }
 325         }
 326
 327         assert(index < td->o.iodepth);
 328
 329         lpOvl = &wd->ovls[index].o;
 330         wd->ovls[index].io_u = io_u;
 331         lpOvl->Internal = STATUS_PENDING;
 332         lpOvl->InternalHigh = 0;
 333         lpOvl->Offset = io_u->offset & 0xFFFFFFFF;
 334         lpOvl->OffsetHigh = io_u->offset >> 32;
 335         io_u->engine_data = &wd->ovls[index];
 336
 337         switch (io_u->ddir) {
 338         case DDIR_WRITE:
 339                 success = WriteFile(io_u->file->hFile, io_u->xfer_buf, io_u->xfer_buflen, &iobytes, lpOvl);
 340                 break;
 341         case DDIR_READ:
 342                 success = ReadFile(io_u->file->hFile, io_u->xfer_buf, io_u->xfer_buflen, &iobytes, lpOvl);
 343                 break;
 344         case DDIR_SYNC:
 345         case DDIR_DATASYNC:
 346         case DDIR_SYNC_FILE_RANGE:
 347                 success = FlushFileBuffers(io_u->file->hFile);
 348                 if (!success)
 349                     io_u->error = GetLastError();
 350
 351                 return FIO_Q_COMPLETED;
 352                 break;
 353         case DDIR_TRIM:
 354                 log_err("manual TRIM isn't supported on Windows");
 355                 io_u->error = 1;
 356                 io_u->resid = io_u->xfer_buflen;
 357                 return FIO_Q_COMPLETED;
 358                 break;
 359         default:
 360                 assert(0);
 361         }
 362
 363         if (success || GetLastError() == ERROR_IO_PENDING)
 364                 rc = FIO_Q_QUEUED;
 365         else {
 366                 io_u->error = GetLastError();
 367                 io_u->resid = io_u->xfer_buflen;
 368         }
 369
 370         return rc;
 371 }
 372
 373 /* Runs as a thread and waits for queued IO to complete */
 374 static DWORD WINAPI IoCompletionRoutine(LPVOID lpParameter)
 375 {
 376         OVERLAPPED *ovl;
 377         struct fio_overlapped *fov;
 378         struct io_u *io_u;
 379         struct windowsaio_data *wd;
 380         struct thread_ctx *ctx;
 381         ULONG_PTR ulKey = 0;
 382         DWORD bytes;
 383
 384         ctx = (struct thread_ctx*)lpParameter;
 385         wd = ctx->wd;
 386
 387         do {
 388                 if (!GetQueuedCompletionStatus(ctx->iocp, &bytes, &ulKey, &ovl, 250))
 389                         continue;
 390
 391                 fov = CONTAINING_RECORD(ovl, struct fio_overlapped, o);
 392                 io_u = fov->io_u;
 393
 394                 if (ovl->Internal == ERROR_SUCCESS) {
 395                         io_u->resid = io_u->xfer_buflen - ovl->InternalHigh;
 396                         io_u->error = 0;
 397                 } else {
 398                         io_u->resid = io_u->xfer_buflen;
 399                         io_u->error = ovl->Internal;
 400                 }
 401
 402                 fov->io_complete = TRUE;
 403                 SetEvent(wd->iocomplete_event);
 404         } while (ctx->wd->iothread_running);
 405
 406         CloseHandle(ctx->iocp);
 407         free(ctx);
 408         return 0;
 409 }
 410
 411 static int fio_windowsaio_cancel(struct thread_data *td,
 412                                struct io_u *io_u)
 413 {
 414         int rc = 0;
 415
 416         struct windowsaio_data *wd = td->io_ops->data;
 417
 418         /* If we're running on Vista or newer, we can cancel individual IO requests */
 419         if (wd->pCancelIoEx != NULL) {
 420                 struct fio_overlapped *ovl = io_u->engine_data;
 421
 422                 if (!wd->pCancelIoEx(io_u->file->hFile, &ovl->o))
 423                         rc = 1;
 424         } else
 425                 rc = 1;
 426
 427         return rc;
 428 }
 429
 430 static struct ioengine_ops ioengine = {
 431         .name           = "windowsaio",
 432         .version        = FIO_IOOPS_VERSION,
 433         .init           = fio_windowsaio_init,
 434         .queue          = fio_windowsaio_queue,
 435         .cancel         = fio_windowsaio_cancel,
 436         .getevents      = fio_windowsaio_getevents,
 437         .event          = fio_windowsaio_event,
 438         .cleanup        = fio_windowsaio_cleanup,
 439         .open_file      = fio_windowsaio_open_file,
 440         .close_file     = fio_windowsaio_close_file,
 441         .get_file_size  = generic_get_file_size
 442 };
 443
 444 static void fio_init fio_posixaio_register(void)
 445 {
 446         register_ioengine(&ioengine);
 447 }
 448
 449 static void fio_exit fio_posixaio_unregister(void)
 450 {
 451         unregister_ioengine(&ioengine);
 452 }