ebd75c1b6ebba517e617e004290713610b6f0608
[fio.git] / io_u.c
1 #include <unistd.h>
2 #include <fcntl.h>
3 #include <string.h>
4 #include <signal.h>
5 #include <time.h>
6 #include <assert.h>
7
8 #include "fio.h"
9 #include "hash.h"
10 #include "verify.h"
11 #include "trim.h"
12 #include "lib/rand.h"
13 #include "lib/axmap.h"
14 #include "err.h"
15
16 struct io_completion_data {
17         int nr;                         /* input */
18
19         int error;                      /* output */
20         uint64_t bytes_done[DDIR_RWDIR_CNT];    /* output */
21         struct timeval time;            /* output */
22 };
23
24 /*
25  * The ->io_axmap contains a map of blocks we have or have not done io
26  * to yet. Used to make sure we cover the entire range in a fair fashion.
27  */
28 static int random_map_free(struct fio_file *f, const uint64_t block)
29 {
30         return !axmap_isset(f->io_axmap, block);
31 }
32
33 /*
34  * Mark a given offset as used in the map.
35  */
36 static void mark_random_map(struct thread_data *td, struct io_u *io_u)
37 {
38         unsigned int min_bs = td->o.rw_min_bs;
39         struct fio_file *f = io_u->file;
40         unsigned int nr_blocks;
41         uint64_t block;
42
43         block = (io_u->offset - f->file_offset) / (uint64_t) min_bs;
44         nr_blocks = (io_u->buflen + min_bs - 1) / min_bs;
45
46         if (!(io_u->flags & IO_U_F_BUSY_OK))
47                 nr_blocks = axmap_set_nr(f->io_axmap, block, nr_blocks);
48
49         if ((nr_blocks * min_bs) < io_u->buflen)
50                 io_u->buflen = nr_blocks * min_bs;
51 }
52
53 static uint64_t last_block(struct thread_data *td, struct fio_file *f,
54                            enum fio_ddir ddir)
55 {
56         uint64_t max_blocks;
57         uint64_t max_size;
58
59         assert(ddir_rw(ddir));
60
61         /*
62          * Hmm, should we make sure that ->io_size <= ->real_file_size?
63          */
64         max_size = f->io_size;
65         if (max_size > f->real_file_size)
66                 max_size = f->real_file_size;
67
68         if (td->o.zone_range)
69                 max_size = td->o.zone_range;
70
71         if (td->o.min_bs[ddir] > td->o.ba[ddir])
72                 max_size -= td->o.min_bs[ddir] - td->o.ba[ddir];
73
74         max_blocks = max_size / (uint64_t) td->o.ba[ddir];
75         if (!max_blocks)
76                 return 0;
77
78         return max_blocks;
79 }
80
81 struct rand_off {
82         struct flist_head list;
83         uint64_t off;
84 };
85
86 static int __get_next_rand_offset(struct thread_data *td, struct fio_file *f,
87                                   enum fio_ddir ddir, uint64_t *b)
88 {
89         uint64_t r;
90
91         if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE) {
92                 uint64_t lastb;
93
94                 lastb = last_block(td, f, ddir);
95                 if (!lastb)
96                         return 1;
97
98                 r = __rand(&td->random_state);
99
100                 dprint(FD_RANDOM, "off rand %llu\n", (unsigned long long) r);
101
102                 *b = lastb * (r / ((uint64_t) FRAND_MAX + 1.0));
103         } else {
104                 uint64_t off = 0;
105
106                 assert(fio_file_lfsr(f));
107
108                 if (lfsr_next(&f->lfsr, &off))
109                         return 1;
110
111                 *b = off;
112         }
113
114         /*
115          * if we are not maintaining a random map, we are done.
116          */
117         if (!file_randommap(td, f))
118                 goto ret;
119
120         /*
121          * calculate map offset and check if it's free
122          */
123         if (random_map_free(f, *b))
124                 goto ret;
125
126         dprint(FD_RANDOM, "get_next_rand_offset: offset %llu busy\n",
127                                                 (unsigned long long) *b);
128
129         *b = axmap_next_free(f->io_axmap, *b);
130         if (*b == (uint64_t) -1ULL)
131                 return 1;
132 ret:
133         return 0;
134 }
135
136 static int __get_next_rand_offset_zipf(struct thread_data *td,
137                                        struct fio_file *f, enum fio_ddir ddir,
138                                        uint64_t *b)
139 {
140         *b = zipf_next(&f->zipf);
141         return 0;
142 }
143
144 static int __get_next_rand_offset_pareto(struct thread_data *td,
145                                          struct fio_file *f, enum fio_ddir ddir,
146                                          uint64_t *b)
147 {
148         *b = pareto_next(&f->zipf);
149         return 0;
150 }
151
152 static int __get_next_rand_offset_gauss(struct thread_data *td,
153                                         struct fio_file *f, enum fio_ddir ddir,
154                                         uint64_t *b)
155 {
156         *b = gauss_next(&f->gauss);
157         return 0;
158 }
159
160
161 static int flist_cmp(void *data, struct flist_head *a, struct flist_head *b)
162 {
163         struct rand_off *r1 = flist_entry(a, struct rand_off, list);
164         struct rand_off *r2 = flist_entry(b, struct rand_off, list);
165
166         return r1->off - r2->off;
167 }
168
169 static int get_off_from_method(struct thread_data *td, struct fio_file *f,
170                                enum fio_ddir ddir, uint64_t *b)
171 {
172         if (td->o.random_distribution == FIO_RAND_DIST_RANDOM)
173                 return __get_next_rand_offset(td, f, ddir, b);
174         else if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
175                 return __get_next_rand_offset_zipf(td, f, ddir, b);
176         else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
177                 return __get_next_rand_offset_pareto(td, f, ddir, b);
178         else if (td->o.random_distribution == FIO_RAND_DIST_GAUSS)
179                 return __get_next_rand_offset_gauss(td, f, ddir, b);
180
181         log_err("fio: unknown random distribution: %d\n", td->o.random_distribution);
182         return 1;
183 }
184
185 /*
186  * Sort the reads for a verify phase in batches of verifysort_nr, if
187  * specified.
188  */
189 static inline int should_sort_io(struct thread_data *td)
190 {
191         if (!td->o.verifysort_nr || !td->o.do_verify)
192                 return 0;
193         if (!td_random(td))
194                 return 0;
195         if (td->runstate != TD_VERIFYING)
196                 return 0;
197         if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE)
198                 return 0;
199
200         return 1;
201 }
202
203 static int should_do_random(struct thread_data *td, enum fio_ddir ddir)
204 {
205         unsigned int v;
206         unsigned long r;
207
208         if (td->o.perc_rand[ddir] == 100)
209                 return 1;
210
211         r = __rand(&td->seq_rand_state[ddir]);
212         v = 1 + (int) (100.0 * (r / (FRAND_MAX + 1.0)));
213
214         return v <= td->o.perc_rand[ddir];
215 }
216
217 static int get_next_rand_offset(struct thread_data *td, struct fio_file *f,
218                                 enum fio_ddir ddir, uint64_t *b)
219 {
220         struct rand_off *r;
221         int i, ret = 1;
222
223         if (!should_sort_io(td))
224                 return get_off_from_method(td, f, ddir, b);
225
226         if (!flist_empty(&td->next_rand_list)) {
227 fetch:
228                 r = flist_first_entry(&td->next_rand_list, struct rand_off, list);
229                 flist_del(&r->list);
230                 *b = r->off;
231                 free(r);
232                 return 0;
233         }
234
235         for (i = 0; i < td->o.verifysort_nr; i++) {
236                 r = malloc(sizeof(*r));
237
238                 ret = get_off_from_method(td, f, ddir, &r->off);
239                 if (ret) {
240                         free(r);
241                         break;
242                 }
243
244                 flist_add(&r->list, &td->next_rand_list);
245         }
246
247         if (ret && !i)
248                 return ret;
249
250         assert(!flist_empty(&td->next_rand_list));
251         flist_sort(NULL, &td->next_rand_list, flist_cmp);
252         goto fetch;
253 }
254
255 static int get_next_rand_block(struct thread_data *td, struct fio_file *f,
256                                enum fio_ddir ddir, uint64_t *b)
257 {
258         if (!get_next_rand_offset(td, f, ddir, b))
259                 return 0;
260
261         if (td->o.time_based) {
262                 fio_file_reset(td, f);
263                 if (!get_next_rand_offset(td, f, ddir, b))
264                         return 0;
265         }
266
267         dprint(FD_IO, "%s: rand offset failed, last=%llu, size=%llu\n",
268                         f->file_name, (unsigned long long) f->last_pos[ddir],
269                         (unsigned long long) f->real_file_size);
270         return 1;
271 }
272
273 static int get_next_seq_offset(struct thread_data *td, struct fio_file *f,
274                                enum fio_ddir ddir, uint64_t *offset)
275 {
276         struct thread_options *o = &td->o;
277
278         assert(ddir_rw(ddir));
279
280         if (f->last_pos[ddir] >= f->io_size + get_start_offset(td, f) &&
281             o->time_based)
282                 f->last_pos[ddir] = f->last_pos[ddir] - f->io_size;
283
284         if (f->last_pos[ddir] < f->real_file_size) {
285                 uint64_t pos;
286
287                 if (f->last_pos[ddir] == f->file_offset && o->ddir_seq_add < 0)
288                         f->last_pos[ddir] = f->real_file_size;
289
290                 pos = f->last_pos[ddir] - f->file_offset;
291                 if (pos && o->ddir_seq_add) {
292                         pos += o->ddir_seq_add;
293
294                         /*
295                          * If we reach beyond the end of the file
296                          * with holed IO, wrap around to the
297                          * beginning again.
298                          */
299                         if (pos >= f->real_file_size)
300                                 pos = f->file_offset;
301                 }
302
303                 *offset = pos;
304                 return 0;
305         }
306
307         return 1;
308 }
309
310 static int get_next_block(struct thread_data *td, struct io_u *io_u,
311                           enum fio_ddir ddir, int rw_seq,
312                           unsigned int *is_random)
313 {
314         struct fio_file *f = io_u->file;
315         uint64_t b, offset;
316         int ret;
317
318         assert(ddir_rw(ddir));
319
320         b = offset = -1ULL;
321
322         if (rw_seq) {
323                 if (td_random(td)) {
324                         if (should_do_random(td, ddir)) {
325                                 ret = get_next_rand_block(td, f, ddir, &b);
326                                 *is_random = 1;
327                         } else {
328                                 *is_random = 0;
329                                 io_u->flags |= IO_U_F_BUSY_OK;
330                                 ret = get_next_seq_offset(td, f, ddir, &offset);
331                                 if (ret)
332                                         ret = get_next_rand_block(td, f, ddir, &b);
333                         }
334                 } else {
335                         *is_random = 0;
336                         ret = get_next_seq_offset(td, f, ddir, &offset);
337                 }
338         } else {
339                 io_u->flags |= IO_U_F_BUSY_OK;
340                 *is_random = 0;
341
342                 if (td->o.rw_seq == RW_SEQ_SEQ) {
343                         ret = get_next_seq_offset(td, f, ddir, &offset);
344                         if (ret) {
345                                 ret = get_next_rand_block(td, f, ddir, &b);
346                                 *is_random = 0;
347                         }
348                 } else if (td->o.rw_seq == RW_SEQ_IDENT) {
349                         if (f->last_start[ddir] != -1ULL)
350                                 offset = f->last_start[ddir] - f->file_offset;
351                         else
352                                 offset = 0;
353                         ret = 0;
354                 } else {
355                         log_err("fio: unknown rw_seq=%d\n", td->o.rw_seq);
356                         ret = 1;
357                 }
358         }
359
360         if (!ret) {
361                 if (offset != -1ULL)
362                         io_u->offset = offset;
363                 else if (b != -1ULL)
364                         io_u->offset = b * td->o.ba[ddir];
365                 else {
366                         log_err("fio: bug in offset generation: offset=%llu, b=%llu\n", (unsigned long long) offset, (unsigned long long) b);
367                         ret = 1;
368                 }
369         }
370
371         return ret;
372 }
373
374 /*
375  * For random io, generate a random new block and see if it's used. Repeat
376  * until we find a free one. For sequential io, just return the end of
377  * the last io issued.
378  */
379 static int __get_next_offset(struct thread_data *td, struct io_u *io_u,
380                              unsigned int *is_random)
381 {
382         struct fio_file *f = io_u->file;
383         enum fio_ddir ddir = io_u->ddir;
384         int rw_seq_hit = 0;
385
386         assert(ddir_rw(ddir));
387
388         if (td->o.ddir_seq_nr && !--td->ddir_seq_nr) {
389                 rw_seq_hit = 1;
390                 td->ddir_seq_nr = td->o.ddir_seq_nr;
391         }
392
393         if (get_next_block(td, io_u, ddir, rw_seq_hit, is_random))
394                 return 1;
395
396         if (io_u->offset >= f->io_size) {
397                 dprint(FD_IO, "get_next_offset: offset %llu >= io_size %llu\n",
398                                         (unsigned long long) io_u->offset,
399                                         (unsigned long long) f->io_size);
400                 return 1;
401         }
402
403         io_u->offset += f->file_offset;
404         if (io_u->offset >= f->real_file_size) {
405                 dprint(FD_IO, "get_next_offset: offset %llu >= size %llu\n",
406                                         (unsigned long long) io_u->offset,
407                                         (unsigned long long) f->real_file_size);
408                 return 1;
409         }
410
411         return 0;
412 }
413
414 static int get_next_offset(struct thread_data *td, struct io_u *io_u,
415                            unsigned int *is_random)
416 {
417         if (td->flags & TD_F_PROFILE_OPS) {
418                 struct prof_io_ops *ops = &td->prof_io_ops;
419
420                 if (ops->fill_io_u_off)
421                         return ops->fill_io_u_off(td, io_u, is_random);
422         }
423
424         return __get_next_offset(td, io_u, is_random);
425 }
426
427 static inline int io_u_fits(struct thread_data *td, struct io_u *io_u,
428                             unsigned int buflen)
429 {
430         struct fio_file *f = io_u->file;
431
432         return io_u->offset + buflen <= f->io_size + get_start_offset(td, f);
433 }
434
435 static unsigned int __get_next_buflen(struct thread_data *td, struct io_u *io_u,
436                                       unsigned int is_random)
437 {
438         int ddir = io_u->ddir;
439         unsigned int buflen = 0;
440         unsigned int minbs, maxbs;
441         unsigned long r;
442
443         assert(ddir_rw(ddir));
444
445         if (td->o.bs_is_seq_rand)
446                 ddir = is_random ? DDIR_WRITE: DDIR_READ;
447
448         minbs = td->o.min_bs[ddir];
449         maxbs = td->o.max_bs[ddir];
450
451         if (minbs == maxbs)
452                 return minbs;
453
454         /*
455          * If we can't satisfy the min block size from here, then fail
456          */
457         if (!io_u_fits(td, io_u, minbs))
458                 return 0;
459
460         do {
461                 r = __rand(&td->bsrange_state);
462
463                 if (!td->o.bssplit_nr[ddir]) {
464                         buflen = 1 + (unsigned int) ((double) maxbs *
465                                         (r / (FRAND_MAX + 1.0)));
466                         if (buflen < minbs)
467                                 buflen = minbs;
468                 } else {
469                         long perc = 0;
470                         unsigned int i;
471
472                         for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
473                                 struct bssplit *bsp = &td->o.bssplit[ddir][i];
474
475                                 buflen = bsp->bs;
476                                 perc += bsp->perc;
477                                 if ((r <= ((FRAND_MAX / 100L) * perc)) &&
478                                     io_u_fits(td, io_u, buflen))
479                                         break;
480                         }
481                 }
482
483                 if (td->o.do_verify && td->o.verify != VERIFY_NONE)
484                         buflen = (buflen + td->o.verify_interval - 1) &
485                                 ~(td->o.verify_interval - 1);
486
487                 if (!td->o.bs_unaligned && is_power_of_2(minbs))
488                         buflen = (buflen + minbs - 1) & ~(minbs - 1);
489
490         } while (!io_u_fits(td, io_u, buflen));
491
492         return buflen;
493 }
494
495 static unsigned int get_next_buflen(struct thread_data *td, struct io_u *io_u,
496                                     unsigned int is_random)
497 {
498         if (td->flags & TD_F_PROFILE_OPS) {
499                 struct prof_io_ops *ops = &td->prof_io_ops;
500
501                 if (ops->fill_io_u_size)
502                         return ops->fill_io_u_size(td, io_u, is_random);
503         }
504
505         return __get_next_buflen(td, io_u, is_random);
506 }
507
508 static void set_rwmix_bytes(struct thread_data *td)
509 {
510         unsigned int diff;
511
512         /*
513          * we do time or byte based switch. this is needed because
514          * buffered writes may issue a lot quicker than they complete,
515          * whereas reads do not.
516          */
517         diff = td->o.rwmix[td->rwmix_ddir ^ 1];
518         td->rwmix_issues = (td->io_issues[td->rwmix_ddir] * diff) / 100;
519 }
520
521 static inline enum fio_ddir get_rand_ddir(struct thread_data *td)
522 {
523         unsigned int v;
524         unsigned long r;
525
526         r = __rand(&td->rwmix_state);
527         v = 1 + (int) (100.0 * (r / (FRAND_MAX + 1.0)));
528
529         if (v <= td->o.rwmix[DDIR_READ])
530                 return DDIR_READ;
531
532         return DDIR_WRITE;
533 }
534
535 void io_u_quiesce(struct thread_data *td)
536 {
537         /*
538          * We are going to sleep, ensure that we flush anything pending as
539          * not to skew our latency numbers.
540          *
541          * Changed to only monitor 'in flight' requests here instead of the
542          * td->cur_depth, b/c td->cur_depth does not accurately represent
543          * io's that have been actually submitted to an async engine,
544          * and cur_depth is meaningless for sync engines.
545          */
546         if (td->io_u_queued || td->cur_depth) {
547                 int fio_unused ret;
548
549                 ret = td_io_commit(td);
550         }
551
552         while (td->io_u_in_flight) {
553                 int fio_unused ret;
554
555                 ret = io_u_queued_complete(td, 1, NULL);
556         }
557 }
558
559 static enum fio_ddir rate_ddir(struct thread_data *td, enum fio_ddir ddir)
560 {
561         enum fio_ddir odir = ddir ^ 1;
562         long usec;
563
564         assert(ddir_rw(ddir));
565
566         if (td->rate_pending_usleep[ddir] <= 0)
567                 return ddir;
568
569         /*
570          * We have too much pending sleep in this direction. See if we
571          * should switch.
572          */
573         if (td_rw(td) && td->o.rwmix[odir]) {
574                 /*
575                  * Other direction does not have too much pending, switch
576                  */
577                 if (td->rate_pending_usleep[odir] < 100000)
578                         return odir;
579
580                 /*
581                  * Both directions have pending sleep. Sleep the minimum time
582                  * and deduct from both.
583                  */
584                 if (td->rate_pending_usleep[ddir] <=
585                         td->rate_pending_usleep[odir]) {
586                         usec = td->rate_pending_usleep[ddir];
587                 } else {
588                         usec = td->rate_pending_usleep[odir];
589                         ddir = odir;
590                 }
591         } else
592                 usec = td->rate_pending_usleep[ddir];
593
594         io_u_quiesce(td);
595
596         usec = usec_sleep(td, usec);
597
598         td->rate_pending_usleep[ddir] -= usec;
599
600         odir = ddir ^ 1;
601         if (td_rw(td) && __should_check_rate(td, odir))
602                 td->rate_pending_usleep[odir] -= usec;
603
604         return ddir;
605 }
606
607 /*
608  * Return the data direction for the next io_u. If the job is a
609  * mixed read/write workload, check the rwmix cycle and switch if
610  * necessary.
611  */
612 static enum fio_ddir get_rw_ddir(struct thread_data *td)
613 {
614         enum fio_ddir ddir;
615
616         /*
617          * see if it's time to fsync
618          */
619         if (td->o.fsync_blocks &&
620            !(td->io_issues[DDIR_WRITE] % td->o.fsync_blocks) &&
621              td->io_issues[DDIR_WRITE] && should_fsync(td))
622                 return DDIR_SYNC;
623
624         /*
625          * see if it's time to fdatasync
626          */
627         if (td->o.fdatasync_blocks &&
628            !(td->io_issues[DDIR_WRITE] % td->o.fdatasync_blocks) &&
629              td->io_issues[DDIR_WRITE] && should_fsync(td))
630                 return DDIR_DATASYNC;
631
632         /*
633          * see if it's time to sync_file_range
634          */
635         if (td->sync_file_range_nr &&
636            !(td->io_issues[DDIR_WRITE] % td->sync_file_range_nr) &&
637              td->io_issues[DDIR_WRITE] && should_fsync(td))
638                 return DDIR_SYNC_FILE_RANGE;
639
640         if (td_rw(td)) {
641                 /*
642                  * Check if it's time to seed a new data direction.
643                  */
644                 if (td->io_issues[td->rwmix_ddir] >= td->rwmix_issues) {
645                         /*
646                          * Put a top limit on how many bytes we do for
647                          * one data direction, to avoid overflowing the
648                          * ranges too much
649                          */
650                         ddir = get_rand_ddir(td);
651
652                         if (ddir != td->rwmix_ddir)
653                                 set_rwmix_bytes(td);
654
655                         td->rwmix_ddir = ddir;
656                 }
657                 ddir = td->rwmix_ddir;
658         } else if (td_read(td))
659                 ddir = DDIR_READ;
660         else if (td_write(td))
661                 ddir = DDIR_WRITE;
662         else
663                 ddir = DDIR_TRIM;
664
665         td->rwmix_ddir = rate_ddir(td, ddir);
666         return td->rwmix_ddir;
667 }
668
669 static void set_rw_ddir(struct thread_data *td, struct io_u *io_u)
670 {
671         enum fio_ddir ddir = get_rw_ddir(td);
672
673         if (td_trimwrite(td)) {
674                 struct fio_file *f = io_u->file;
675                 if (f->last_pos[DDIR_WRITE] == f->last_pos[DDIR_TRIM])
676                         ddir = DDIR_TRIM;
677                 else
678                         ddir = DDIR_WRITE;
679         }
680
681         io_u->ddir = io_u->acct_ddir = ddir;
682
683         if (io_u->ddir == DDIR_WRITE && (td->io_ops->flags & FIO_BARRIER) &&
684             td->o.barrier_blocks &&
685            !(td->io_issues[DDIR_WRITE] % td->o.barrier_blocks) &&
686              td->io_issues[DDIR_WRITE])
687                 io_u->flags |= IO_U_F_BARRIER;
688 }
689
690 void put_file_log(struct thread_data *td, struct fio_file *f)
691 {
692         unsigned int ret = put_file(td, f);
693
694         if (ret)
695                 td_verror(td, ret, "file close");
696 }
697
698 void put_io_u(struct thread_data *td, struct io_u *io_u)
699 {
700         td_io_u_lock(td);
701
702         if (io_u->file && !(io_u->flags & IO_U_F_NO_FILE_PUT))
703                 put_file_log(td, io_u->file);
704
705         io_u->file = NULL;
706         io_u->flags |= IO_U_F_FREE;
707
708         if (io_u->flags & IO_U_F_IN_CUR_DEPTH)
709                 td->cur_depth--;
710         io_u_qpush(&td->io_u_freelist, io_u);
711         td_io_u_unlock(td);
712         td_io_u_free_notify(td);
713 }
714
715 void clear_io_u(struct thread_data *td, struct io_u *io_u)
716 {
717         io_u->flags &= ~IO_U_F_FLIGHT;
718         put_io_u(td, io_u);
719 }
720
721 void requeue_io_u(struct thread_data *td, struct io_u **io_u)
722 {
723         struct io_u *__io_u = *io_u;
724         enum fio_ddir ddir = acct_ddir(__io_u);
725
726         dprint(FD_IO, "requeue %p\n", __io_u);
727
728         td_io_u_lock(td);
729
730         __io_u->flags |= IO_U_F_FREE;
731         if ((__io_u->flags & IO_U_F_FLIGHT) && ddir_rw(ddir))
732                 td->io_issues[ddir]--;
733
734         __io_u->flags &= ~IO_U_F_FLIGHT;
735         if (__io_u->flags & IO_U_F_IN_CUR_DEPTH)
736                 td->cur_depth--;
737
738         io_u_rpush(&td->io_u_requeues, __io_u);
739         td_io_u_unlock(td);
740         *io_u = NULL;
741 }
742
743 static int fill_io_u(struct thread_data *td, struct io_u *io_u)
744 {
745         unsigned int is_random;
746
747         if (td->io_ops->flags & FIO_NOIO)
748                 goto out;
749
750         set_rw_ddir(td, io_u);
751
752         /*
753          * fsync() or fdatasync() or trim etc, we are done
754          */
755         if (!ddir_rw(io_u->ddir))
756                 goto out;
757
758         /*
759          * See if it's time to switch to a new zone
760          */
761         if (td->zone_bytes >= td->o.zone_size && td->o.zone_skip) {
762                 struct fio_file *f = io_u->file;
763
764                 td->zone_bytes = 0;
765                 f->file_offset += td->o.zone_range + td->o.zone_skip;
766
767                 /*
768                  * Wrap from the beginning, if we exceed the file size
769                  */
770                 if (f->file_offset >= f->real_file_size)
771                         f->file_offset = f->real_file_size - f->file_offset;
772                 f->last_pos[io_u->ddir] = f->file_offset;
773                 td->io_skip_bytes += td->o.zone_skip;
774         }
775
776         /*
777          * No log, let the seq/rand engine retrieve the next buflen and
778          * position.
779          */
780         if (get_next_offset(td, io_u, &is_random)) {
781                 dprint(FD_IO, "io_u %p, failed getting offset\n", io_u);
782                 return 1;
783         }
784
785         io_u->buflen = get_next_buflen(td, io_u, is_random);
786         if (!io_u->buflen) {
787                 dprint(FD_IO, "io_u %p, failed getting buflen\n", io_u);
788                 return 1;
789         }
790
791         if (io_u->offset + io_u->buflen > io_u->file->real_file_size) {
792                 dprint(FD_IO, "io_u %p, offset too large\n", io_u);
793                 dprint(FD_IO, "  off=%llu/%lu > %llu\n",
794                         (unsigned long long) io_u->offset, io_u->buflen,
795                         (unsigned long long) io_u->file->real_file_size);
796                 return 1;
797         }
798
799         /*
800          * mark entry before potentially trimming io_u
801          */
802         if (td_random(td) && file_randommap(td, io_u->file))
803                 mark_random_map(td, io_u);
804
805 out:
806         dprint_io_u(io_u, "fill_io_u");
807         td->zone_bytes += io_u->buflen;
808         return 0;
809 }
810
811 static void __io_u_mark_map(unsigned int *map, unsigned int nr)
812 {
813         int idx = 0;
814
815         switch (nr) {
816         default:
817                 idx = 6;
818                 break;
819         case 33 ... 64:
820                 idx = 5;
821                 break;
822         case 17 ... 32:
823                 idx = 4;
824                 break;
825         case 9 ... 16:
826                 idx = 3;
827                 break;
828         case 5 ... 8:
829                 idx = 2;
830                 break;
831         case 1 ... 4:
832                 idx = 1;
833         case 0:
834                 break;
835         }
836
837         map[idx]++;
838 }
839
840 void io_u_mark_submit(struct thread_data *td, unsigned int nr)
841 {
842         __io_u_mark_map(td->ts.io_u_submit, nr);
843         td->ts.total_submit++;
844 }
845
846 void io_u_mark_complete(struct thread_data *td, unsigned int nr)
847 {
848         __io_u_mark_map(td->ts.io_u_complete, nr);
849         td->ts.total_complete++;
850 }
851
852 void io_u_mark_depth(struct thread_data *td, unsigned int nr)
853 {
854         int idx = 0;
855
856         switch (td->cur_depth) {
857         default:
858                 idx = 6;
859                 break;
860         case 32 ... 63:
861                 idx = 5;
862                 break;
863         case 16 ... 31:
864                 idx = 4;
865                 break;
866         case 8 ... 15:
867                 idx = 3;
868                 break;
869         case 4 ... 7:
870                 idx = 2;
871                 break;
872         case 2 ... 3:
873                 idx = 1;
874         case 1:
875                 break;
876         }
877
878         td->ts.io_u_map[idx] += nr;
879 }
880
881 static void io_u_mark_lat_usec(struct thread_data *td, unsigned long usec)
882 {
883         int idx = 0;
884
885         assert(usec < 1000);
886
887         switch (usec) {
888         case 750 ... 999:
889                 idx = 9;
890                 break;
891         case 500 ... 749:
892                 idx = 8;
893                 break;
894         case 250 ... 499:
895                 idx = 7;
896                 break;
897         case 100 ... 249:
898                 idx = 6;
899                 break;
900         case 50 ... 99:
901                 idx = 5;
902                 break;
903         case 20 ... 49:
904                 idx = 4;
905                 break;
906         case 10 ... 19:
907                 idx = 3;
908                 break;
909         case 4 ... 9:
910                 idx = 2;
911                 break;
912         case 2 ... 3:
913                 idx = 1;
914         case 0 ... 1:
915                 break;
916         }
917
918         assert(idx < FIO_IO_U_LAT_U_NR);
919         td->ts.io_u_lat_u[idx]++;
920 }
921
922 static void io_u_mark_lat_msec(struct thread_data *td, unsigned long msec)
923 {
924         int idx = 0;
925
926         switch (msec) {
927         default:
928                 idx = 11;
929                 break;
930         case 1000 ... 1999:
931                 idx = 10;
932                 break;
933         case 750 ... 999:
934                 idx = 9;
935                 break;
936         case 500 ... 749:
937                 idx = 8;
938                 break;
939         case 250 ... 499:
940                 idx = 7;
941                 break;
942         case 100 ... 249:
943                 idx = 6;
944                 break;
945         case 50 ... 99:
946                 idx = 5;
947                 break;
948         case 20 ... 49:
949                 idx = 4;
950                 break;
951         case 10 ... 19:
952                 idx = 3;
953                 break;
954         case 4 ... 9:
955                 idx = 2;
956                 break;
957         case 2 ... 3:
958                 idx = 1;
959         case 0 ... 1:
960                 break;
961         }
962
963         assert(idx < FIO_IO_U_LAT_M_NR);
964         td->ts.io_u_lat_m[idx]++;
965 }
966
967 static void io_u_mark_latency(struct thread_data *td, unsigned long usec)
968 {
969         if (usec < 1000)
970                 io_u_mark_lat_usec(td, usec);
971         else
972                 io_u_mark_lat_msec(td, usec / 1000);
973 }
974
975 /*
976  * Get next file to service by choosing one at random
977  */
978 static struct fio_file *get_next_file_rand(struct thread_data *td,
979                                            enum fio_file_flags goodf,
980                                            enum fio_file_flags badf)
981 {
982         struct fio_file *f;
983         int fno;
984
985         do {
986                 int opened = 0;
987                 unsigned long r;
988
989                 r = __rand(&td->next_file_state);
990                 fno = (unsigned int) ((double) td->o.nr_files
991                                 * (r / (FRAND_MAX + 1.0)));
992
993                 f = td->files[fno];
994                 if (fio_file_done(f))
995                         continue;
996
997                 if (!fio_file_open(f)) {
998                         int err;
999
1000                         if (td->nr_open_files >= td->o.open_files)
1001                                 return ERR_PTR(-EBUSY);
1002
1003                         err = td_io_open_file(td, f);
1004                         if (err)
1005                                 continue;
1006                         opened = 1;
1007                 }
1008
1009                 if ((!goodf || (f->flags & goodf)) && !(f->flags & badf)) {
1010                         dprint(FD_FILE, "get_next_file_rand: %p\n", f);
1011                         return f;
1012                 }
1013                 if (opened)
1014                         td_io_close_file(td, f);
1015         } while (1);
1016 }
1017
1018 /*
1019  * Get next file to service by doing round robin between all available ones
1020  */
1021 static struct fio_file *get_next_file_rr(struct thread_data *td, int goodf,
1022                                          int badf)
1023 {
1024         unsigned int old_next_file = td->next_file;
1025         struct fio_file *f;
1026
1027         do {
1028                 int opened = 0;
1029
1030                 f = td->files[td->next_file];
1031
1032                 td->next_file++;
1033                 if (td->next_file >= td->o.nr_files)
1034                         td->next_file = 0;
1035
1036                 dprint(FD_FILE, "trying file %s %x\n", f->file_name, f->flags);
1037                 if (fio_file_done(f)) {
1038                         f = NULL;
1039                         continue;
1040                 }
1041
1042                 if (!fio_file_open(f)) {
1043                         int err;
1044
1045                         if (td->nr_open_files >= td->o.open_files)
1046                                 return ERR_PTR(-EBUSY);
1047
1048                         err = td_io_open_file(td, f);
1049                         if (err) {
1050                                 dprint(FD_FILE, "error %d on open of %s\n",
1051                                         err, f->file_name);
1052                                 f = NULL;
1053                                 continue;
1054                         }
1055                         opened = 1;
1056                 }
1057
1058                 dprint(FD_FILE, "goodf=%x, badf=%x, ff=%x\n", goodf, badf,
1059                                                                 f->flags);
1060                 if ((!goodf || (f->flags & goodf)) && !(f->flags & badf))
1061                         break;
1062
1063                 if (opened)
1064                         td_io_close_file(td, f);
1065
1066                 f = NULL;
1067         } while (td->next_file != old_next_file);
1068
1069         dprint(FD_FILE, "get_next_file_rr: %p\n", f);
1070         return f;
1071 }
1072
1073 static struct fio_file *__get_next_file(struct thread_data *td)
1074 {
1075         struct fio_file *f;
1076
1077         assert(td->o.nr_files <= td->files_index);
1078
1079         if (td->nr_done_files >= td->o.nr_files) {
1080                 dprint(FD_FILE, "get_next_file: nr_open=%d, nr_done=%d,"
1081                                 " nr_files=%d\n", td->nr_open_files,
1082                                                   td->nr_done_files,
1083                                                   td->o.nr_files);
1084                 return NULL;
1085         }
1086
1087         f = td->file_service_file;
1088         if (f && fio_file_open(f) && !fio_file_closing(f)) {
1089                 if (td->o.file_service_type == FIO_FSERVICE_SEQ)
1090                         goto out;
1091                 if (td->file_service_left--)
1092                         goto out;
1093         }
1094
1095         if (td->o.file_service_type == FIO_FSERVICE_RR ||
1096             td->o.file_service_type == FIO_FSERVICE_SEQ)
1097                 f = get_next_file_rr(td, FIO_FILE_open, FIO_FILE_closing);
1098         else
1099                 f = get_next_file_rand(td, FIO_FILE_open, FIO_FILE_closing);
1100
1101         if (IS_ERR(f))
1102                 return f;
1103
1104         td->file_service_file = f;
1105         td->file_service_left = td->file_service_nr - 1;
1106 out:
1107         if (f)
1108                 dprint(FD_FILE, "get_next_file: %p [%s]\n", f, f->file_name);
1109         else
1110                 dprint(FD_FILE, "get_next_file: NULL\n");
1111         return f;
1112 }
1113
1114 static struct fio_file *get_next_file(struct thread_data *td)
1115 {
1116         if (td->flags & TD_F_PROFILE_OPS) {
1117                 struct prof_io_ops *ops = &td->prof_io_ops;
1118
1119                 if (ops->get_next_file)
1120                         return ops->get_next_file(td);
1121         }
1122
1123         return __get_next_file(td);
1124 }
1125
1126 static long set_io_u_file(struct thread_data *td, struct io_u *io_u)
1127 {
1128         struct fio_file *f;
1129
1130         do {
1131                 f = get_next_file(td);
1132                 if (IS_ERR_OR_NULL(f))
1133                         return PTR_ERR(f);
1134
1135                 io_u->file = f;
1136                 get_file(f);
1137
1138                 if (!fill_io_u(td, io_u))
1139                         break;
1140
1141                 put_file_log(td, f);
1142                 td_io_close_file(td, f);
1143                 io_u->file = NULL;
1144                 fio_file_set_done(f);
1145                 td->nr_done_files++;
1146                 dprint(FD_FILE, "%s: is done (%d of %d)\n", f->file_name,
1147                                         td->nr_done_files, td->o.nr_files);
1148         } while (1);
1149
1150         return 0;
1151 }
1152
1153 static void lat_fatal(struct thread_data *td, struct io_completion_data *icd,
1154                       unsigned long tusec, unsigned long max_usec)
1155 {
1156         if (!td->error)
1157                 log_err("fio: latency of %lu usec exceeds specified max (%lu usec)\n", tusec, max_usec);
1158         td_verror(td, ETIMEDOUT, "max latency exceeded");
1159         icd->error = ETIMEDOUT;
1160 }
1161
1162 static void lat_new_cycle(struct thread_data *td)
1163 {
1164         fio_gettime(&td->latency_ts, NULL);
1165         td->latency_ios = ddir_rw_sum(td->io_blocks);
1166         td->latency_failed = 0;
1167 }
1168
1169 /*
1170  * We had an IO outside the latency target. Reduce the queue depth. If we
1171  * are at QD=1, then it's time to give up.
1172  */
1173 static int __lat_target_failed(struct thread_data *td)
1174 {
1175         if (td->latency_qd == 1)
1176                 return 1;
1177
1178         td->latency_qd_high = td->latency_qd;
1179
1180         if (td->latency_qd == td->latency_qd_low)
1181                 td->latency_qd_low--;
1182
1183         td->latency_qd = (td->latency_qd + td->latency_qd_low) / 2;
1184
1185         dprint(FD_RATE, "Ramped down: %d %d %d\n", td->latency_qd_low, td->latency_qd, td->latency_qd_high);
1186
1187         /*
1188          * When we ramp QD down, quiesce existing IO to prevent
1189          * a storm of ramp downs due to pending higher depth.
1190          */
1191         io_u_quiesce(td);
1192         lat_new_cycle(td);
1193         return 0;
1194 }
1195
1196 static int lat_target_failed(struct thread_data *td)
1197 {
1198         if (td->o.latency_percentile.u.f == 100.0)
1199                 return __lat_target_failed(td);
1200
1201         td->latency_failed++;
1202         return 0;
1203 }
1204
1205 void lat_target_init(struct thread_data *td)
1206 {
1207         td->latency_end_run = 0;
1208
1209         if (td->o.latency_target) {
1210                 dprint(FD_RATE, "Latency target=%llu\n", td->o.latency_target);
1211                 fio_gettime(&td->latency_ts, NULL);
1212                 td->latency_qd = 1;
1213                 td->latency_qd_high = td->o.iodepth;
1214                 td->latency_qd_low = 1;
1215                 td->latency_ios = ddir_rw_sum(td->io_blocks);
1216         } else
1217                 td->latency_qd = td->o.iodepth;
1218 }
1219
1220 void lat_target_reset(struct thread_data *td)
1221 {
1222         if (!td->latency_end_run)
1223                 lat_target_init(td);
1224 }
1225
1226 static void lat_target_success(struct thread_data *td)
1227 {
1228         const unsigned int qd = td->latency_qd;
1229         struct thread_options *o = &td->o;
1230
1231         td->latency_qd_low = td->latency_qd;
1232
1233         /*
1234          * If we haven't failed yet, we double up to a failing value instead
1235          * of bisecting from highest possible queue depth. If we have set
1236          * a limit other than td->o.iodepth, bisect between that.
1237          */
1238         if (td->latency_qd_high != o->iodepth)
1239                 td->latency_qd = (td->latency_qd + td->latency_qd_high) / 2;
1240         else
1241                 td->latency_qd *= 2;
1242
1243         if (td->latency_qd > o->iodepth)
1244                 td->latency_qd = o->iodepth;
1245
1246         dprint(FD_RATE, "Ramped up: %d %d %d\n", td->latency_qd_low, td->latency_qd, td->latency_qd_high);
1247
1248         /*
1249          * Same as last one, we are done. Let it run a latency cycle, so
1250          * we get only the results from the targeted depth.
1251          */
1252         if (td->latency_qd == qd) {
1253                 if (td->latency_end_run) {
1254                         dprint(FD_RATE, "We are done\n");
1255                         td->done = 1;
1256                 } else {
1257                         dprint(FD_RATE, "Quiesce and final run\n");
1258                         io_u_quiesce(td);
1259                         td->latency_end_run = 1;
1260                         reset_all_stats(td);
1261                         reset_io_stats(td);
1262                 }
1263         }
1264
1265         lat_new_cycle(td);
1266 }
1267
1268 /*
1269  * Check if we can bump the queue depth
1270  */
1271 void lat_target_check(struct thread_data *td)
1272 {
1273         uint64_t usec_window;
1274         uint64_t ios;
1275         double success_ios;
1276
1277         usec_window = utime_since_now(&td->latency_ts);
1278         if (usec_window < td->o.latency_window)
1279                 return;
1280
1281         ios = ddir_rw_sum(td->io_blocks) - td->latency_ios;
1282         success_ios = (double) (ios - td->latency_failed) / (double) ios;
1283         success_ios *= 100.0;
1284
1285         dprint(FD_RATE, "Success rate: %.2f%% (target %.2f%%)\n", success_ios, td->o.latency_percentile.u.f);
1286
1287         if (success_ios >= td->o.latency_percentile.u.f)
1288                 lat_target_success(td);
1289         else
1290                 __lat_target_failed(td);
1291 }
1292
1293 /*
1294  * If latency target is enabled, we might be ramping up or down and not
1295  * using the full queue depth available.
1296  */
1297 int queue_full(const struct thread_data *td)
1298 {
1299         const int qempty = io_u_qempty(&td->io_u_freelist);
1300
1301         if (qempty)
1302                 return 1;
1303         if (!td->o.latency_target)
1304                 return 0;
1305
1306         return td->cur_depth >= td->latency_qd;
1307 }
1308
1309 struct io_u *__get_io_u(struct thread_data *td)
1310 {
1311         struct io_u *io_u = NULL;
1312
1313         if (td->stop_io)
1314                 return NULL;
1315
1316         td_io_u_lock(td);
1317
1318 again:
1319         if (!io_u_rempty(&td->io_u_requeues))
1320                 io_u = io_u_rpop(&td->io_u_requeues);
1321         else if (!queue_full(td)) {
1322                 io_u = io_u_qpop(&td->io_u_freelist);
1323
1324                 io_u->file = NULL;
1325                 io_u->buflen = 0;
1326                 io_u->resid = 0;
1327                 io_u->end_io = NULL;
1328         }
1329
1330         if (io_u) {
1331                 assert(io_u->flags & IO_U_F_FREE);
1332                 io_u->flags &= ~(IO_U_F_FREE | IO_U_F_NO_FILE_PUT |
1333                                  IO_U_F_TRIMMED | IO_U_F_BARRIER |
1334                                  IO_U_F_VER_LIST);
1335
1336                 io_u->error = 0;
1337                 io_u->acct_ddir = -1;
1338                 td->cur_depth++;
1339                 io_u->flags |= IO_U_F_IN_CUR_DEPTH;
1340                 io_u->ipo = NULL;
1341         } else if (td->o.verify_async) {
1342                 /*
1343                  * We ran out, wait for async verify threads to finish and
1344                  * return one
1345                  */
1346                 pthread_cond_wait(&td->free_cond, &td->io_u_lock);
1347                 goto again;
1348         }
1349
1350         td_io_u_unlock(td);
1351         return io_u;
1352 }
1353
1354 static int check_get_trim(struct thread_data *td, struct io_u *io_u)
1355 {
1356         if (!(td->flags & TD_F_TRIM_BACKLOG))
1357                 return 0;
1358
1359         if (td->trim_entries) {
1360                 int get_trim = 0;
1361
1362                 if (td->trim_batch) {
1363                         td->trim_batch--;
1364                         get_trim = 1;
1365                 } else if (!(td->io_hist_len % td->o.trim_backlog) &&
1366                          td->last_ddir != DDIR_READ) {
1367                         td->trim_batch = td->o.trim_batch;
1368                         if (!td->trim_batch)
1369                                 td->trim_batch = td->o.trim_backlog;
1370                         get_trim = 1;
1371                 }
1372
1373                 if (get_trim && !get_next_trim(td, io_u))
1374                         return 1;
1375         }
1376
1377         return 0;
1378 }
1379
1380 static int check_get_verify(struct thread_data *td, struct io_u *io_u)
1381 {
1382         if (!(td->flags & TD_F_VER_BACKLOG))
1383                 return 0;
1384
1385         if (td->io_hist_len) {
1386                 int get_verify = 0;
1387
1388                 if (td->verify_batch)
1389                         get_verify = 1;
1390                 else if (!(td->io_hist_len % td->o.verify_backlog) &&
1391                          td->last_ddir != DDIR_READ) {
1392                         td->verify_batch = td->o.verify_batch;
1393                         if (!td->verify_batch)
1394                                 td->verify_batch = td->o.verify_backlog;
1395                         get_verify = 1;
1396                 }
1397
1398                 if (get_verify && !get_next_verify(td, io_u)) {
1399                         td->verify_batch--;
1400                         return 1;
1401                 }
1402         }
1403
1404         return 0;
1405 }
1406
1407 /*
1408  * Fill offset and start time into the buffer content, to prevent too
1409  * easy compressible data for simple de-dupe attempts. Do this for every
1410  * 512b block in the range, since that should be the smallest block size
1411  * we can expect from a device.
1412  */
1413 static void small_content_scramble(struct io_u *io_u)
1414 {
1415         unsigned int i, nr_blocks = io_u->buflen / 512;
1416         uint64_t boffset;
1417         unsigned int offset;
1418         void *p, *end;
1419
1420         if (!nr_blocks)
1421                 return;
1422
1423         p = io_u->xfer_buf;
1424         boffset = io_u->offset;
1425         io_u->buf_filled_len = 0;
1426
1427         for (i = 0; i < nr_blocks; i++) {
1428                 /*
1429                  * Fill the byte offset into a "random" start offset of
1430                  * the buffer, given by the product of the usec time
1431                  * and the actual offset.
1432                  */
1433                 offset = (io_u->start_time.tv_usec ^ boffset) & 511;
1434                 offset &= ~(sizeof(uint64_t) - 1);
1435                 if (offset >= 512 - sizeof(uint64_t))
1436                         offset -= sizeof(uint64_t);
1437                 memcpy(p + offset, &boffset, sizeof(boffset));
1438
1439                 end = p + 512 - sizeof(io_u->start_time);
1440                 memcpy(end, &io_u->start_time, sizeof(io_u->start_time));
1441                 p += 512;
1442                 boffset += 512;
1443         }
1444 }
1445
1446 /*
1447  * Return an io_u to be processed. Gets a buflen and offset, sets direction,
1448  * etc. The returned io_u is fully ready to be prepped and submitted.
1449  */
1450 struct io_u *get_io_u(struct thread_data *td)
1451 {
1452         struct fio_file *f;
1453         struct io_u *io_u;
1454         int do_scramble = 0;
1455         long ret = 0;
1456
1457         io_u = __get_io_u(td);
1458         if (!io_u) {
1459                 dprint(FD_IO, "__get_io_u failed\n");
1460                 return NULL;
1461         }
1462
1463         if (check_get_verify(td, io_u))
1464                 goto out;
1465         if (check_get_trim(td, io_u))
1466                 goto out;
1467
1468         /*
1469          * from a requeue, io_u already setup
1470          */
1471         if (io_u->file)
1472                 goto out;
1473
1474         /*
1475          * If using an iolog, grab next piece if any available.
1476          */
1477         if (td->flags & TD_F_READ_IOLOG) {
1478                 if (read_iolog_get(td, io_u))
1479                         goto err_put;
1480         } else if (set_io_u_file(td, io_u)) {
1481                 ret = -EBUSY;
1482                 dprint(FD_IO, "io_u %p, setting file failed\n", io_u);
1483                 goto err_put;
1484         }
1485
1486         f = io_u->file;
1487         if (!f) {
1488                 dprint(FD_IO, "io_u %p, setting file failed\n", io_u);
1489                 goto err_put;
1490         }
1491
1492         assert(fio_file_open(f));
1493
1494         if (ddir_rw(io_u->ddir)) {
1495                 if (!io_u->buflen && !(td->io_ops->flags & FIO_NOIO)) {
1496                         dprint(FD_IO, "get_io_u: zero buflen on %p\n", io_u);
1497                         goto err_put;
1498                 }
1499
1500                 f->last_start[io_u->ddir] = io_u->offset;
1501                 f->last_pos[io_u->ddir] = io_u->offset + io_u->buflen;
1502
1503                 if (io_u->ddir == DDIR_WRITE) {
1504                         if (td->flags & TD_F_REFILL_BUFFERS) {
1505                                 io_u_fill_buffer(td, io_u,
1506                                         td->o.min_bs[DDIR_WRITE],
1507                                         io_u->xfer_buflen);
1508                         } else if ((td->flags & TD_F_SCRAMBLE_BUFFERS) &&
1509                                    !(td->flags & TD_F_COMPRESS))
1510                                 do_scramble = 1;
1511                         if (td->flags & TD_F_VER_NONE) {
1512                                 populate_verify_io_u(td, io_u);
1513                                 do_scramble = 0;
1514                         }
1515                 } else if (io_u->ddir == DDIR_READ) {
1516                         /*
1517                          * Reset the buf_filled parameters so next time if the
1518                          * buffer is used for writes it is refilled.
1519                          */
1520                         io_u->buf_filled_len = 0;
1521                 }
1522         }
1523
1524         /*
1525          * Set io data pointers.
1526          */
1527         io_u->xfer_buf = io_u->buf;
1528         io_u->xfer_buflen = io_u->buflen;
1529
1530 out:
1531         assert(io_u->file);
1532         if (!td_io_prep(td, io_u)) {
1533                 if (!td->o.disable_slat)
1534                         fio_gettime(&io_u->start_time, NULL);
1535                 if (do_scramble)
1536                         small_content_scramble(io_u);
1537                 return io_u;
1538         }
1539 err_put:
1540         dprint(FD_IO, "get_io_u failed\n");
1541         put_io_u(td, io_u);
1542         return ERR_PTR(ret);
1543 }
1544
1545 void io_u_log_error(struct thread_data *td, struct io_u *io_u)
1546 {
1547         enum error_type_bit eb = td_error_type(io_u->ddir, io_u->error);
1548
1549         if (td_non_fatal_error(td, eb, io_u->error) && !td->o.error_dump)
1550                 return;
1551
1552         log_err("fio: io_u error%s%s: %s: %s offset=%llu, buflen=%lu\n",
1553                 io_u->file ? " on file " : "",
1554                 io_u->file ? io_u->file->file_name : "",
1555                 strerror(io_u->error),
1556                 io_ddir_name(io_u->ddir),
1557                 io_u->offset, io_u->xfer_buflen);
1558
1559         if (!td->error)
1560                 td_verror(td, io_u->error, "io_u error");
1561 }
1562
1563 static inline int gtod_reduce(struct thread_data *td)
1564 {
1565         return td->o.disable_clat && td->o.disable_lat && td->o.disable_slat
1566                 && td->o.disable_bw;
1567 }
1568
1569 static void account_io_completion(struct thread_data *td, struct io_u *io_u,
1570                                   struct io_completion_data *icd,
1571                                   const enum fio_ddir idx, unsigned int bytes)
1572 {
1573         unsigned long lusec = 0;
1574
1575         if (!gtod_reduce(td))
1576                 lusec = utime_since(&io_u->issue_time, &icd->time);
1577
1578         if (!td->o.disable_lat) {
1579                 unsigned long tusec;
1580
1581                 tusec = utime_since(&io_u->start_time, &icd->time);
1582                 add_lat_sample(td, idx, tusec, bytes, io_u->offset);
1583
1584                 if (td->flags & TD_F_PROFILE_OPS) {
1585                         struct prof_io_ops *ops = &td->prof_io_ops;
1586
1587                         if (ops->io_u_lat)
1588                                 icd->error = ops->io_u_lat(td, tusec);
1589                 }
1590
1591                 if (td->o.max_latency && tusec > td->o.max_latency)
1592                         lat_fatal(td, icd, tusec, td->o.max_latency);
1593                 if (td->o.latency_target && tusec > td->o.latency_target) {
1594                         if (lat_target_failed(td))
1595                                 lat_fatal(td, icd, tusec, td->o.latency_target);
1596                 }
1597         }
1598
1599         if (!td->o.disable_clat) {
1600                 add_clat_sample(td, idx, lusec, bytes, io_u->offset);
1601                 io_u_mark_latency(td, lusec);
1602         }
1603
1604         if (!td->o.disable_bw)
1605                 add_bw_sample(td, idx, bytes, &icd->time);
1606
1607         if (!gtod_reduce(td))
1608                 add_iops_sample(td, idx, bytes, &icd->time);
1609
1610         if (td->ts.nr_block_infos && io_u->ddir == DDIR_TRIM) {
1611                 uint32_t *info = io_u_block_info(td, io_u);
1612                 if (BLOCK_INFO_STATE(*info) < BLOCK_STATE_TRIM_FAILURE) {
1613                         if (io_u->ddir == DDIR_TRIM) {
1614                                 *info = BLOCK_INFO(BLOCK_STATE_TRIMMED,
1615                                                 BLOCK_INFO_TRIMS(*info) + 1);
1616                         } else if (io_u->ddir == DDIR_WRITE) {
1617                                 *info = BLOCK_INFO_SET_STATE(BLOCK_STATE_WRITTEN,
1618                                                                 *info);
1619                         }
1620                 }
1621         }
1622 }
1623
1624 static long long usec_for_io(struct thread_data *td, enum fio_ddir ddir)
1625 {
1626         uint64_t secs, remainder, bps, bytes;
1627
1628         bytes = td->this_io_bytes[ddir];
1629         bps = td->rate_bps[ddir];
1630         secs = bytes / bps;
1631         remainder = bytes % bps;
1632         return remainder * 1000000 / bps + secs * 1000000;
1633 }
1634
1635 static void io_completed(struct thread_data *td, struct io_u **io_u_ptr,
1636                          struct io_completion_data *icd)
1637 {
1638         struct io_u *io_u = *io_u_ptr;
1639         enum fio_ddir ddir = io_u->ddir;
1640         struct fio_file *f = io_u->file;
1641
1642         dprint_io_u(io_u, "io complete");
1643
1644         td_io_u_lock(td);
1645         assert(io_u->flags & IO_U_F_FLIGHT);
1646         io_u->flags &= ~(IO_U_F_FLIGHT | IO_U_F_BUSY_OK);
1647
1648         /*
1649          * Mark IO ok to verify
1650          */
1651         if (io_u->ipo) {
1652                 /*
1653                  * Remove errored entry from the verification list
1654                  */
1655                 if (io_u->error)
1656                         unlog_io_piece(td, io_u);
1657                 else {
1658                         io_u->ipo->flags &= ~IP_F_IN_FLIGHT;
1659                         write_barrier();
1660                 }
1661         }
1662
1663         td_io_u_unlock(td);
1664
1665         if (ddir_sync(ddir)) {
1666                 td->last_was_sync = 1;
1667                 if (f) {
1668                         f->first_write = -1ULL;
1669                         f->last_write = -1ULL;
1670                 }
1671                 return;
1672         }
1673
1674         td->last_was_sync = 0;
1675         td->last_ddir = ddir;
1676
1677         if (!io_u->error && ddir_rw(ddir)) {
1678                 unsigned int bytes = io_u->buflen - io_u->resid;
1679                 const enum fio_ddir oddir = ddir ^ 1;
1680                 int ret;
1681
1682                 td->io_blocks[ddir]++;
1683                 td->this_io_blocks[ddir]++;
1684                 td->io_bytes[ddir] += bytes;
1685
1686                 if (!(io_u->flags & IO_U_F_VER_LIST))
1687                         td->this_io_bytes[ddir] += bytes;
1688
1689                 if (ddir == DDIR_WRITE) {
1690                         if (f) {
1691                                 if (f->first_write == -1ULL ||
1692                                     io_u->offset < f->first_write)
1693                                         f->first_write = io_u->offset;
1694                                 if (f->last_write == -1ULL ||
1695                                     ((io_u->offset + bytes) > f->last_write))
1696                                         f->last_write = io_u->offset + bytes;
1697                         }
1698                         if (td->last_write_comp) {
1699                                 int idx = td->last_write_idx++;
1700
1701                                 td->last_write_comp[idx] = io_u->offset;
1702                                 if (td->last_write_idx == td->o.iodepth)
1703                                         td->last_write_idx = 0;
1704                         }
1705                 }
1706
1707                 if (ramp_time_over(td) && (td->runstate == TD_RUNNING ||
1708                                            td->runstate == TD_VERIFYING)) {
1709                         account_io_completion(td, io_u, icd, ddir, bytes);
1710
1711                         if (__should_check_rate(td, ddir)) {
1712                                 td->rate_pending_usleep[ddir] =
1713                                         (usec_for_io(td, ddir) -
1714                                          utime_since_now(&td->start));
1715                         }
1716                         if (ddir != DDIR_TRIM &&
1717                             __should_check_rate(td, oddir)) {
1718                                 td->rate_pending_usleep[oddir] =
1719                                         (usec_for_io(td, oddir) -
1720                                          utime_since_now(&td->start));
1721                         }
1722                 }
1723
1724                 icd->bytes_done[ddir] += bytes;
1725
1726                 if (io_u->end_io) {
1727                         ret = io_u->end_io(td, io_u_ptr);
1728                         io_u = *io_u_ptr;
1729                         if (ret && !icd->error)
1730                                 icd->error = ret;
1731                 }
1732         } else if (io_u->error) {
1733                 icd->error = io_u->error;
1734                 io_u_log_error(td, io_u);
1735         }
1736         if (icd->error) {
1737                 enum error_type_bit eb = td_error_type(ddir, icd->error);
1738
1739                 if (!td_non_fatal_error(td, eb, icd->error))
1740                         return;
1741
1742                 /*
1743                  * If there is a non_fatal error, then add to the error count
1744                  * and clear all the errors.
1745                  */
1746                 update_error_count(td, icd->error);
1747                 td_clear_error(td);
1748                 icd->error = 0;
1749                 if (io_u)
1750                         io_u->error = 0;
1751         }
1752 }
1753
1754 static void init_icd(struct thread_data *td, struct io_completion_data *icd,
1755                      int nr)
1756 {
1757         int ddir;
1758
1759         if (!gtod_reduce(td))
1760                 fio_gettime(&icd->time, NULL);
1761
1762         icd->nr = nr;
1763
1764         icd->error = 0;
1765         for (ddir = DDIR_READ; ddir < DDIR_RWDIR_CNT; ddir++)
1766                 icd->bytes_done[ddir] = 0;
1767 }
1768
1769 static void ios_completed(struct thread_data *td,
1770                           struct io_completion_data *icd)
1771 {
1772         struct io_u *io_u;
1773         int i;
1774
1775         for (i = 0; i < icd->nr; i++) {
1776                 io_u = td->io_ops->event(td, i);
1777
1778                 io_completed(td, &io_u, icd);
1779
1780                 if (io_u)
1781                         put_io_u(td, io_u);
1782         }
1783 }
1784
1785 /*
1786  * Complete a single io_u for the sync engines.
1787  */
1788 int io_u_sync_complete(struct thread_data *td, struct io_u *io_u,
1789                        uint64_t *bytes)
1790 {
1791         struct io_completion_data icd;
1792
1793         init_icd(td, &icd, 1);
1794         io_completed(td, &io_u, &icd);
1795
1796         if (io_u)
1797                 put_io_u(td, io_u);
1798
1799         if (icd.error) {
1800                 td_verror(td, icd.error, "io_u_sync_complete");
1801                 return -1;
1802         }
1803
1804         if (bytes) {
1805                 int ddir;
1806
1807                 for (ddir = DDIR_READ; ddir < DDIR_RWDIR_CNT; ddir++)
1808                         bytes[ddir] += icd.bytes_done[ddir];
1809         }
1810
1811         return 0;
1812 }
1813
1814 /*
1815  * Called to complete min_events number of io for the async engines.
1816  */
1817 int io_u_queued_complete(struct thread_data *td, int min_evts,
1818                          uint64_t *bytes)
1819 {
1820         struct io_completion_data icd;
1821         struct timespec *tvp = NULL;
1822         int ret;
1823         struct timespec ts = { .tv_sec = 0, .tv_nsec = 0, };
1824
1825         dprint(FD_IO, "io_u_queued_completed: min=%d\n", min_evts);
1826
1827         if (!min_evts)
1828                 tvp = &ts;
1829         else if (min_evts > td->cur_depth)
1830                 min_evts = td->cur_depth;
1831
1832         ret = td_io_getevents(td, min_evts, td->o.iodepth_batch_complete, tvp);
1833         if (ret < 0) {
1834                 td_verror(td, -ret, "td_io_getevents");
1835                 return ret;
1836         } else if (!ret)
1837                 return ret;
1838
1839         init_icd(td, &icd, ret);
1840         ios_completed(td, &icd);
1841         if (icd.error) {
1842                 td_verror(td, icd.error, "io_u_queued_complete");
1843                 return -1;
1844         }
1845
1846         if (bytes) {
1847                 int ddir;
1848
1849                 for (ddir = DDIR_READ; ddir < DDIR_RWDIR_CNT; ddir++)
1850                         bytes[ddir] += icd.bytes_done[ddir];
1851         }
1852
1853         return 0;
1854 }
1855
1856 /*
1857  * Call when io_u is really queued, to update the submission latency.
1858  */
1859 void io_u_queued(struct thread_data *td, struct io_u *io_u)
1860 {
1861         if (!td->o.disable_slat) {
1862                 unsigned long slat_time;
1863
1864                 slat_time = utime_since(&io_u->start_time, &io_u->issue_time);
1865                 add_slat_sample(td, io_u->ddir, slat_time, io_u->xfer_buflen,
1866                                 io_u->offset);
1867         }
1868 }
1869
1870 /*
1871  * See if we should reuse the last seed, if dedupe is enabled
1872  */
1873 static struct frand_state *get_buf_state(struct thread_data *td)
1874 {
1875         unsigned int v;
1876         unsigned long r;
1877
1878         if (!td->o.dedupe_percentage)
1879                 return &td->buf_state;
1880         else if (td->o.dedupe_percentage == 100)
1881                 return &td->buf_state_prev;
1882
1883         r = __rand(&td->dedupe_state);
1884         v = 1 + (int) (100.0 * (r / (FRAND_MAX + 1.0)));
1885
1886         if (v <= td->o.dedupe_percentage)
1887                 return &td->buf_state_prev;
1888
1889         return &td->buf_state;
1890 }
1891
1892 static void save_buf_state(struct thread_data *td, struct frand_state *rs)
1893 {
1894         if (rs == &td->buf_state)
1895                 frand_copy(&td->buf_state_prev, rs);
1896 }
1897
1898 void fill_io_buffer(struct thread_data *td, void *buf, unsigned int min_write,
1899                     unsigned int max_bs)
1900 {
1901         struct thread_options *o = &td->o;
1902
1903         if (o->compress_percentage || o->dedupe_percentage) {
1904                 unsigned int perc = td->o.compress_percentage;
1905                 struct frand_state *rs;
1906                 unsigned int left = max_bs;
1907
1908                 do {
1909                         rs = get_buf_state(td);
1910
1911                         min_write = min(min_write, left);
1912
1913                         if (perc) {
1914                                 unsigned int seg = min_write;
1915
1916                                 seg = min(min_write, td->o.compress_chunk);
1917                                 if (!seg)
1918                                         seg = min_write;
1919
1920                                 fill_random_buf_percentage(rs, buf, perc, seg,
1921                                         min_write, o->buffer_pattern,
1922                                                    o->buffer_pattern_bytes);
1923                         } else
1924                                 fill_random_buf(rs, buf, min_write);
1925
1926                         buf += min_write;
1927                         left -= min_write;
1928                         save_buf_state(td, rs);
1929                 } while (left);
1930         } else if (o->buffer_pattern_bytes)
1931                 fill_buffer_pattern(td, buf, max_bs);
1932         else if (o->zero_buffers)
1933                 memset(buf, 0, max_bs);
1934         else
1935                 fill_random_buf(get_buf_state(td), buf, max_bs);
1936 }
1937
1938 /*
1939  * "randomly" fill the buffer contents
1940  */
1941 void io_u_fill_buffer(struct thread_data *td, struct io_u *io_u,
1942                       unsigned int min_write, unsigned int max_bs)
1943 {
1944         io_u->buf_filled_len = 0;
1945         fill_io_buffer(td, io_u->buf, min_write, max_bs);
1946 }