Cmd help type fix
[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
12 struct io_completion_data {
13         int nr;                         /* input */
14
15         int error;                      /* output */
16         unsigned long bytes_done[2];    /* output */
17         struct timeval time;            /* output */
18 };
19
20 /*
21  * The ->file_map[] contains a map of blocks we have or have not done io
22  * to yet. Used to make sure we cover the entire range in a fair fashion.
23  */
24 static int random_map_free(struct fio_file *f, const unsigned long long block)
25 {
26         unsigned int idx = RAND_MAP_IDX(f, block);
27         unsigned int bit = RAND_MAP_BIT(f, block);
28
29         dprint(FD_RANDOM, "free: b=%llu, idx=%u, bit=%u\n", block, idx, bit);
30
31         return (f->file_map[idx] & (1 << bit)) == 0;
32 }
33
34 /*
35  * Mark a given offset as used in the map.
36  */
37 static void mark_random_map(struct thread_data *td, struct io_u *io_u)
38 {
39         unsigned int min_bs = td->o.rw_min_bs;
40         struct fio_file *f = io_u->file;
41         unsigned long long block;
42         unsigned int blocks, nr_blocks;
43
44         block = (io_u->offset - f->file_offset) / (unsigned long long) min_bs;
45         nr_blocks = (io_u->buflen + min_bs - 1) / min_bs;
46         blocks = 0;
47
48         while (nr_blocks) {
49                 unsigned int this_blocks, mask;
50                 unsigned int idx, bit;
51
52                 /*
53                  * If we have a mixed random workload, we may
54                  * encounter blocks we already did IO to.
55                  */
56                 if ((td->o.ddir_nr == 1) && !random_map_free(f, block)) {
57                         if (!blocks)
58                                 blocks = 1;
59                         break;
60                 }
61
62                 idx = RAND_MAP_IDX(f, block);
63                 bit = RAND_MAP_BIT(f, block);
64
65                 fio_assert(td, idx < f->num_maps);
66
67                 this_blocks = nr_blocks;
68                 if (this_blocks + bit > BLOCKS_PER_MAP)
69                         this_blocks = BLOCKS_PER_MAP - bit;
70
71                 if (this_blocks == BLOCKS_PER_MAP)
72                         mask = -1U;
73                 else
74                         mask = ((1U << this_blocks) - 1) << bit;
75
76                 f->file_map[idx] |= mask;
77                 nr_blocks -= this_blocks;
78                 blocks += this_blocks;
79                 block += this_blocks;
80         }
81
82         if ((blocks * min_bs) < io_u->buflen)
83                 io_u->buflen = blocks * min_bs;
84 }
85
86 static unsigned long long last_block(struct thread_data *td, struct fio_file *f,
87                                      enum fio_ddir ddir)
88 {
89         unsigned long long max_blocks;
90         unsigned long long max_size;
91
92         /*
93          * Hmm, should we make sure that ->io_size <= ->real_file_size?
94          */
95         max_size = f->io_size;
96         if (max_size > f->real_file_size)
97                 max_size = f->real_file_size;
98
99         max_blocks = max_size / (unsigned long long) td->o.ba[ddir];
100         if (!max_blocks)
101                 return 0;
102
103         return max_blocks;
104 }
105
106 /*
107  * Return the next free block in the map.
108  */
109 static int get_next_free_block(struct thread_data *td, struct fio_file *f,
110                                enum fio_ddir ddir, unsigned long long *b)
111 {
112         unsigned long long min_bs = td->o.rw_min_bs;
113         int i;
114
115         i = f->last_free_lookup;
116         *b = (i * BLOCKS_PER_MAP);
117         while ((*b) * min_bs < f->real_file_size &&
118                 (*b) * min_bs < f->io_size) {
119                 if (f->file_map[i] != (unsigned int) -1) {
120                         *b += ffz(f->file_map[i]);
121                         if (*b > last_block(td, f, ddir))
122                                 break;
123                         f->last_free_lookup = i;
124                         return 0;
125                 }
126
127                 *b += BLOCKS_PER_MAP;
128                 i++;
129         }
130
131         dprint(FD_IO, "failed finding a free block\n");
132         return 1;
133 }
134
135 static int get_next_rand_offset(struct thread_data *td, struct fio_file *f,
136                                 enum fio_ddir ddir, unsigned long long *b)
137 {
138         unsigned long long r;
139         int loops = 5;
140
141         do {
142                 r = os_random_long(&td->random_state);
143                 dprint(FD_RANDOM, "off rand %llu\n", r);
144                 *b = (last_block(td, f, ddir) - 1)
145                         * (r / ((unsigned long long) OS_RAND_MAX + 1.0));
146
147                 /*
148                  * if we are not maintaining a random map, we are done.
149                  */
150                 if (!file_randommap(td, f))
151                         return 0;
152
153                 /*
154                  * calculate map offset and check if it's free
155                  */
156                 if (random_map_free(f, *b))
157                         return 0;
158
159                 dprint(FD_RANDOM, "get_next_rand_offset: offset %llu busy\n",
160                                                                         *b);
161         } while (--loops);
162
163         /*
164          * we get here, if we didn't suceed in looking up a block. generate
165          * a random start offset into the filemap, and find the first free
166          * block from there.
167          */
168         loops = 10;
169         do {
170                 f->last_free_lookup = (f->num_maps - 1) *
171                                         (r / (OS_RAND_MAX + 1.0));
172                 if (!get_next_free_block(td, f, ddir, b))
173                         return 0;
174
175                 r = os_random_long(&td->random_state);
176         } while (--loops);
177
178         /*
179          * that didn't work either, try exhaustive search from the start
180          */
181         f->last_free_lookup = 0;
182         return get_next_free_block(td, f, ddir, b);
183 }
184
185 /*
186  * For random io, generate a random new block and see if it's used. Repeat
187  * until we find a free one. For sequential io, just return the end of
188  * the last io issued.
189  */
190 static int get_next_offset(struct thread_data *td, struct io_u *io_u)
191 {
192         struct fio_file *f = io_u->file;
193         unsigned long long b;
194         enum fio_ddir ddir = io_u->ddir;
195
196         if (td_random(td) && (td->o.ddir_nr && !--td->ddir_nr)) {
197                 td->ddir_nr = td->o.ddir_nr;
198
199                 if (get_next_rand_offset(td, f, ddir, &b)) {
200                         dprint(FD_IO, "%s: getting rand offset failed\n",
201                                 f->file_name);
202                         return 1;
203                 }
204         } else {
205                 if (f->last_pos >= f->real_file_size) {
206                         if (!td_random(td) ||
207                              get_next_rand_offset(td, f, ddir, &b)) {
208                                 dprint(FD_IO, "%s: pos %llu > size %llu\n",
209                                                 f->file_name, f->last_pos,
210                                                 f->real_file_size);
211                                 return 1;
212                         }
213                 } else
214                         b = (f->last_pos - f->file_offset) / td->o.min_bs[ddir];
215         }
216
217         io_u->offset = b * td->o.ba[ddir];
218         if (io_u->offset >= f->io_size) {
219                 dprint(FD_IO, "get_next_offset: offset %llu >= io_size %llu\n",
220                                         io_u->offset, f->io_size);
221                 return 1;
222         }
223
224         io_u->offset += f->file_offset;
225         if (io_u->offset >= f->real_file_size) {
226                 dprint(FD_IO, "get_next_offset: offset %llu >= size %llu\n",
227                                         io_u->offset, f->real_file_size);
228                 return 1;
229         }
230
231         return 0;
232 }
233
234 static inline int is_power_of_2(unsigned int val)
235 {
236         return (val != 0 && ((val & (val - 1)) == 0));
237 }
238
239 static unsigned int get_next_buflen(struct thread_data *td, struct io_u *io_u)
240 {
241         const int ddir = io_u->ddir;
242         unsigned int uninitialized_var(buflen);
243         unsigned int minbs, maxbs;
244         long r;
245
246         minbs = td->o.min_bs[ddir];
247         maxbs = td->o.max_bs[ddir];
248
249         if (minbs == maxbs)
250                 buflen = minbs;
251         else {
252                 r = os_random_long(&td->bsrange_state);
253                 if (!td->o.bssplit_nr[ddir]) {
254                         buflen = 1 + (unsigned int) ((double) maxbs *
255                                         (r / (OS_RAND_MAX + 1.0)));
256                         if (buflen < minbs)
257                                 buflen = minbs;
258                 } else {
259                         long perc = 0;
260                         unsigned int i;
261
262                         for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
263                                 struct bssplit *bsp = &td->o.bssplit[ddir][i];
264
265                                 buflen = bsp->bs;
266                                 perc += bsp->perc;
267                                 if (r <= ((OS_RAND_MAX / 100L) * perc))
268                                         break;
269                         }
270                 }
271                 if (!td->o.bs_unaligned && is_power_of_2(minbs))
272                         buflen = (buflen + minbs - 1) & ~(minbs - 1);
273         }
274
275         if (io_u->offset + buflen > io_u->file->real_file_size) {
276                 dprint(FD_IO, "lower buflen %u -> %u (ddir=%d)\n", buflen,
277                                                 minbs, ddir);
278                 buflen = minbs;
279         }
280
281         return buflen;
282 }
283
284 static void set_rwmix_bytes(struct thread_data *td)
285 {
286         unsigned int diff;
287
288         /*
289          * we do time or byte based switch. this is needed because
290          * buffered writes may issue a lot quicker than they complete,
291          * whereas reads do not.
292          */
293         diff = td->o.rwmix[td->rwmix_ddir ^ 1];
294         td->rwmix_issues = (td->io_issues[td->rwmix_ddir] * diff) / 100;
295 }
296
297 static inline enum fio_ddir get_rand_ddir(struct thread_data *td)
298 {
299         unsigned int v;
300         long r;
301
302         r = os_random_long(&td->rwmix_state);
303         v = 1 + (int) (100.0 * (r / (OS_RAND_MAX + 1.0)));
304         if (v <= td->o.rwmix[DDIR_READ])
305                 return DDIR_READ;
306
307         return DDIR_WRITE;
308 }
309
310 static enum fio_ddir rate_ddir(struct thread_data *td, enum fio_ddir ddir)
311 {
312         enum fio_ddir odir = ddir ^ 1;
313         struct timeval t;
314         long usec;
315
316         if (td->rate_pending_usleep[ddir] <= 0)
317                 return ddir;
318
319         /*
320          * We have too much pending sleep in this direction. See if we
321          * should switch.
322          */
323         if (td_rw(td)) {
324                 /*
325                  * Other direction does not have too much pending, switch
326                  */
327                 if (td->rate_pending_usleep[odir] < 100000)
328                         return odir;
329
330                 /*
331                  * Both directions have pending sleep. Sleep the minimum time
332                  * and deduct from both.
333                  */
334                 if (td->rate_pending_usleep[ddir] <=
335                         td->rate_pending_usleep[odir]) {
336                         usec = td->rate_pending_usleep[ddir];
337                 } else {
338                         usec = td->rate_pending_usleep[odir];
339                         ddir = odir;
340                 }
341         } else
342                 usec = td->rate_pending_usleep[ddir];
343
344         fio_gettime(&t, NULL);
345         usec_sleep(td, usec);
346         usec = utime_since_now(&t);
347
348         td->rate_pending_usleep[ddir] -= usec;
349
350         odir = ddir ^ 1;
351         if (td_rw(td) && __should_check_rate(td, odir))
352                 td->rate_pending_usleep[odir] -= usec;
353         
354         return ddir;
355 }
356
357 /*
358  * Return the data direction for the next io_u. If the job is a
359  * mixed read/write workload, check the rwmix cycle and switch if
360  * necessary.
361  */
362 static enum fio_ddir get_rw_ddir(struct thread_data *td)
363 {
364         enum fio_ddir ddir;
365
366         if (td_rw(td)) {
367                 /*
368                  * Check if it's time to seed a new data direction.
369                  */
370                 if (td->io_issues[td->rwmix_ddir] >= td->rwmix_issues) {
371                         /*
372                          * Put a top limit on how many bytes we do for
373                          * one data direction, to avoid overflowing the
374                          * ranges too much
375                          */
376                         ddir = get_rand_ddir(td);
377
378                         if (ddir != td->rwmix_ddir)
379                                 set_rwmix_bytes(td);
380
381                         td->rwmix_ddir = ddir;
382                 }
383                 ddir = td->rwmix_ddir;
384         } else if (td_read(td))
385                 ddir = DDIR_READ;
386         else
387                 ddir = DDIR_WRITE;
388
389         td->rwmix_ddir = rate_ddir(td, ddir);
390         return td->rwmix_ddir;
391 }
392
393 static void put_file_log(struct thread_data *td, struct fio_file *f)
394 {
395         int ret = put_file(td, f);
396
397         if (ret)
398                 td_verror(td, ret, "file close");
399 }
400
401 void put_io_u(struct thread_data *td, struct io_u *io_u)
402 {
403         assert((io_u->flags & IO_U_F_FREE) == 0);
404         io_u->flags |= IO_U_F_FREE;
405
406         if (io_u->file)
407                 put_file_log(td, io_u->file);
408
409         io_u->file = NULL;
410         flist_del(&io_u->list);
411         flist_add(&io_u->list, &td->io_u_freelist);
412         td->cur_depth--;
413 }
414
415 void clear_io_u(struct thread_data *td, struct io_u *io_u)
416 {
417         io_u->flags &= ~IO_U_F_FLIGHT;
418         put_io_u(td, io_u);
419 }
420
421 void requeue_io_u(struct thread_data *td, struct io_u **io_u)
422 {
423         struct io_u *__io_u = *io_u;
424
425         dprint(FD_IO, "requeue %p\n", __io_u);
426
427         __io_u->flags |= IO_U_F_FREE;
428         if ((__io_u->flags & IO_U_F_FLIGHT) && (__io_u->ddir != DDIR_SYNC))
429                 td->io_issues[__io_u->ddir]--;
430
431         __io_u->flags &= ~IO_U_F_FLIGHT;
432
433         flist_del(&__io_u->list);
434         flist_add_tail(&__io_u->list, &td->io_u_requeues);
435         td->cur_depth--;
436         *io_u = NULL;
437 }
438
439 static int fill_io_u(struct thread_data *td, struct io_u *io_u)
440 {
441         if (td->io_ops->flags & FIO_NOIO)
442                 goto out;
443
444         /*
445          * see if it's time to sync
446          */
447         if (td->o.fsync_blocks &&
448            !(td->io_issues[DDIR_WRITE] % td->o.fsync_blocks) &&
449              td->io_issues[DDIR_WRITE] && should_fsync(td)) {
450                 io_u->ddir = DDIR_SYNC;
451                 goto out;
452         }
453
454         io_u->ddir = get_rw_ddir(td);
455
456         /*
457          * See if it's time to switch to a new zone
458          */
459         if (td->zone_bytes >= td->o.zone_size) {
460                 td->zone_bytes = 0;
461                 io_u->file->last_pos += td->o.zone_skip;
462                 td->io_skip_bytes += td->o.zone_skip;
463         }
464
465         /*
466          * No log, let the seq/rand engine retrieve the next buflen and
467          * position.
468          */
469         if (get_next_offset(td, io_u)) {
470                 dprint(FD_IO, "io_u %p, failed getting offset\n", io_u);
471                 return 1;
472         }
473
474         io_u->buflen = get_next_buflen(td, io_u);
475         if (!io_u->buflen) {
476                 dprint(FD_IO, "io_u %p, failed getting buflen\n", io_u);
477                 return 1;
478         }
479
480         if (io_u->offset + io_u->buflen > io_u->file->real_file_size) {
481                 dprint(FD_IO, "io_u %p, offset too large\n", io_u);
482                 dprint(FD_IO, "  off=%llu/%lu > %llu\n", io_u->offset,
483                                 io_u->buflen, io_u->file->real_file_size);
484                 return 1;
485         }
486
487         /*
488          * mark entry before potentially trimming io_u
489          */
490         if (td_random(td) && file_randommap(td, io_u->file))
491                 mark_random_map(td, io_u);
492
493         /*
494          * If using a write iolog, store this entry.
495          */
496 out:
497         dprint_io_u(io_u, "fill_io_u");
498         td->zone_bytes += io_u->buflen;
499         log_io_u(td, io_u);
500         return 0;
501 }
502
503 static void __io_u_mark_map(unsigned int *map, unsigned int nr)
504 {
505         int index = 0;
506
507         switch (nr) {
508         default:
509                 index = 6;
510                 break;
511         case 33 ... 64:
512                 index = 5;
513                 break;
514         case 17 ... 32:
515                 index = 4;
516                 break;
517         case 9 ... 16:
518                 index = 3;
519                 break;
520         case 5 ... 8:
521                 index = 2;
522                 break;
523         case 1 ... 4:
524                 index = 1;
525         case 0:
526                 break;
527         }
528
529         map[index]++;
530 }
531
532 void io_u_mark_submit(struct thread_data *td, unsigned int nr)
533 {
534         __io_u_mark_map(td->ts.io_u_submit, nr);
535         td->ts.total_submit++;
536 }
537
538 void io_u_mark_complete(struct thread_data *td, unsigned int nr)
539 {
540         __io_u_mark_map(td->ts.io_u_complete, nr);
541         td->ts.total_complete++;
542 }
543
544 void io_u_mark_depth(struct thread_data *td, unsigned int nr)
545 {
546         int index = 0;
547
548         switch (td->cur_depth) {
549         default:
550                 index = 6;
551                 break;
552         case 32 ... 63:
553                 index = 5;
554                 break;
555         case 16 ... 31:
556                 index = 4;
557                 break;
558         case 8 ... 15:
559                 index = 3;
560                 break;
561         case 4 ... 7:
562                 index = 2;
563                 break;
564         case 2 ... 3:
565                 index = 1;
566         case 1:
567                 break;
568         }
569
570         td->ts.io_u_map[index] += nr;
571 }
572
573 static void io_u_mark_lat_usec(struct thread_data *td, unsigned long usec)
574 {
575         int index = 0;
576
577         assert(usec < 1000);
578
579         switch (usec) {
580         case 750 ... 999:
581                 index = 9;
582                 break;
583         case 500 ... 749:
584                 index = 8;
585                 break;
586         case 250 ... 499:
587                 index = 7;
588                 break;
589         case 100 ... 249:
590                 index = 6;
591                 break;
592         case 50 ... 99:
593                 index = 5;
594                 break;
595         case 20 ... 49:
596                 index = 4;
597                 break;
598         case 10 ... 19:
599                 index = 3;
600                 break;
601         case 4 ... 9:
602                 index = 2;
603                 break;
604         case 2 ... 3:
605                 index = 1;
606         case 0 ... 1:
607                 break;
608         }
609
610         assert(index < FIO_IO_U_LAT_U_NR);
611         td->ts.io_u_lat_u[index]++;
612 }
613
614 static void io_u_mark_lat_msec(struct thread_data *td, unsigned long msec)
615 {
616         int index = 0;
617
618         switch (msec) {
619         default:
620                 index = 11;
621                 break;
622         case 1000 ... 1999:
623                 index = 10;
624                 break;
625         case 750 ... 999:
626                 index = 9;
627                 break;
628         case 500 ... 749:
629                 index = 8;
630                 break;
631         case 250 ... 499:
632                 index = 7;
633                 break;
634         case 100 ... 249:
635                 index = 6;
636                 break;
637         case 50 ... 99:
638                 index = 5;
639                 break;
640         case 20 ... 49:
641                 index = 4;
642                 break;
643         case 10 ... 19:
644                 index = 3;
645                 break;
646         case 4 ... 9:
647                 index = 2;
648                 break;
649         case 2 ... 3:
650                 index = 1;
651         case 0 ... 1:
652                 break;
653         }
654
655         assert(index < FIO_IO_U_LAT_M_NR);
656         td->ts.io_u_lat_m[index]++;
657 }
658
659 static void io_u_mark_latency(struct thread_data *td, unsigned long usec)
660 {
661         if (usec < 1000)
662                 io_u_mark_lat_usec(td, usec);
663         else
664                 io_u_mark_lat_msec(td, usec / 1000);
665 }
666
667 /*
668  * Get next file to service by choosing one at random
669  */
670 static struct fio_file *get_next_file_rand(struct thread_data *td,
671                                            enum fio_file_flags goodf,
672                                            enum fio_file_flags badf)
673 {
674         struct fio_file *f;
675         int fno;
676
677         do {
678                 long r = os_random_long(&td->next_file_state);
679                 int opened = 0;
680
681                 fno = (unsigned int) ((double) td->o.nr_files
682                         * (r / (OS_RAND_MAX + 1.0)));
683                 f = td->files[fno];
684                 if (fio_file_done(f))
685                         continue;
686
687                 if (!fio_file_open(f)) {
688                         int err;
689
690                         err = td_io_open_file(td, f);
691                         if (err)
692                                 continue;
693                         opened = 1;
694                 }
695
696                 if ((!goodf || (f->flags & goodf)) && !(f->flags & badf)) {
697                         dprint(FD_FILE, "get_next_file_rand: %p\n", f);
698                         return f;
699                 }
700                 if (opened)
701                         td_io_close_file(td, f);
702         } while (1);
703 }
704
705 /*
706  * Get next file to service by doing round robin between all available ones
707  */
708 static struct fio_file *get_next_file_rr(struct thread_data *td, int goodf,
709                                          int badf)
710 {
711         unsigned int old_next_file = td->next_file;
712         struct fio_file *f;
713
714         do {
715                 int opened = 0;
716
717                 f = td->files[td->next_file];
718
719                 td->next_file++;
720                 if (td->next_file >= td->o.nr_files)
721                         td->next_file = 0;
722
723                 dprint(FD_FILE, "trying file %s %x\n", f->file_name, f->flags);
724                 if (fio_file_done(f)) {
725                         f = NULL;
726                         continue;
727                 }
728
729                 if (!fio_file_open(f)) {
730                         int err;
731
732                         err = td_io_open_file(td, f);
733                         if (err) {
734                                 dprint(FD_FILE, "error %d on open of %s\n",
735                                         err, f->file_name);
736                                 f = NULL;
737                                 continue;
738                         }
739                         opened = 1;
740                 }
741
742                 dprint(FD_FILE, "goodf=%x, badf=%x, ff=%x\n", goodf, badf, f->flags);
743                 if ((!goodf || (f->flags & goodf)) && !(f->flags & badf))
744                         break;
745
746                 if (opened)
747                         td_io_close_file(td, f);
748
749                 f = NULL;
750         } while (td->next_file != old_next_file);
751
752         dprint(FD_FILE, "get_next_file_rr: %p\n", f);
753         return f;
754 }
755
756 static struct fio_file *get_next_file(struct thread_data *td)
757 {
758         struct fio_file *f;
759
760         assert(td->o.nr_files <= td->files_index);
761
762         if (td->nr_done_files >= td->o.nr_files) {
763                 dprint(FD_FILE, "get_next_file: nr_open=%d, nr_done=%d,"
764                                 " nr_files=%d\n", td->nr_open_files,
765                                                   td->nr_done_files,
766                                                   td->o.nr_files);
767                 return NULL;
768         }
769
770         f = td->file_service_file;
771         if (f && fio_file_open(f) && !fio_file_closing(f)) {
772                 if (td->o.file_service_type == FIO_FSERVICE_SEQ)
773                         goto out;
774                 if (td->file_service_left--)
775                         goto out;
776         }
777
778         if (td->o.file_service_type == FIO_FSERVICE_RR ||
779             td->o.file_service_type == FIO_FSERVICE_SEQ)
780                 f = get_next_file_rr(td, FIO_FILE_open, FIO_FILE_closing);
781         else
782                 f = get_next_file_rand(td, FIO_FILE_open, FIO_FILE_closing);
783
784         td->file_service_file = f;
785         td->file_service_left = td->file_service_nr - 1;
786 out:
787         dprint(FD_FILE, "get_next_file: %p [%s]\n", f, f->file_name);
788         return f;
789 }
790
791 static int set_io_u_file(struct thread_data *td, struct io_u *io_u)
792 {
793         struct fio_file *f;
794
795         do {
796                 f = get_next_file(td);
797                 if (!f)
798                         return 1;
799
800                 io_u->file = f;
801                 get_file(f);
802
803                 if (!fill_io_u(td, io_u))
804                         break;
805
806                 put_file_log(td, f);
807                 td_io_close_file(td, f);
808                 io_u->file = NULL;
809                 fio_file_set_done(f);
810                 td->nr_done_files++;
811                 dprint(FD_FILE, "%s: is done (%d of %d)\n", f->file_name, td->nr_done_files, td->o.nr_files);
812         } while (1);
813
814         return 0;
815 }
816
817
818 struct io_u *__get_io_u(struct thread_data *td)
819 {
820         struct io_u *io_u = NULL;
821
822         if (!flist_empty(&td->io_u_requeues))
823                 io_u = flist_entry(td->io_u_requeues.next, struct io_u, list);
824         else if (!queue_full(td)) {
825                 io_u = flist_entry(td->io_u_freelist.next, struct io_u, list);
826
827                 io_u->buflen = 0;
828                 io_u->resid = 0;
829                 io_u->file = NULL;
830                 io_u->end_io = NULL;
831         }
832
833         if (io_u) {
834                 assert(io_u->flags & IO_U_F_FREE);
835                 io_u->flags &= ~IO_U_F_FREE;
836
837                 io_u->error = 0;
838                 flist_del(&io_u->list);
839                 flist_add(&io_u->list, &td->io_u_busylist);
840                 td->cur_depth++;
841         }
842
843         return io_u;
844 }
845
846 /*
847  * Return an io_u to be processed. Gets a buflen and offset, sets direction,
848  * etc. The returned io_u is fully ready to be prepped and submitted.
849  */
850 struct io_u *get_io_u(struct thread_data *td)
851 {
852         struct fio_file *f;
853         struct io_u *io_u;
854
855         io_u = __get_io_u(td);
856         if (!io_u) {
857                 dprint(FD_IO, "__get_io_u failed\n");
858                 return NULL;
859         }
860
861         /*
862          * from a requeue, io_u already setup
863          */
864         if (io_u->file)
865                 goto out;
866
867         /*
868          * If using an iolog, grab next piece if any available.
869          */
870         if (td->o.read_iolog_file) {
871                 if (read_iolog_get(td, io_u))
872                         goto err_put;
873         } else if (set_io_u_file(td, io_u)) {
874                 dprint(FD_IO, "io_u %p, setting file failed\n", io_u);
875                 goto err_put;
876         }
877
878         f = io_u->file;
879         assert(fio_file_open(f));
880
881         if (io_u->ddir != DDIR_SYNC) {
882                 if (!io_u->buflen && !(td->io_ops->flags & FIO_NOIO)) {
883                         dprint(FD_IO, "get_io_u: zero buflen on %p\n", io_u);
884                         goto err_put;
885                 }
886
887                 f->last_pos = io_u->offset + io_u->buflen;
888
889                 if (td->o.verify != VERIFY_NONE && io_u->ddir == DDIR_WRITE)
890                         populate_verify_io_u(td, io_u);
891                 else if (td->o.refill_buffers && io_u->ddir == DDIR_WRITE)
892                         io_u_fill_buffer(td, io_u, io_u->xfer_buflen);
893         }
894
895         /*
896          * Set io data pointers.
897          */
898         io_u->xfer_buf = io_u->buf;
899         io_u->xfer_buflen = io_u->buflen;
900
901 out:
902         if (!td_io_prep(td, io_u)) {
903                 if (!td->o.disable_slat)
904                         fio_gettime(&io_u->start_time, NULL);
905                 return io_u;
906         }
907 err_put:
908         dprint(FD_IO, "get_io_u failed\n");
909         put_io_u(td, io_u);
910         return NULL;
911 }
912
913 void io_u_log_error(struct thread_data *td, struct io_u *io_u)
914 {
915         const char *msg[] = { "read", "write", "sync" };
916
917         log_err("fio: io_u error");
918
919         if (io_u->file)
920                 log_err(" on file %s", io_u->file->file_name);
921
922         log_err(": %s\n", strerror(io_u->error));
923
924         log_err("     %s offset=%llu, buflen=%lu\n", msg[io_u->ddir],
925                                         io_u->offset, io_u->xfer_buflen);
926
927         if (!td->error)
928                 td_verror(td, io_u->error, "io_u error");
929 }
930
931 static void io_completed(struct thread_data *td, struct io_u *io_u,
932                          struct io_completion_data *icd)
933 {
934         /*
935          * Older gcc's are too dumb to realize that usec is always used
936          * initialized, silence that warning.
937          */
938         unsigned long uninitialized_var(usec);
939
940         dprint_io_u(io_u, "io complete");
941
942         assert(io_u->flags & IO_U_F_FLIGHT);
943         io_u->flags &= ~IO_U_F_FLIGHT;
944
945         if (io_u->ddir == DDIR_SYNC) {
946                 td->last_was_sync = 1;
947                 return;
948         }
949
950         td->last_was_sync = 0;
951
952         if (!io_u->error) {
953                 unsigned int bytes = io_u->buflen - io_u->resid;
954                 const enum fio_ddir idx = io_u->ddir;
955                 int ret;
956
957                 td->io_blocks[idx]++;
958                 td->io_bytes[idx] += bytes;
959                 td->this_io_bytes[idx] += bytes;
960
961                 if (ramp_time_over(td)) {
962                         unsigned long uninitialized_var(lusec);
963                         unsigned long uninitialized_var(rusec);
964
965                         if (!td->o.disable_clat || !td->o.disable_bw)
966                                 lusec = utime_since(&io_u->issue_time,
967                                                         &icd->time);
968                         if (__should_check_rate(td, idx) ||
969                             __should_check_rate(td, idx ^ 1))
970                                 rusec = utime_since(&io_u->start_time,
971                                                         &icd->time);
972
973                         if (!td->o.disable_clat) {
974                                 add_clat_sample(td, idx, usec, bytes);
975                                 io_u_mark_latency(td, lusec);
976                         }
977                         if (!td->o.disable_bw)
978                                 add_bw_sample(td, idx, bytes, &icd->time);
979                         if (__should_check_rate(td, idx)) {
980                                 td->rate_pending_usleep[idx] +=
981                                         (long) td->rate_usec_cycle[idx] - rusec;
982                         }
983                         if (__should_check_rate(td, idx ^ 1))
984                                 td->rate_pending_usleep[idx ^ 1] -= rusec;
985                 }
986
987                 if (td_write(td) && idx == DDIR_WRITE &&
988                     td->o.do_verify &&
989                     td->o.verify != VERIFY_NONE)
990                         log_io_piece(td, io_u);
991
992                 icd->bytes_done[idx] += bytes;
993
994                 if (io_u->end_io) {
995                         ret = io_u->end_io(td, io_u);
996                         if (ret && !icd->error)
997                                 icd->error = ret;
998                 }
999         } else {
1000                 icd->error = io_u->error;
1001                 io_u_log_error(td, io_u);
1002         }
1003         if (td->o.continue_on_error && icd->error &&
1004             td_non_fatal_error(icd->error)) {
1005                 /*
1006                  * If there is a non_fatal error, then add to the error count
1007                  * and clear all the errors.
1008                  */
1009                 update_error_count(td, icd->error);
1010                 td_clear_error(td);
1011                 icd->error = 0;
1012                 io_u->error = 0;
1013         }
1014 }
1015
1016 static void init_icd(struct thread_data *td, struct io_completion_data *icd,
1017                      int nr)
1018 {
1019         if (!td->o.disable_clat || !td->o.disable_bw)
1020                 fio_gettime(&icd->time, NULL);
1021
1022         icd->nr = nr;
1023
1024         icd->error = 0;
1025         icd->bytes_done[0] = icd->bytes_done[1] = 0;
1026 }
1027
1028 static void ios_completed(struct thread_data *td,
1029                           struct io_completion_data *icd)
1030 {
1031         struct io_u *io_u;
1032         int i;
1033
1034         for (i = 0; i < icd->nr; i++) {
1035                 io_u = td->io_ops->event(td, i);
1036
1037                 io_completed(td, io_u, icd);
1038                 put_io_u(td, io_u);
1039         }
1040 }
1041
1042 /*
1043  * Complete a single io_u for the sync engines.
1044  */
1045 int io_u_sync_complete(struct thread_data *td, struct io_u *io_u,
1046                        unsigned long *bytes)
1047 {
1048         struct io_completion_data icd;
1049
1050         init_icd(td, &icd, 1);
1051         io_completed(td, io_u, &icd);
1052         put_io_u(td, io_u);
1053
1054         if (icd.error) {
1055                 td_verror(td, icd.error, "io_u_sync_complete");
1056                 return -1;
1057         }
1058
1059         if (bytes) {
1060                 bytes[0] += icd.bytes_done[0];
1061                 bytes[1] += icd.bytes_done[1];
1062         }
1063
1064         return 0;
1065 }
1066
1067 /*
1068  * Called to complete min_events number of io for the async engines.
1069  */
1070 int io_u_queued_complete(struct thread_data *td, int min_evts,
1071                          unsigned long *bytes)
1072 {
1073         struct io_completion_data icd;
1074         struct timespec *tvp = NULL;
1075         int ret;
1076         struct timespec ts = { .tv_sec = 0, .tv_nsec = 0, };
1077
1078         dprint(FD_IO, "io_u_queued_completed: min=%d\n", min_evts);
1079
1080         if (!min_evts)
1081                 tvp = &ts;
1082
1083         ret = td_io_getevents(td, min_evts, td->o.iodepth_batch_complete, tvp);
1084         if (ret < 0) {
1085                 td_verror(td, -ret, "td_io_getevents");
1086                 return ret;
1087         } else if (!ret)
1088                 return ret;
1089
1090         init_icd(td, &icd, ret);
1091         ios_completed(td, &icd);
1092         if (icd.error) {
1093                 td_verror(td, icd.error, "io_u_queued_complete");
1094                 return -1;
1095         }
1096
1097         if (bytes) {
1098                 bytes[0] += icd.bytes_done[0];
1099                 bytes[1] += icd.bytes_done[1];
1100         }
1101
1102         return 0;
1103 }
1104
1105 /*
1106  * Call when io_u is really queued, to update the submission latency.
1107  */
1108 void io_u_queued(struct thread_data *td, struct io_u *io_u)
1109 {
1110         if (!td->o.disable_slat) {
1111                 unsigned long slat_time;
1112
1113                 slat_time = utime_since(&io_u->start_time, &io_u->issue_time);
1114                 add_slat_sample(td, io_u->ddir, slat_time, io_u->xfer_buflen);
1115         }
1116 }
1117
1118 /*
1119  * "randomly" fill the buffer contents
1120  */
1121 void io_u_fill_buffer(struct thread_data *td, struct io_u *io_u,
1122                       unsigned int max_bs)
1123 {
1124         long *ptr = io_u->buf;
1125
1126         if (!td->o.zero_buffers) {
1127                 while ((void *) ptr - io_u->buf < max_bs) {
1128                         *ptr = rand() * GOLDEN_RATIO_PRIME;
1129                         ptr++;
1130                 }
1131         } else
1132                 memset(ptr, 0, max_bs);
1133 }