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