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