12 * Change this define to play with the timeout handling
14 #undef FIO_USE_TIMEOUT
16 struct io_completion_data {
19 int error; /* output */
20 unsigned long bytes_done[2]; /* output */
21 struct timeval time; /* output */
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.
28 static int random_map_free(struct thread_data *td, struct fio_file *f,
29 unsigned long long block)
31 unsigned int idx = RAND_MAP_IDX(td, f, block);
32 unsigned int bit = RAND_MAP_BIT(td, f, block);
34 return (f->file_map[idx] & (1UL << bit)) == 0;
38 * Mark a given offset as used in the map.
40 static void mark_random_map(struct thread_data *td, struct io_u *io_u)
42 unsigned int min_bs = td->o.rw_min_bs;
43 struct fio_file *f = io_u->file;
44 unsigned long long block;
46 unsigned int nr_blocks;
48 block = io_u->offset / (unsigned long long) min_bs;
50 nr_blocks = (io_u->buflen + min_bs - 1) / min_bs;
52 while (blocks < nr_blocks) {
53 unsigned int idx, bit;
56 * If we have a mixed random workload, we may
57 * encounter blocks we already did IO to.
59 if (!td->o.ddir_nr && !random_map_free(td, f, block))
62 idx = RAND_MAP_IDX(td, f, block);
63 bit = RAND_MAP_BIT(td, f, block);
65 fio_assert(td, idx < f->num_maps);
67 f->file_map[idx] |= (1UL << bit);
72 if ((blocks * min_bs) < io_u->buflen)
73 io_u->buflen = blocks * min_bs;
77 * Return the next free block in the map.
79 static int get_next_free_block(struct thread_data *td, struct fio_file *f,
80 unsigned long long *b)
84 i = f->last_free_lookup;
85 *b = (i * BLOCKS_PER_MAP);
86 while ((*b) * td->o.rw_min_bs < f->real_file_size) {
87 if (f->file_map[i] != -1UL) {
88 *b += ffz(f->file_map[i]);
89 f->last_free_lookup = i;
101 * For random io, generate a random new block and see if it's used. Repeat
102 * until we find a free one. For sequential io, just return the end of
103 * the last io issued.
105 static int get_next_offset(struct thread_data *td, struct io_u *io_u)
107 struct fio_file *f = io_u->file;
108 const int ddir = io_u->ddir;
109 unsigned long long b, rb;
113 unsigned long long max_blocks = f->file_size / td->o.min_bs[ddir];
118 td->ddir_nr = td->o.ddir_nr;
120 b = f->last_pos / td->o.min_bs[ddir];
126 r = os_random_long(&td->random_state);
130 b = ((max_blocks - 1) * r / (unsigned long long) (RAND_MAX+1.0));
131 if (td->o.norandommap)
133 rb = b + (f->file_offset / td->o.min_bs[ddir]);
135 } while (!random_map_free(td, f, rb) && loops);
138 * if we failed to retrieve a truly random offset within
139 * the loops assigned, see if there are free ones left at all
141 if (!loops && get_next_free_block(td, f, &b))
144 b = f->last_pos / td->o.min_bs[ddir];
147 io_u->offset = (b * td->o.min_bs[ddir]) + f->file_offset;
148 if (io_u->offset >= f->real_file_size)
154 static unsigned int get_next_buflen(struct thread_data *td, struct io_u *io_u)
156 struct fio_file *f = io_u->file;
157 const int ddir = io_u->ddir;
161 if (td->o.min_bs[ddir] == td->o.max_bs[ddir])
162 buflen = td->o.min_bs[ddir];
164 r = os_random_long(&td->bsrange_state);
165 buflen = (unsigned int) (1 + (double) (td->o.max_bs[ddir] - 1) * r / (RAND_MAX + 1.0));
166 if (!td->o.bs_unaligned)
167 buflen = (buflen + td->o.min_bs[ddir] - 1) & ~(td->o.min_bs[ddir] - 1);
170 while (buflen + io_u->offset > f->real_file_size) {
171 if (buflen == td->o.min_bs[ddir]) {
172 if (!td->o.odirect) {
173 assert(io_u->offset <= f->real_file_size);
174 buflen = f->real_file_size - io_u->offset;
180 buflen = td->o.min_bs[ddir];
186 static void set_rwmix_bytes(struct thread_data *td)
188 unsigned long long rbytes;
192 * we do time or byte based switch. this is needed because
193 * buffered writes may issue a lot quicker than they complete,
194 * whereas reads do not.
196 rbytes = td->io_bytes[td->rwmix_ddir] - td->rwmix_bytes;
197 diff = td->o.rwmix[td->rwmix_ddir ^ 1];
199 td->rwmix_bytes = td->io_bytes[td->rwmix_ddir] + (rbytes * ((100 - diff)) / diff);
202 static inline enum fio_ddir get_rand_ddir(struct thread_data *td)
207 r = os_random_long(&td->rwmix_state);
208 v = 1 + (int) (100.0 * (r / (RAND_MAX + 1.0)));
209 if (v < td->o.rwmix[DDIR_READ])
216 * Return the data direction for the next io_u. If the job is a
217 * mixed read/write workload, check the rwmix cycle and switch if
220 static enum fio_ddir get_rw_ddir(struct thread_data *td)
224 unsigned long elapsed;
227 fio_gettime(&now, NULL);
228 elapsed = mtime_since_now(&td->rwmix_switch);
231 * if this is the first cycle, make it shorter
233 cycle = td->o.rwmixcycle;
234 if (!td->rwmix_bytes)
238 * Check if it's time to seed a new data direction.
240 if (elapsed >= cycle ||
241 td->io_bytes[td->rwmix_ddir] >= td->rwmix_bytes) {
242 unsigned long long max_bytes;
246 * Put a top limit on how many bytes we do for
247 * one data direction, to avoid overflowing the
250 ddir = get_rand_ddir(td);
251 max_bytes = td->this_io_bytes[ddir];
252 if (max_bytes >= (td->io_size * td->o.rwmix[ddir] / 100)) {
253 if (!td->rw_end_set[ddir]) {
254 td->rw_end_set[ddir] = 1;
255 memcpy(&td->rw_end[ddir], &now, sizeof(now));
260 if (ddir != td->rwmix_ddir)
263 td->rwmix_ddir = ddir;
264 memcpy(&td->rwmix_switch, &now, sizeof(now));
266 return td->rwmix_ddir;
267 } else if (td_read(td))
273 void put_io_u(struct thread_data *td, struct io_u *io_u)
275 assert((io_u->flags & IO_U_F_FREE) == 0);
276 io_u->flags |= IO_U_F_FREE;
279 list_del(&io_u->list);
280 list_add(&io_u->list, &td->io_u_freelist);
284 void requeue_io_u(struct thread_data *td, struct io_u **io_u)
286 struct io_u *__io_u = *io_u;
288 __io_u->flags |= IO_U_F_FREE;
289 __io_u->flags &= ~IO_U_F_FLIGHT;
291 list_del(&__io_u->list);
292 list_add_tail(&__io_u->list, &td->io_u_requeues);
297 static int fill_io_u(struct thread_data *td, struct io_u *io_u)
300 * If using an iolog, grab next piece if any available.
302 if (td->o.read_iolog)
303 return read_iolog_get(td, io_u);
306 * see if it's time to sync
308 if (td->o.fsync_blocks &&
309 !(td->io_issues[DDIR_WRITE] % td->o.fsync_blocks) &&
310 td->io_issues[DDIR_WRITE] && should_fsync(td)) {
311 io_u->ddir = DDIR_SYNC;
315 io_u->ddir = get_rw_ddir(td);
318 * No log, let the seq/rand engine retrieve the next buflen and
321 if (get_next_offset(td, io_u))
324 io_u->buflen = get_next_buflen(td, io_u);
329 * mark entry before potentially trimming io_u
331 if (!td->o.read_iolog && td_random(td) && !td->o.norandommap)
332 mark_random_map(td, io_u);
335 * If using a write iolog, store this entry.
337 if (td->o.write_iolog_file)
338 write_iolog_put(td, io_u);
343 void io_u_mark_depth(struct thread_data *td, struct io_u *io_u)
347 if (io_u->ddir == DDIR_SYNC)
350 switch (td->cur_depth) {
367 td->ts.io_u_map[index]++;
368 td->ts.total_io_u[io_u->ddir]++;
371 static void io_u_mark_latency(struct thread_data *td, unsigned long msec)
402 td->ts.io_u_lat[index]++;
406 * Get next file to service by choosing one at random
408 static struct fio_file *get_next_file_rand(struct thread_data *td, int goodf,
415 long r = os_random_long(&td->next_file_state);
417 fno = (unsigned int) ((double) td->o.nr_files * (r / (RAND_MAX + 1.0)));
420 if ((!goodf || (f->flags & goodf)) && !(f->flags & badf))
426 * Get next file to service by doing round robin between all available ones
428 static struct fio_file *get_next_file_rr(struct thread_data *td, int goodf,
431 unsigned int old_next_file = td->next_file;
435 f = &td->files[td->next_file];
438 if (td->next_file >= td->o.nr_files)
441 if ((!goodf || (f->flags & goodf)) && !(f->flags & badf))
445 } while (td->next_file != old_next_file);
450 static struct fio_file *get_next_file(struct thread_data *td)
454 assert(td->o.nr_files <= td->files_index);
456 if (!td->nr_open_files)
459 f = td->file_service_file;
460 if (f && (f->flags & FIO_FILE_OPEN) && td->file_service_left--)
463 if (td->o.file_service_type == FIO_FSERVICE_RR)
464 f = get_next_file_rr(td, FIO_FILE_OPEN, FIO_FILE_CLOSING);
466 f = get_next_file_rand(td, FIO_FILE_OPEN, FIO_FILE_CLOSING);
468 td->file_service_file = f;
469 td->file_service_left = td->file_service_nr - 1;
473 static struct fio_file *find_next_new_file(struct thread_data *td)
477 if (td->o.file_service_type == FIO_FSERVICE_RR)
478 f = get_next_file_rr(td, 0, FIO_FILE_OPEN);
480 f = get_next_file_rand(td, 0, FIO_FILE_OPEN);
485 struct io_u *__get_io_u(struct thread_data *td)
487 struct io_u *io_u = NULL;
489 if (!list_empty(&td->io_u_requeues))
490 io_u = list_entry(td->io_u_requeues.next, struct io_u, list);
491 else if (!queue_full(td)) {
492 io_u = list_entry(td->io_u_freelist.next, struct io_u, list);
501 assert(io_u->flags & IO_U_F_FREE);
502 io_u->flags &= ~IO_U_F_FREE;
505 list_del(&io_u->list);
506 list_add(&io_u->list, &td->io_u_busylist);
514 * Return an io_u to be processed. Gets a buflen and offset, sets direction,
515 * etc. The returned io_u is fully ready to be prepped and submitted.
517 struct io_u *get_io_u(struct thread_data *td)
523 io_u = __get_io_u(td);
528 * from a requeue, io_u already setup
534 f = get_next_file(td);
543 if (!fill_io_u(td, io_u))
547 * No more to do for this file, close it
550 td_io_close_file(td, f);
553 * probably not the right place to do this, but see
554 * if we need to open a new file
556 if (td->nr_open_files < td->o.open_files &&
557 td->o.open_files != td->o.nr_files) {
558 f = find_next_new_file(td);
560 if (!f || (ret = td_io_open_file(td, f))) {
568 if (td->zone_bytes >= td->o.zone_size) {
570 f->last_pos += td->o.zone_skip;
573 if (io_u->buflen + io_u->offset > f->real_file_size) {
574 if (td->io_ops->flags & FIO_RAWIO) {
579 io_u->buflen = f->real_file_size - io_u->offset;
582 if (io_u->ddir != DDIR_SYNC) {
588 f->last_pos = io_u->offset + io_u->buflen;
590 if (td->o.verify != VERIFY_NONE)
591 populate_verify_io_u(td, io_u);
595 * Set io data pointers.
598 io_u->xfer_buf = io_u->buf;
599 io_u->xfer_buflen = io_u->buflen;
601 if (td_io_prep(td, io_u)) {
606 fio_gettime(&io_u->start_time, NULL);
610 void io_u_log_error(struct thread_data *td, struct io_u *io_u)
612 const char *msg[] = { "read", "write", "sync" };
614 log_err("fio: io_u error");
617 log_err(" on file %s", io_u->file->file_name);
619 log_err(": %s\n", strerror(io_u->error));
621 log_err(" %s offset=%llu, buflen=%lu\n", msg[io_u->ddir], io_u->offset, io_u->xfer_buflen);
624 td_verror(td, io_u->error, "io_u error");
627 static void io_completed(struct thread_data *td, struct io_u *io_u,
628 struct io_completion_data *icd)
632 assert(io_u->flags & IO_U_F_FLIGHT);
633 io_u->flags &= ~IO_U_F_FLIGHT;
635 put_file(td, io_u->file);
637 if (io_u->ddir == DDIR_SYNC) {
638 td->last_was_sync = 1;
642 td->last_was_sync = 0;
645 unsigned int bytes = io_u->buflen - io_u->resid;
646 const enum fio_ddir idx = io_u->ddir;
649 td->io_blocks[idx]++;
650 td->io_bytes[idx] += bytes;
651 td->zone_bytes += bytes;
652 td->this_io_bytes[idx] += bytes;
654 io_u->file->last_completed_pos = io_u->offset + io_u->buflen;
656 msec = mtime_since(&io_u->issue_time, &icd->time);
658 add_clat_sample(td, idx, msec);
659 add_bw_sample(td, idx, &icd->time);
660 io_u_mark_latency(td, msec);
662 if ((td_rw(td) || td_write(td)) && idx == DDIR_WRITE)
663 log_io_piece(td, io_u);
665 icd->bytes_done[idx] += bytes;
668 ret = io_u->end_io(io_u);
669 if (ret && !icd->error)
673 icd->error = io_u->error;
674 io_u_log_error(td, io_u);
678 static void init_icd(struct io_completion_data *icd, int nr)
680 fio_gettime(&icd->time, NULL);
685 icd->bytes_done[0] = icd->bytes_done[1] = 0;
688 static void ios_completed(struct thread_data *td,
689 struct io_completion_data *icd)
694 for (i = 0; i < icd->nr; i++) {
695 io_u = td->io_ops->event(td, i);
697 io_completed(td, io_u, icd);
703 * Complete a single io_u for the sync engines.
705 long io_u_sync_complete(struct thread_data *td, struct io_u *io_u)
707 struct io_completion_data icd;
710 io_completed(td, io_u, &icd);
714 return icd.bytes_done[0] + icd.bytes_done[1];
716 td_verror(td, icd.error, "io_u_sync_complete");
721 * Called to complete min_events number of io for the async engines.
723 long io_u_queued_complete(struct thread_data *td, int min_events)
725 struct io_completion_data icd;
726 struct timespec *tvp = NULL;
728 struct timespec ts = { .tv_sec = 0, .tv_nsec = 0, };
733 ret = td_io_getevents(td, min_events, td->cur_depth, tvp);
735 td_verror(td, -ret, "td_io_getevents");
741 ios_completed(td, &icd);
743 return icd.bytes_done[0] + icd.bytes_done[1];
745 td_verror(td, icd.error, "io_u_queued_complete");
750 * Call when io_u is really queued, to update the submission latency.
752 void io_u_queued(struct thread_data *td, struct io_u *io_u)
754 unsigned long slat_time;
756 slat_time = mtime_since(&io_u->start_time, &io_u->issue_time);
757 add_slat_sample(td, io_u->ddir, slat_time);
760 #ifdef FIO_USE_TIMEOUT
761 void io_u_set_timeout(struct thread_data *td)
763 assert(td->cur_depth);
765 td->timer.it_interval.tv_sec = 0;
766 td->timer.it_interval.tv_usec = 0;
767 td->timer.it_value.tv_sec = IO_U_TIMEOUT + IO_U_TIMEOUT_INC;
768 td->timer.it_value.tv_usec = 0;
769 setitimer(ITIMER_REAL, &td->timer, NULL);
770 fio_gettime(&td->timeout_end, NULL);
773 static void io_u_dump(struct io_u *io_u)
775 unsigned long t_start = mtime_since_now(&io_u->start_time);
776 unsigned long t_issue = mtime_since_now(&io_u->issue_time);
778 log_err("io_u=%p, t_start=%lu, t_issue=%lu\n", io_u, t_start, t_issue);
779 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);
780 log_err(" ddir=%d, fname=%s\n", io_u->ddir, io_u->file->file_name);
783 void io_u_set_timeout(struct thread_data fio_unused *td)
788 #ifdef FIO_USE_TIMEOUT
789 static void io_u_timeout_handler(int fio_unused sig)
791 struct thread_data *td, *__td;
792 pid_t pid = getpid();
793 struct list_head *entry;
797 log_err("fio: io_u timeout\n");
800 * TLS would be nice...
803 for_each_td(__td, i) {
804 if (__td->pid == pid) {
811 log_err("fio: io_u timeout, can't find job\n");
815 if (!td->cur_depth) {
816 log_err("fio: timeout without pending work?\n");
820 log_err("fio: io_u timeout: job=%s, pid=%d\n", td->o.name, td->pid);
822 list_for_each(entry, &td->io_u_busylist) {
823 io_u = list_entry(entry, struct io_u, list);
828 td_verror(td, ETIMEDOUT, "io_u timeout");
833 void io_u_init_timeout(void)
835 #ifdef FIO_USE_TIMEOUT
836 signal(SIGALRM, io_u_timeout_handler);