Update terse output
[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 "os.h"
10
11 /*
12  * Change this define to play with the timeout handling
13  */
14 #undef FIO_USE_TIMEOUT
15
16 struct io_completion_data {
17         int nr;                         /* input */
18
19         int error;                      /* output */
20         unsigned long bytes_done[2];    /* output */
21         struct timeval time;            /* output */
22 };
23
24 /*
25  * The ->file_map[] 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 thread_data *td, struct fio_file *f,
29                            unsigned long long block)
30 {
31         unsigned int idx = RAND_MAP_IDX(td, f, block);
32         unsigned int bit = RAND_MAP_BIT(td, f, block);
33
34         return (f->file_map[idx] & (1UL << bit)) == 0;
35 }
36
37 /*
38  * Mark a given offset as used in the map.
39  */
40 static void mark_random_map(struct thread_data *td, struct io_u *io_u)
41 {
42         unsigned int min_bs = td->rw_min_bs;
43         struct fio_file *f = io_u->file;
44         unsigned long long block;
45         unsigned int blocks;
46         unsigned int nr_blocks;
47
48         block = io_u->offset / (unsigned long long) min_bs;
49         blocks = 0;
50         nr_blocks = (io_u->buflen + min_bs - 1) / min_bs;
51
52         while (blocks < nr_blocks) {
53                 unsigned int idx, bit;
54
55                 if (!random_map_free(td, f, block))
56                         break;
57
58                 idx = RAND_MAP_IDX(td, f, block);
59                 bit = RAND_MAP_BIT(td, f, block);
60
61                 fio_assert(td, idx < f->num_maps);
62
63                 f->file_map[idx] |= (1UL << bit);
64                 block++;
65                 blocks++;
66         }
67
68         if ((blocks * min_bs) < io_u->buflen)
69                 io_u->buflen = blocks * min_bs;
70 }
71
72 /*
73  * Return the next free block in the map.
74  */
75 static int get_next_free_block(struct thread_data *td, struct fio_file *f,
76                                unsigned long long *b)
77 {
78         int i;
79
80         i = f->last_free_lookup;
81         *b = (i * BLOCKS_PER_MAP);
82         while ((*b) * td->rw_min_bs < f->real_file_size) {
83                 if (f->file_map[i] != -1UL) {
84                         *b += ffz(f->file_map[i]);
85                         f->last_free_lookup = i;
86                         return 0;
87                 }
88
89                 *b += BLOCKS_PER_MAP;
90                 i++;
91         }
92
93         return 1;
94 }
95
96 /*
97  * For random io, generate a random new block and see if it's used. Repeat
98  * until we find a free one. For sequential io, just return the end of
99  * the last io issued.
100  */
101 static int get_next_offset(struct thread_data *td, struct io_u *io_u)
102 {
103         struct fio_file *f = io_u->file;
104         const int ddir = io_u->ddir;
105         unsigned long long b, rb;
106         long r;
107
108         if (td_random(td)) {
109                 unsigned long long max_blocks = f->file_size / td->min_bs[ddir];
110                 int loops = 5;
111
112                 do {
113                         r = os_random_long(&td->random_state);
114                         b = ((max_blocks - 1) * r / (unsigned long long) (RAND_MAX+1.0));
115                         if (td->norandommap)
116                                 break;
117                         rb = b + (f->file_offset / td->min_bs[ddir]);
118                         loops--;
119                 } while (!random_map_free(td, f, rb) && loops);
120
121                 /*
122                  * if we failed to retrieve a truly random offset within
123                  * the loops assigned, see if there are free ones left at all
124                  */
125                 if (!loops && get_next_free_block(td, f, &b))
126                         return 1;
127         } else
128                 b = f->last_pos / td->min_bs[ddir];
129
130         io_u->offset = (b * td->min_bs[ddir]) + f->file_offset;
131         if (io_u->offset >= f->real_file_size)
132                 return 1;
133
134         return 0;
135 }
136
137 static unsigned int get_next_buflen(struct thread_data *td, struct io_u *io_u)
138 {
139         struct fio_file *f = io_u->file;
140         const int ddir = io_u->ddir;
141         unsigned int buflen;
142         long r;
143
144         if (td->min_bs[ddir] == td->max_bs[ddir])
145                 buflen = td->min_bs[ddir];
146         else {
147                 r = os_random_long(&td->bsrange_state);
148                 buflen = (unsigned int) (1 + (double) (td->max_bs[ddir] - 1) * r / (RAND_MAX + 1.0));
149                 if (!td->bs_unaligned)
150                         buflen = (buflen + td->min_bs[ddir] - 1) & ~(td->min_bs[ddir] - 1);
151         }
152
153         while (buflen + io_u->offset > f->real_file_size) {
154                 if (buflen == td->min_bs[ddir])
155                         return 0;
156
157                 buflen = td->min_bs[ddir];
158         }
159
160         return buflen;
161 }
162
163 /*
164  * Return the data direction for the next io_u. If the job is a
165  * mixed read/write workload, check the rwmix cycle and switch if
166  * necessary.
167  */
168 static enum fio_ddir get_rw_ddir(struct thread_data *td)
169 {
170         if (td_rw(td)) {
171                 struct timeval now;
172                 unsigned long elapsed;
173
174                 fio_gettime(&now, NULL);
175                 elapsed = mtime_since_now(&td->rwmix_switch);
176
177                 /*
178                  * Check if it's time to seed a new data direction.
179                  */
180                 if (elapsed >= td->rwmixcycle) {
181                         unsigned int v;
182                         long r;
183
184                         r = os_random_long(&td->rwmix_state);
185                         v = 1 + (int) (100.0 * (r / (RAND_MAX + 1.0)));
186                         if (v < td->rwmixread)
187                                 td->rwmix_ddir = DDIR_READ;
188                         else
189                                 td->rwmix_ddir = DDIR_WRITE;
190                         memcpy(&td->rwmix_switch, &now, sizeof(now));
191                 }
192                 return td->rwmix_ddir;
193         } else if (td_read(td))
194                 return DDIR_READ;
195         else
196                 return DDIR_WRITE;
197 }
198
199 void put_io_u(struct thread_data *td, struct io_u *io_u)
200 {
201         assert((io_u->flags & IO_U_F_FREE) == 0);
202         io_u->flags |= IO_U_F_FREE;
203
204         io_u->file = NULL;
205         list_del(&io_u->list);
206         list_add(&io_u->list, &td->io_u_freelist);
207         td->cur_depth--;
208 }
209
210 void requeue_io_u(struct thread_data *td, struct io_u **io_u)
211 {
212         struct io_u *__io_u = *io_u;
213
214         __io_u->flags |= IO_U_F_FREE;
215         __io_u->flags &= ~IO_U_F_FLIGHT;
216
217         list_del(&__io_u->list);
218         list_add_tail(&__io_u->list, &td->io_u_requeues);
219         td->cur_depth--;
220         *io_u = NULL;
221 }
222
223 static int fill_io_u(struct thread_data *td, struct io_u *io_u)
224 {
225         /*
226          * If using an iolog, grab next piece if any available.
227          */
228         if (td->read_iolog)
229                 return read_iolog_get(td, io_u);
230
231         /*
232          * see if it's time to sync
233          */
234         if (td->fsync_blocks && !(td->io_issues[DDIR_WRITE] % td->fsync_blocks)
235             && td->io_issues[DDIR_WRITE] && should_fsync(td)) {
236                 io_u->ddir = DDIR_SYNC;
237                 return 0;
238         }
239
240         io_u->ddir = get_rw_ddir(td);
241
242         /*
243          * No log, let the seq/rand engine retrieve the next buflen and
244          * position.
245          */
246         if (get_next_offset(td, io_u))
247                 return 1;
248
249         io_u->buflen = get_next_buflen(td, io_u);
250         if (!io_u->buflen)
251                 return 1;
252
253         /*
254          * mark entry before potentially trimming io_u
255          */
256         if (!td->read_iolog && td_random(td) && !td->norandommap)
257                 mark_random_map(td, io_u);
258
259         /*
260          * If using a write iolog, store this entry.
261          */
262         if (td->write_iolog_file)
263                 write_iolog_put(td, io_u);
264
265         return 0;
266 }
267
268 static void io_u_mark_depth(struct thread_data *td)
269 {
270         int index = 0;
271
272         switch (td->cur_depth) {
273         default:
274                 index++;
275         case 32 ... 63:
276                 index++;
277         case 16 ... 31:
278                 index++;
279         case 8 ... 15:
280                 index++;
281         case 4 ... 7:
282                 index++;
283         case 2 ... 3:
284                 index++;
285         case 1:
286                 break;
287         }
288
289         td->ts.io_u_map[index]++;
290         td->ts.total_io_u++;
291 }
292
293 static void io_u_mark_latency(struct thread_data *td, unsigned long msec)
294 {
295         int index = 0;
296
297         switch (msec) {
298         default:
299                 index++;
300         case 1000 ... 1999:
301                 index++;
302         case 750 ... 999:
303                 index++;
304         case 500 ... 749:
305                 index++;
306         case 250 ... 499:
307                 index++;
308         case 100 ... 249:
309                 index++;
310         case 50 ... 99:
311                 index++;
312         case 20 ... 49:
313                 index++;
314         case 10 ... 19:
315                 index++;
316         case 4 ... 9:
317                 index++;
318         case 2 ... 3:
319                 index++;
320         case 0 ... 1:
321                 break;
322         }
323
324         td->ts.io_u_lat[index]++;
325 }
326
327 /*
328  * Get next file to service by choosing one at random
329  */
330 static struct fio_file *get_next_file_rand(struct thread_data *td)
331 {
332         unsigned int fileno;
333         struct fio_file *f;
334
335         do {
336                 long r = os_random_long(&td->next_file_state);
337
338                 fileno = (unsigned int) ((double) (td->nr_files - 1) * r / (RAND_MAX + 1.0));
339                 f = &td->files[fileno];
340                 if (f->fd != -1)
341                         return f;
342         } while (1);
343 }
344
345 /*
346  * Get next file to service by doing round robin between all available ones
347  */
348 static struct fio_file *get_next_file_rr(struct thread_data *td)
349 {
350         unsigned int old_next_file = td->next_file;
351         struct fio_file *f;
352
353         do {
354                 f = &td->files[td->next_file];
355
356                 td->next_file++;
357                 if (td->next_file >= td->nr_files)
358                         td->next_file = 0;
359
360                 if (f->fd != -1)
361                         break;
362
363                 f = NULL;
364         } while (td->next_file != old_next_file);
365
366         return f;
367 }
368
369 static struct fio_file *get_next_file(struct thread_data *td)
370 {
371         if (!td->nr_open_files)
372                 return NULL;
373
374         if (td->file_service_type == FIO_FSERVICE_RR)
375                 return get_next_file_rr(td);
376         else
377                 return get_next_file_rand(td);
378 }
379
380 struct io_u *__get_io_u(struct thread_data *td)
381 {
382         struct io_u *io_u = NULL;
383
384         if (!list_empty(&td->io_u_requeues))
385                 io_u = list_entry(td->io_u_requeues.next, struct io_u, list);
386         else if (!queue_full(td)) {
387                 io_u = list_entry(td->io_u_freelist.next, struct io_u, list);
388
389                 io_u->buflen = 0;
390                 io_u->resid = 0;
391                 io_u->file = NULL;
392                 io_u->end_io = NULL;
393         }
394
395         if (io_u) {
396                 assert(io_u->flags & IO_U_F_FREE);
397                 io_u->flags &= ~IO_U_F_FREE;
398
399                 io_u->error = 0;
400                 list_del(&io_u->list);
401                 list_add(&io_u->list, &td->io_u_busylist);
402                 td->cur_depth++;
403                 io_u_mark_depth(td);
404         }
405
406         return io_u;
407 }
408
409 /*
410  * Return an io_u to be processed. Gets a buflen and offset, sets direction,
411  * etc. The returned io_u is fully ready to be prepped and submitted.
412  */
413 struct io_u *get_io_u(struct thread_data *td)
414 {
415         struct fio_file *f;
416         struct io_u *io_u;
417
418         io_u = __get_io_u(td);
419         if (!io_u)
420                 return NULL;
421
422         /*
423          * from a requeue, io_u already setup
424          */
425         if (io_u->file)
426                 goto out;
427
428         do {
429                 f = get_next_file(td);
430                 if (!f) {
431                         put_io_u(td, io_u);
432                         return NULL;
433                 }
434
435                 io_u->file = f;
436
437                 if (!fill_io_u(td, io_u))
438                         break;
439
440                 /*
441                  * No more to do for this file, close it
442                  */
443                 io_u->file = NULL;
444                 close_file(td, f);
445         } while (1);
446
447         if (td->zone_bytes >= td->zone_size) {
448                 td->zone_bytes = 0;
449                 f->last_pos += td->zone_skip;
450         }
451
452         if (io_u->buflen + io_u->offset > f->real_file_size) {
453                 if (td->io_ops->flags & FIO_RAWIO) {
454                         put_io_u(td, io_u);
455                         return NULL;
456                 }
457
458                 io_u->buflen = f->real_file_size - io_u->offset;
459         }
460
461         if (io_u->ddir != DDIR_SYNC) {
462                 if (!io_u->buflen) {
463                         put_io_u(td, io_u);
464                         return NULL;
465                 }
466
467                 f->last_pos = io_u->offset + io_u->buflen;
468
469                 if (td->verify != VERIFY_NONE)
470                         populate_verify_io_u(td, io_u);
471         }
472
473         /*
474          * Set io data pointers.
475          */
476 out:
477         io_u->xfer_buf = io_u->buf;
478         io_u->xfer_buflen = io_u->buflen;
479
480         if (td_io_prep(td, io_u)) {
481                 put_io_u(td, io_u);
482                 return NULL;
483         }
484
485         fio_gettime(&io_u->start_time, NULL);
486         return io_u;
487 }
488
489 void io_u_log_error(struct thread_data *td, struct io_u *io_u)
490 {
491         const char *msg[] = { "read", "write", "sync" };
492
493         log_err("fio: io_u error");
494
495         if (io_u->file)
496                 log_err(" on file %s", io_u->file->file_name);
497
498         log_err(": %s\n", strerror(io_u->error));
499
500         log_err("     %s offset=%llu, buflen=%lu\n", msg[io_u->ddir], io_u->offset, io_u->xfer_buflen);
501
502         if (!td->error)
503                 td_verror(td, io_u->error, "io_u error");
504 }
505
506 static void io_completed(struct thread_data *td, struct io_u *io_u,
507                          struct io_completion_data *icd)
508 {
509         unsigned long msec;
510
511         assert(io_u->flags & IO_U_F_FLIGHT);
512         io_u->flags &= ~IO_U_F_FLIGHT;
513
514         if (io_u->ddir == DDIR_SYNC) {
515                 td->last_was_sync = 1;
516                 return;
517         }
518
519         td->last_was_sync = 0;
520
521         if (!io_u->error) {
522                 unsigned int bytes = io_u->buflen - io_u->resid;
523                 const enum fio_ddir idx = io_u->ddir;
524                 int ret;
525
526                 td->io_blocks[idx]++;
527                 td->io_bytes[idx] += bytes;
528                 td->zone_bytes += bytes;
529                 td->this_io_bytes[idx] += bytes;
530
531                 io_u->file->last_completed_pos = io_u->offset + io_u->buflen;
532
533                 msec = mtime_since(&io_u->issue_time, &icd->time);
534
535                 add_clat_sample(td, idx, msec);
536                 add_bw_sample(td, idx, &icd->time);
537                 io_u_mark_latency(td, msec);
538
539                 if ((td_rw(td) || td_write(td)) && idx == DDIR_WRITE)
540                         log_io_piece(td, io_u);
541
542                 icd->bytes_done[idx] += bytes;
543
544                 if (io_u->end_io) {
545                         ret = io_u->end_io(io_u);
546                         if (ret && !icd->error)
547                                 icd->error = ret;
548                 }
549         } else {
550                 icd->error = io_u->error;
551                 io_u_log_error(td, io_u);
552         }
553 }
554
555 static void init_icd(struct io_completion_data *icd, int nr)
556 {
557         fio_gettime(&icd->time, NULL);
558
559         icd->nr = nr;
560
561         icd->error = 0;
562         icd->bytes_done[0] = icd->bytes_done[1] = 0;
563 }
564
565 static void ios_completed(struct thread_data *td,
566                           struct io_completion_data *icd)
567 {
568         struct io_u *io_u;
569         int i;
570
571         for (i = 0; i < icd->nr; i++) {
572                 io_u = td->io_ops->event(td, i);
573
574                 io_completed(td, io_u, icd);
575                 put_io_u(td, io_u);
576         }
577 }
578
579 /*
580  * Complete a single io_u for the sync engines.
581  */
582 long io_u_sync_complete(struct thread_data *td, struct io_u *io_u)
583 {
584         struct io_completion_data icd;
585
586         init_icd(&icd, 1);
587         io_completed(td, io_u, &icd);
588         put_io_u(td, io_u);
589
590         if (!icd.error)
591                 return icd.bytes_done[0] + icd.bytes_done[1];
592
593         td_verror(td, icd.error, "io_u_sync_complete");
594         return -1;
595 }
596
597 /*
598  * Called to complete min_events number of io for the async engines.
599  */
600 long io_u_queued_complete(struct thread_data *td, int min_events)
601 {
602         struct io_completion_data icd;
603         struct timespec *tvp = NULL;
604         int ret;
605
606         if (!min_events) {
607                 struct timespec ts = { .tv_sec = 0, .tv_nsec = 0, };
608
609                 tvp = &ts;
610         }
611
612         ret = td_io_getevents(td, min_events, td->cur_depth, tvp);
613         if (ret < 0) {
614                 td_verror(td, -ret, "td_io_getevents");
615                 return ret;
616         } else if (!ret)
617                 return ret;
618
619         init_icd(&icd, ret);
620         ios_completed(td, &icd);
621         if (!icd.error)
622                 return icd.bytes_done[0] + icd.bytes_done[1];
623
624         td_verror(td, icd.error, "io_u_queued_complete");
625         return -1;
626 }
627
628 /*
629  * Call when io_u is really queued, to update the submission latency.
630  */
631 void io_u_queued(struct thread_data *td, struct io_u *io_u)
632 {
633         unsigned long slat_time;
634
635         slat_time = mtime_since(&io_u->start_time, &io_u->issue_time);
636         add_slat_sample(td, io_u->ddir, slat_time);
637 }
638
639 #ifdef FIO_USE_TIMEOUT
640 void io_u_set_timeout(struct thread_data *td)
641 {
642         assert(td->cur_depth);
643
644         td->timer.it_interval.tv_sec = 0;
645         td->timer.it_interval.tv_usec = 0;
646         td->timer.it_value.tv_sec = IO_U_TIMEOUT + IO_U_TIMEOUT_INC;
647         td->timer.it_value.tv_usec = 0;
648         setitimer(ITIMER_REAL, &td->timer, NULL);
649         fio_gettime(&td->timeout_end, NULL);
650 }
651
652 static void io_u_dump(struct io_u *io_u)
653 {
654         unsigned long t_start = mtime_since_now(&io_u->start_time);
655         unsigned long t_issue = mtime_since_now(&io_u->issue_time);
656
657         log_err("io_u=%p, t_start=%lu, t_issue=%lu\n", io_u, t_start, t_issue);
658         log_err("  buf=%p/%p, len=%lu/%lu, offset=%llu\n", io_u->buf, io_u->xfer_buf, io_u->buflen, io_u->xfer_buflen, io_u->offset);
659         log_err("  ddir=%d, fname=%s\n", io_u->ddir, io_u->file->file_name);
660 }
661 #else
662 void io_u_set_timeout(struct thread_data fio_unused *td)
663 {
664 }
665 #endif
666
667 #ifdef FIO_USE_TIMEOUT
668 static void io_u_timeout_handler(int fio_unused sig)
669 {
670         struct thread_data *td, *__td;
671         pid_t pid = getpid();
672         struct list_head *entry;
673         struct io_u *io_u;
674         int i;
675
676         log_err("fio: io_u timeout\n");
677
678         /*
679          * TLS would be nice...
680          */
681         td = NULL;
682         for_each_td(__td, i) {
683                 if (__td->pid == pid) {
684                         td = __td;
685                         break;
686                 }
687         }
688
689         if (!td) {
690                 log_err("fio: io_u timeout, can't find job\n");
691                 exit(1);
692         }
693
694         if (!td->cur_depth) {
695                 log_err("fio: timeout without pending work?\n");
696                 return;
697         }
698
699         log_err("fio: io_u timeout: job=%s, pid=%d\n", td->name, td->pid);
700
701         list_for_each(entry, &td->io_u_busylist) {
702                 io_u = list_entry(entry, struct io_u, list);
703
704                 io_u_dump(io_u);
705         }
706
707         td_verror(td, ETIMEDOUT, "io_u timeout");
708         exit(1);
709 }
710 #endif
711
712 void io_u_init_timeout(void)
713 {
714 #ifdef FIO_USE_TIMEOUT
715         signal(SIGALRM, io_u_timeout_handler);
716 #endif
717 }