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