option parsing: Mark arguments that are not modified as 'const'
[fio.git] / engines / sync.c
CommitLineData
2866c82d 1/*
a31041ea 2 * sync/psync engine
da751ca9
JA
3 *
4 * IO engine that does regular read(2)/write(2) with lseek(2) to transfer
a31041ea 5 * data and IO engine that does regular pread(2)/pwrite(2) to transfer data.
2866c82d
JA
6 *
7 */
8#include <stdio.h>
9#include <stdlib.h>
10#include <unistd.h>
5921e80c 11#include <sys/uio.h>
2866c82d 12#include <errno.h>
5f350952
JA
13
14#include "../fio.h"
2cafffbe 15#include "../optgroup.h"
a0679ce5 16#include "../lib/rand.h"
2866c82d 17
ef5f5a3a
JA
18/*
19 * Sync engine uses engine_data to store last offset
20 */
710bf9c5 21#define LAST_POS(f) ((f)->engine_pos)
ef5f5a3a 22
1d2af02a
JA
23struct syncio_data {
24 struct iovec *iovecs;
25 struct io_u **io_us;
26 unsigned int queued;
e51cf72c 27 unsigned int events;
1d2af02a
JA
28 unsigned long queued_bytes;
29
30 unsigned long long last_offset;
31 struct fio_file *last_file;
32 enum fio_ddir last_ddir;
a0679ce5
SB
33
34 struct frand_state rand_state;
1d2af02a
JA
35};
36
6562685f 37#ifdef FIO_HAVE_PWRITEV2
2cafffbe
JA
38struct psyncv2_options {
39 void *pad;
40 unsigned int hipri;
a0679ce5 41 unsigned int hipri_percentage;
2cafffbe
JA
42};
43
44static struct fio_option options[] = {
45 {
46 .name = "hipri",
47 .lname = "RWF_HIPRI",
48 .type = FIO_OPT_STR_SET,
49 .off1 = offsetof(struct psyncv2_options, hipri),
50 .help = "Set RWF_HIPRI for pwritev2/preadv2",
51 .category = FIO_OPT_C_ENGINE,
52 .group = FIO_OPT_G_INVALID,
53 },
a0679ce5
SB
54 {
55 .name = "hipri_percentage",
56 .lname = "RWF_HIPRI_PERCENTAGE",
57 .type = FIO_OPT_INT,
58 .off1 = offsetof(struct psyncv2_options, hipri_percentage),
59 .minval = 0,
60 .maxval = 100,
61 .def = "100",
62 .help = "Probabilistically set RWF_HIPRI for pwritev2/preadv2",
63 .category = FIO_OPT_C_ENGINE,
64 .group = FIO_OPT_G_INVALID,
65 },
2cafffbe
JA
66 {
67 .name = NULL,
68 },
69};
70#endif
71
2866c82d
JA
72static int fio_syncio_prep(struct thread_data *td, struct io_u *io_u)
73{
53cdc686
JA
74 struct fio_file *f = io_u->file;
75
ff58fced 76 if (!ddir_rw(io_u->ddir))
87dc1ab1
JA
77 return 0;
78
ef5f5a3a 79 if (LAST_POS(f) != -1ULL && LAST_POS(f) == io_u->offset)
e943b878
JA
80 return 0;
81
53cdc686 82 if (lseek(f->fd, io_u->offset, SEEK_SET) == -1) {
e1161c32 83 td_verror(td, errno, "lseek");
2866c82d
JA
84 return 1;
85 }
86
87 return 0;
88}
89
2bd3eabc 90static int fio_io_end(struct thread_data *td, struct io_u *io_u, int ret)
2866c82d 91{
ff58fced 92 if (io_u->file && ret >= 0 && ddir_rw(io_u->ddir))
ef5f5a3a 93 LAST_POS(io_u->file) = io_u->offset + ret;
e943b878 94
cec6b55d 95 if (ret != (int) io_u->xfer_buflen) {
22819ec2 96 if (ret >= 0) {
cec6b55d
JA
97 io_u->resid = io_u->xfer_buflen - ret;
98 io_u->error = 0;
36167d82 99 return FIO_Q_COMPLETED;
2866c82d
JA
100 } else
101 io_u->error = errno;
102 }
103
bfd197cb
JA
104 if (io_u->error) {
105 io_u_log_error(td, io_u);
e1161c32 106 td_verror(td, io_u->error, "xfer");
bfd197cb 107 }
2866c82d 108
36167d82 109 return FIO_Q_COMPLETED;
2866c82d
JA
110}
111
07fc0acd
JA
112#ifdef CONFIG_PWRITEV
113static int fio_pvsyncio_queue(struct thread_data *td, struct io_u *io_u)
114{
565e784d 115 struct syncio_data *sd = td->io_ops_data;
07fc0acd
JA
116 struct iovec *iov = &sd->iovecs[0];
117 struct fio_file *f = io_u->file;
118 int ret;
119
120 fio_ro_check(td, io_u);
121
122 iov->iov_base = io_u->xfer_buf;
123 iov->iov_len = io_u->xfer_buflen;
124
125 if (io_u->ddir == DDIR_READ)
126 ret = preadv(f->fd, iov, 1, io_u->offset);
127 else if (io_u->ddir == DDIR_WRITE)
128 ret = pwritev(f->fd, iov, 1, io_u->offset);
129 else if (io_u->ddir == DDIR_TRIM) {
130 do_io_u_trim(td, io_u);
131 return FIO_Q_COMPLETED;
132 } else
133 ret = do_io_u_sync(td, io_u);
134
135 return fio_io_end(td, io_u, ret);
136}
137#endif
138
6562685f 139#ifdef FIO_HAVE_PWRITEV2
2cafffbe
JA
140static int fio_pvsyncio2_queue(struct thread_data *td, struct io_u *io_u)
141{
565e784d 142 struct syncio_data *sd = td->io_ops_data;
2cafffbe
JA
143 struct psyncv2_options *o = td->eo;
144 struct iovec *iov = &sd->iovecs[0];
145 struct fio_file *f = io_u->file;
146 int ret, flags = 0;
147
148 fio_ro_check(td, io_u);
149
a0679ce5
SB
150 if (o->hipri &&
151 (rand32_between(&sd->rand_state, 1, 100) <= o->hipri_percentage))
2cafffbe
JA
152 flags |= RWF_HIPRI;
153
154 iov->iov_base = io_u->xfer_buf;
155 iov->iov_len = io_u->xfer_buflen;
156
157 if (io_u->ddir == DDIR_READ)
158 ret = preadv2(f->fd, iov, 1, io_u->offset, flags);
159 else if (io_u->ddir == DDIR_WRITE)
160 ret = pwritev2(f->fd, iov, 1, io_u->offset, flags);
161 else if (io_u->ddir == DDIR_TRIM) {
162 do_io_u_trim(td, io_u);
163 return FIO_Q_COMPLETED;
164 } else
165 ret = do_io_u_sync(td, io_u);
166
167 return fio_io_end(td, io_u, ret);
168}
169#endif
170
171
2bd3eabc 172static int fio_psyncio_queue(struct thread_data *td, struct io_u *io_u)
a31041ea 173{
2bd3eabc
JA
174 struct fio_file *f = io_u->file;
175 int ret;
176
177 fio_ro_check(td, io_u);
178
179 if (io_u->ddir == DDIR_READ)
180 ret = pread(f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
181 else if (io_u->ddir == DDIR_WRITE)
182 ret = pwrite(f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
6eaf09d6
SL
183 else if (io_u->ddir == DDIR_TRIM) {
184 do_io_u_trim(td, io_u);
185 return FIO_Q_COMPLETED;
186 } else
0a28ecda 187 ret = do_io_u_sync(td, io_u);
2bd3eabc
JA
188
189 return fio_io_end(td, io_u, ret);
190}
191
192static int fio_syncio_queue(struct thread_data *td, struct io_u *io_u)
193{
194 struct fio_file *f = io_u->file;
195 int ret;
196
197 fio_ro_check(td, io_u);
198
199 if (io_u->ddir == DDIR_READ)
200 ret = read(f->fd, io_u->xfer_buf, io_u->xfer_buflen);
201 else if (io_u->ddir == DDIR_WRITE)
202 ret = write(f->fd, io_u->xfer_buf, io_u->xfer_buflen);
6eaf09d6
SL
203 else if (io_u->ddir == DDIR_TRIM) {
204 do_io_u_trim(td, io_u);
205 return FIO_Q_COMPLETED;
206 } else
0a28ecda 207 ret = do_io_u_sync(td, io_u);
2bd3eabc
JA
208
209 return fio_io_end(td, io_u, ret);
a31041ea 210}
211
1d2af02a
JA
212static int fio_vsyncio_getevents(struct thread_data *td, unsigned int min,
213 unsigned int max,
1f440ece 214 const struct timespec fio_unused *t)
1d2af02a 215{
565e784d 216 struct syncio_data *sd = td->io_ops_data;
1d2af02a
JA
217 int ret;
218
219 if (min) {
e51cf72c
JA
220 ret = sd->events;
221 sd->events = 0;
1d2af02a
JA
222 } else
223 ret = 0;
224
225 dprint(FD_IO, "vsyncio_getevents: min=%d,max=%d: %d\n", min, max, ret);
226 return ret;
227}
228
229static struct io_u *fio_vsyncio_event(struct thread_data *td, int event)
230{
565e784d 231 struct syncio_data *sd = td->io_ops_data;
1d2af02a
JA
232
233 return sd->io_us[event];
234}
235
236static int fio_vsyncio_append(struct thread_data *td, struct io_u *io_u)
237{
565e784d 238 struct syncio_data *sd = td->io_ops_data;
1d2af02a 239
5f9099ea 240 if (ddir_sync(io_u->ddir))
1d2af02a
JA
241 return 0;
242
243 if (io_u->offset == sd->last_offset && io_u->file == sd->last_file &&
244 io_u->ddir == sd->last_ddir)
245 return 1;
246
247 return 0;
248}
249
250static void fio_vsyncio_set_iov(struct syncio_data *sd, struct io_u *io_u,
2b13e716 251 int idx)
1d2af02a 252{
2b13e716
JA
253 sd->io_us[idx] = io_u;
254 sd->iovecs[idx].iov_base = io_u->xfer_buf;
255 sd->iovecs[idx].iov_len = io_u->xfer_buflen;
1d2af02a
JA
256 sd->last_offset = io_u->offset + io_u->xfer_buflen;
257 sd->last_file = io_u->file;
258 sd->last_ddir = io_u->ddir;
259 sd->queued_bytes += io_u->xfer_buflen;
260 sd->queued++;
261}
262
263static int fio_vsyncio_queue(struct thread_data *td, struct io_u *io_u)
264{
565e784d 265 struct syncio_data *sd = td->io_ops_data;
1d2af02a
JA
266
267 fio_ro_check(td, io_u);
268
269 if (!fio_vsyncio_append(td, io_u)) {
270 dprint(FD_IO, "vsyncio_queue: no append (%d)\n", sd->queued);
271 /*
272 * If we can't append and have stuff queued, tell fio to
273 * commit those first and then retry this io
274 */
275 if (sd->queued)
276 return FIO_Q_BUSY;
0a28ecda
JA
277 if (ddir_sync(io_u->ddir)) {
278 int ret = do_io_u_sync(td, io_u);
279
280 return fio_io_end(td, io_u, ret);
281 }
cc9159c3 282
1d2af02a
JA
283 sd->queued = 0;
284 sd->queued_bytes = 0;
285 fio_vsyncio_set_iov(sd, io_u, 0);
286 } else {
287 if (sd->queued == td->o.iodepth) {
288 dprint(FD_IO, "vsyncio_queue: max depth %d\n", sd->queued);
289 return FIO_Q_BUSY;
290 }
291
292 dprint(FD_IO, "vsyncio_queue: append\n");
293 fio_vsyncio_set_iov(sd, io_u, sd->queued);
294 }
295
296 dprint(FD_IO, "vsyncio_queue: depth now %d\n", sd->queued);
297 return FIO_Q_QUEUED;
298}
299
300/*
301 * Check that we transferred all bytes, or saw an error, etc
302 */
303static int fio_vsyncio_end(struct thread_data *td, ssize_t bytes)
304{
565e784d 305 struct syncio_data *sd = td->io_ops_data;
1d2af02a
JA
306 struct io_u *io_u;
307 unsigned int i;
308 int err;
309
310 /*
311 * transferred everything, perfect
312 */
313 if (bytes == sd->queued_bytes)
314 return 0;
315
316 err = errno;
317 for (i = 0; i < sd->queued; i++) {
318 io_u = sd->io_us[i];
319
320 if (bytes == -1) {
321 io_u->error = err;
322 } else {
323 unsigned int this_io;
324
325 this_io = bytes;
326 if (this_io > io_u->xfer_buflen)
327 this_io = io_u->xfer_buflen;
328
329 io_u->resid = io_u->xfer_buflen - this_io;
330 io_u->error = 0;
331 bytes -= this_io;
332 }
333 }
334
335 if (bytes == -1) {
336 td_verror(td, err, "xfer vsync");
337 return -err;
338 }
339
340 return 0;
341}
342
343static int fio_vsyncio_commit(struct thread_data *td)
344{
565e784d 345 struct syncio_data *sd = td->io_ops_data;
1d2af02a
JA
346 struct fio_file *f;
347 ssize_t ret;
348
349 if (!sd->queued)
350 return 0;
351
838bc709 352 io_u_mark_submit(td, sd->queued);
1d2af02a
JA
353 f = sd->last_file;
354
355 if (lseek(f->fd, sd->io_us[0]->offset, SEEK_SET) == -1) {
356 int err = -errno;
357
358 td_verror(td, errno, "lseek");
359 return err;
360 }
361
362 if (sd->last_ddir == DDIR_READ)
363 ret = readv(f->fd, sd->iovecs, sd->queued);
364 else
365 ret = writev(f->fd, sd->iovecs, sd->queued);
366
367 dprint(FD_IO, "vsyncio_commit: %d\n", (int) ret);
e51cf72c
JA
368 sd->events = sd->queued;
369 sd->queued = 0;
1d2af02a
JA
370 return fio_vsyncio_end(td, ret);
371}
372
373static int fio_vsyncio_init(struct thread_data *td)
374{
375 struct syncio_data *sd;
376
377 sd = malloc(sizeof(*sd));
378 memset(sd, 0, sizeof(*sd));
379 sd->last_offset = -1ULL;
380 sd->iovecs = malloc(td->o.iodepth * sizeof(struct iovec));
381 sd->io_us = malloc(td->o.iodepth * sizeof(struct io_u *));
a0679ce5 382 init_rand(&sd->rand_state, 0);
1d2af02a 383
565e784d 384 td->io_ops_data = sd;
1d2af02a
JA
385 return 0;
386}
387
388static void fio_vsyncio_cleanup(struct thread_data *td)
389{
565e784d 390 struct syncio_data *sd = td->io_ops_data;
1d2af02a 391
02a3d83f
TK
392 if (sd) {
393 free(sd->iovecs);
394 free(sd->io_us);
395 free(sd);
396 }
1d2af02a
JA
397}
398
a31041ea 399static struct ioengine_ops ioengine_rw = {
2866c82d
JA
400 .name = "sync",
401 .version = FIO_IOOPS_VERSION,
2866c82d
JA
402 .prep = fio_syncio_prep,
403 .queue = fio_syncio_queue,
b5af8293
JA
404 .open_file = generic_open_file,
405 .close_file = generic_close_file,
df9c26b1 406 .get_file_size = generic_get_file_size,
2866c82d
JA
407 .flags = FIO_SYNCIO,
408};
5f350952 409
a31041ea 410static struct ioengine_ops ioengine_prw = {
411 .name = "psync",
412 .version = FIO_IOOPS_VERSION,
2bd3eabc 413 .queue = fio_psyncio_queue,
a31041ea 414 .open_file = generic_open_file,
415 .close_file = generic_close_file,
df9c26b1 416 .get_file_size = generic_get_file_size,
a31041ea 417 .flags = FIO_SYNCIO,
418};
419
1d2af02a
JA
420static struct ioengine_ops ioengine_vrw = {
421 .name = "vsync",
422 .version = FIO_IOOPS_VERSION,
423 .init = fio_vsyncio_init,
424 .cleanup = fio_vsyncio_cleanup,
425 .queue = fio_vsyncio_queue,
426 .commit = fio_vsyncio_commit,
427 .event = fio_vsyncio_event,
428 .getevents = fio_vsyncio_getevents,
429 .open_file = generic_open_file,
430 .close_file = generic_close_file,
df9c26b1 431 .get_file_size = generic_get_file_size,
1d2af02a
JA
432 .flags = FIO_SYNCIO,
433};
434
07fc0acd
JA
435#ifdef CONFIG_PWRITEV
436static struct ioengine_ops ioengine_pvrw = {
437 .name = "pvsync",
438 .version = FIO_IOOPS_VERSION,
439 .init = fio_vsyncio_init,
440 .cleanup = fio_vsyncio_cleanup,
441 .queue = fio_pvsyncio_queue,
442 .open_file = generic_open_file,
443 .close_file = generic_close_file,
444 .get_file_size = generic_get_file_size,
445 .flags = FIO_SYNCIO,
446};
447#endif
448
6562685f 449#ifdef FIO_HAVE_PWRITEV2
2cafffbe
JA
450static struct ioengine_ops ioengine_pvrw2 = {
451 .name = "pvsync2",
452 .version = FIO_IOOPS_VERSION,
453 .init = fio_vsyncio_init,
454 .cleanup = fio_vsyncio_cleanup,
455 .queue = fio_pvsyncio2_queue,
456 .open_file = generic_open_file,
457 .close_file = generic_close_file,
458 .get_file_size = generic_get_file_size,
459 .flags = FIO_SYNCIO,
460 .options = options,
461 .option_struct_size = sizeof(struct psyncv2_options),
462};
463#endif
464
5f350952
JA
465static void fio_init fio_syncio_register(void)
466{
a31041ea 467 register_ioengine(&ioengine_rw);
468 register_ioengine(&ioengine_prw);
1d2af02a 469 register_ioengine(&ioengine_vrw);
9a0ced5a 470#ifdef CONFIG_PWRITEV
07fc0acd 471 register_ioengine(&ioengine_pvrw);
9a0ced5a 472#endif
6562685f 473#ifdef FIO_HAVE_PWRITEV2
526c403d
JD
474 register_ioengine(&ioengine_pvrw2);
475#endif
5f350952
JA
476}
477
478static void fio_exit fio_syncio_unregister(void)
479{
a31041ea 480 unregister_ioengine(&ioengine_rw);
481 unregister_ioengine(&ioengine_prw);
1d2af02a 482 unregister_ioengine(&ioengine_vrw);
9a0ced5a 483#ifdef CONFIG_PWRITEV
07fc0acd 484 unregister_ioengine(&ioengine_pvrw);
9a0ced5a 485#endif
6562685f 486#ifdef FIO_HAVE_PWRITEV2
526c403d
JD
487 unregister_ioengine(&ioengine_pvrw2);
488#endif
5f350952 489}