2 * fio - the flexible io tester
4 * Copyright (C) 2005 Jens Axboe <axboe@suse.de>
5 * Copyright (C) 2006 Jens Axboe <axboe@kernel.dk>
7 * The license below covers all files distributed with fio unless otherwise
8 * noted in the file itself.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
39 unsigned long page_mask;
40 unsigned long page_size;
42 (char *) (((unsigned long) (buf) + page_mask) & ~page_mask)
45 int thread_number = 0;
51 static struct fio_sem *startup_sem;
52 static volatile int fio_abort;
53 static int exit_value;
55 struct io_log *agg_io_log[2];
57 #define TERMINATE_ALL (-1)
58 #define JOB_START_TIMEOUT (5 * 1000)
60 static inline void td_set_runstate(struct thread_data *td, int runstate)
62 td->runstate = runstate;
65 static void terminate_threads(int group_id)
67 struct thread_data *td;
71 if (group_id == TERMINATE_ALL || groupid == td->groupid) {
73 * if the thread is running, just let it exit
75 if (td->runstate < TD_RUNNING)
76 kill(td->pid, SIGQUIT);
78 td->o.start_delay = 0;
83 static void sig_handler(int sig)
88 disk_util_timer_arm();
89 print_thread_status();
92 printf("\nfio: terminating on signal %d\n", sig);
94 terminate_threads(TERMINATE_ALL);
100 * Check if we are above the minimum rate given.
102 static int check_min_rate(struct thread_data *td, struct timeval *now)
104 unsigned long long bytes = 0;
105 unsigned long iops = 0;
110 * No minimum rate set, always ok
112 if (!td->o.ratemin && !td->o.rate_iops_min)
116 * allow a 2 second settle period in the beginning
118 if (mtime_since(&td->start, now) < 2000)
122 iops += td->io_blocks[DDIR_READ];
123 bytes += td->this_io_bytes[DDIR_READ];
126 iops += td->io_blocks[DDIR_WRITE];
127 bytes += td->this_io_bytes[DDIR_WRITE];
131 * if rate blocks is set, sample is running
133 if (td->rate_bytes || td->rate_blocks) {
134 spent = mtime_since(&td->lastrate, now);
135 if (spent < td->o.ratecycle)
140 * check bandwidth specified rate
142 if (bytes < td->rate_bytes) {
143 log_err("%s: min rate %u not met\n", td->o.name, td->o.ratemin);
146 rate = (bytes - td->rate_bytes) / spent;
147 if (rate < td->o.ratemin || bytes < td->rate_bytes) {
148 log_err("%s: min rate %u not met, got %luKiB/sec\n", td->o.name, td->o.ratemin, rate);
154 * checks iops specified rate
156 if (iops < td->o.rate_iops) {
157 log_err("%s: min iops rate %u not met\n", td->o.name, td->o.rate_iops);
160 rate = (iops - td->rate_blocks) / spent;
161 if (rate < td->o.rate_iops_min || iops < td->rate_blocks) {
162 log_err("%s: min iops rate %u not met, got %lu\n", td->o.name, td->o.rate_iops_min, rate);
168 td->rate_bytes = bytes;
169 td->rate_blocks = iops;
170 memcpy(&td->lastrate, now, sizeof(*now));
174 static inline int runtime_exceeded(struct thread_data *td, struct timeval *t)
178 if (mtime_since(&td->epoch, t) >= td->o.timeout * 1000)
185 * When job exits, we can cancel the in-flight IO if we are using async
186 * io. Attempt to do so.
188 static void cleanup_pending_aio(struct thread_data *td)
190 struct list_head *entry, *n;
195 * get immediately available events, if any
197 r = io_u_queued_complete(td, 0);
202 * now cancel remaining active events
204 if (td->io_ops->cancel) {
205 list_for_each_safe(entry, n, &td->io_u_busylist) {
206 io_u = list_entry(entry, struct io_u, list);
209 * if the io_u isn't in flight, then that generally
210 * means someone leaked an io_u. complain but fix
211 * it up, so we don't stall here.
213 if ((io_u->flags & IO_U_F_FLIGHT) == 0) {
214 log_err("fio: non-busy IO on busy list\n");
217 r = td->io_ops->cancel(td, io_u);
225 r = io_u_queued_complete(td, td->cur_depth);
229 * Helper to handle the final sync of a file. Works just like the normal
230 * io path, just does everything sync.
232 static int fio_io_sync(struct thread_data *td, struct fio_file *f)
234 struct io_u *io_u = __get_io_u(td);
240 io_u->ddir = DDIR_SYNC;
243 if (td_io_prep(td, io_u)) {
249 ret = td_io_queue(td, io_u);
251 td_verror(td, io_u->error, "td_io_queue");
254 } else if (ret == FIO_Q_QUEUED) {
255 if (io_u_queued_complete(td, 1) < 0)
257 } else if (ret == FIO_Q_COMPLETED) {
259 td_verror(td, io_u->error, "td_io_queue");
263 if (io_u_sync_complete(td, io_u) < 0)
265 } else if (ret == FIO_Q_BUSY) {
266 if (td_io_commit(td))
275 * The main verify engine. Runs over the writes we previously submitted,
276 * reads the blocks back in, and checks the crc/md5 of the data.
278 static void do_verify(struct thread_data *td)
286 * sync io first and invalidate cache, to make sure we really
289 for_each_file(td, f, i) {
290 if (!(f->flags & FIO_FILE_OPEN))
292 if (fio_io_sync(td, f))
294 if (file_invalidate_cache(td, f))
301 td_set_runstate(td, TD_VERIFYING);
304 while (!td->terminate) {
307 io_u = __get_io_u(td);
311 if (runtime_exceeded(td, &io_u->start_time)) {
316 if (get_next_verify(td, io_u)) {
321 if (td_io_prep(td, io_u)) {
326 io_u->end_io = verify_io_u;
328 ret = td_io_queue(td, io_u);
330 case FIO_Q_COMPLETED:
333 else if (io_u->resid) {
334 int bytes = io_u->xfer_buflen - io_u->resid;
340 td_verror(td, ENODATA, "full resid");
345 io_u->xfer_buflen = io_u->resid;
346 io_u->xfer_buf += bytes;
347 io_u->offset += bytes;
349 if (io_u->offset == io_u->file->real_file_size)
352 requeue_io_u(td, &io_u);
355 ret = io_u_sync_complete(td, io_u);
363 requeue_io_u(td, &io_u);
364 ret2 = td_io_commit(td);
370 td_verror(td, -ret, "td_io_queue");
374 if (ret < 0 || td->error)
378 * if we can queue more, do so. but check if there are
379 * completed io_u's first.
382 if (queue_full(td) || ret == FIO_Q_BUSY) {
385 if (td->cur_depth > td->o.iodepth_low)
386 min_events = td->cur_depth - td->o.iodepth_low;
390 * Reap required number of io units, if any, and do the
391 * verification on them through the callback handler
393 if (io_u_queued_complete(td, min_events) < 0)
398 min_events = td->cur_depth;
401 ret = io_u_queued_complete(td, min_events);
403 cleanup_pending_aio(td);
405 td_set_runstate(td, TD_RUNNING);
409 * Main IO worker function. It retrieves io_u's to process and queues
410 * and reaps them, checking for rate and errors along the way.
412 static void do_io(struct thread_data *td)
419 td_set_runstate(td, TD_RUNNING);
421 while ((td->this_io_bytes[0] + td->this_io_bytes[1]) < td->o.size) {
422 struct timeval comp_time;
435 memcpy(&s, &io_u->start_time, sizeof(s));
437 if (runtime_exceeded(td, &s)) {
442 ret = td_io_queue(td, io_u);
444 case FIO_Q_COMPLETED:
447 else if (io_u->resid) {
448 int bytes = io_u->xfer_buflen - io_u->resid;
454 td_verror(td, ENODATA, "full resid");
459 io_u->xfer_buflen = io_u->resid;
460 io_u->xfer_buf += bytes;
461 io_u->offset += bytes;
463 if (io_u->offset == io_u->file->real_file_size)
466 requeue_io_u(td, &io_u);
469 fio_gettime(&comp_time, NULL);
470 bytes_done = io_u_sync_complete(td, io_u);
477 * if the engine doesn't have a commit hook,
478 * the io_u is really queued. if it does have such
479 * a hook, it has to call io_u_queued() itself.
481 if (td->io_ops->commit == NULL)
482 io_u_queued(td, io_u);
485 requeue_io_u(td, &io_u);
486 ret2 = td_io_commit(td);
496 if (ret < 0 || td->error)
500 * See if we need to complete some commands
502 if (ret == FIO_Q_QUEUED || ret == FIO_Q_BUSY) {
504 if (queue_full(td) || ret == FIO_Q_BUSY) {
507 if (td->cur_depth > td->o.iodepth_low)
508 min_evts = td->cur_depth - td->o.iodepth_low;
511 fio_gettime(&comp_time, NULL);
512 bytes_done = io_u_queued_complete(td, min_evts);
521 * the rate is batched for now, it should work for batches
522 * of completions except the very first one which may look
525 usec = utime_since(&s, &comp_time);
527 rate_throttle(td, usec, bytes_done);
529 if (check_min_rate(td, &comp_time)) {
530 if (exitall_on_terminate)
531 terminate_threads(td->groupid);
532 td_verror(td, ENODATA, "check_min_rate");
536 if (td->o.thinktime) {
537 unsigned long long b;
539 b = td->io_blocks[0] + td->io_blocks[1];
540 if (!(b % td->o.thinktime_blocks)) {
543 if (td->o.thinktime_spin)
544 __usec_sleep(td->o.thinktime_spin);
546 left = td->o.thinktime - td->o.thinktime_spin;
548 usec_sleep(td, left);
558 ret = io_u_queued_complete(td, i);
560 if (should_fsync(td) && td->o.end_fsync) {
561 td_set_runstate(td, TD_FSYNCING);
563 for_each_file(td, f, i) {
564 if (!(f->flags & FIO_FILE_OPEN))
570 cleanup_pending_aio(td);
573 static void cleanup_io_u(struct thread_data *td)
575 struct list_head *entry, *n;
578 list_for_each_safe(entry, n, &td->io_u_freelist) {
579 io_u = list_entry(entry, struct io_u, list);
581 list_del(&io_u->list);
589 * "randomly" fill the buffer contents
591 static void fill_rand_buf(struct io_u *io_u, int max_bs)
593 int *ptr = io_u->buf;
595 while ((void *) ptr - io_u->buf < max_bs) {
596 *ptr = rand() * 0x9e370001;
601 static int init_io_u(struct thread_data *td)
603 unsigned long long buf_size;
609 if (td->io_ops->flags & FIO_SYNCIO)
612 max_units = td->o.iodepth;
614 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
615 buf_size = (unsigned long long) max_bs * (unsigned long long) max_units;
616 buf_size += page_mask;
617 if (buf_size != (size_t) buf_size) {
618 log_err("fio: IO memory too large. Reduce max_bs or iodepth\n");
622 td->orig_buffer_size = buf_size;
624 if (td->o.mem_type == MEM_SHMHUGE || td->o.mem_type == MEM_MMAPHUGE)
625 td->orig_buffer_size = (td->orig_buffer_size + td->o.hugepage_size - 1) & ~(td->o.hugepage_size - 1);
626 else if (td->orig_buffer_size & page_mask)
627 td->orig_buffer_size = (td->orig_buffer_size + page_mask) & ~page_mask;
629 if (allocate_io_mem(td))
632 p = ALIGN(td->orig_buffer);
633 for (i = 0; i < max_units; i++) {
634 io_u = malloc(sizeof(*io_u));
635 memset(io_u, 0, sizeof(*io_u));
636 INIT_LIST_HEAD(&io_u->list);
638 io_u->buf = p + max_bs * i;
639 if (td_write(td) || td_rw(td))
640 fill_rand_buf(io_u, max_bs);
643 io_u->flags = IO_U_F_FREE;
644 list_add(&io_u->list, &td->io_u_freelist);
652 static int switch_ioscheduler(struct thread_data *td)
654 char tmp[256], tmp2[128];
658 if (td->io_ops->flags & FIO_DISKLESSIO)
661 sprintf(tmp, "%s/queue/scheduler", td->sysfs_root);
663 f = fopen(tmp, "r+");
665 td_verror(td, errno, "fopen");
672 ret = fwrite(td->o.ioscheduler, strlen(td->o.ioscheduler), 1, f);
673 if (ferror(f) || ret != 1) {
674 td_verror(td, errno, "fwrite");
682 * Read back and check that the selected scheduler is now the default.
684 ret = fread(tmp, 1, sizeof(tmp), f);
685 if (ferror(f) || ret < 0) {
686 td_verror(td, errno, "fread");
691 sprintf(tmp2, "[%s]", td->o.ioscheduler);
692 if (!strstr(tmp, tmp2)) {
693 log_err("fio: io scheduler %s not found\n", td->o.ioscheduler);
694 td_verror(td, EINVAL, "iosched_switch");
703 static int clear_io_state(struct thread_data *td)
709 td->ts.stat_io_bytes[0] = td->ts.stat_io_bytes[1] = 0;
710 td->this_io_bytes[0] = td->this_io_bytes[1] = 0;
714 td->rw_end_set[0] = td->rw_end_set[1] = 0;
716 td->last_was_sync = 0;
718 for_each_file(td, f, i)
719 td_io_close_file(td, f);
722 for_each_file(td, f, i) {
723 ret = td_io_open_file(td, f);
732 * Entry point for the thread based jobs. The process based jobs end up
733 * here as well, after a little setup.
735 static void *thread_main(void *data)
737 unsigned long long runtime[2];
738 struct thread_data *td = data;
739 unsigned long elapsed;
742 if (!td->o.use_thread)
747 INIT_LIST_HEAD(&td->io_u_freelist);
748 INIT_LIST_HEAD(&td->io_u_busylist);
749 INIT_LIST_HEAD(&td->io_u_requeues);
750 INIT_LIST_HEAD(&td->io_log_list);
751 INIT_LIST_HEAD(&td->io_hist_list);
752 td->io_hist_tree = RB_ROOT;
757 if (fio_setaffinity(td) == -1) {
758 td_verror(td, errno, "cpu_set_affinity");
766 if (ioprio_set(IOPRIO_WHO_PROCESS, 0, td->ioprio) == -1) {
767 td_verror(td, errno, "ioprio_set");
772 if (nice(td->o.nice) == -1) {
773 td_verror(td, errno, "nice");
777 if (td->o.ioscheduler && switch_ioscheduler(td))
780 td_set_runstate(td, TD_INITIALIZED);
781 fio_sem_up(startup_sem);
782 fio_sem_down(td->mutex);
785 * the ->mutex semaphore is now no longer used, close it to avoid
786 * eating a file descriptor
788 fio_sem_remove(td->mutex);
790 if (!td->o.create_serialize && setup_files(td))
799 if (init_random_map(td))
802 if (td->o.exec_prerun) {
803 if (system(td->o.exec_prerun) < 0)
807 fio_gettime(&td->epoch, NULL);
808 memcpy(&td->timeout_end, &td->epoch, sizeof(td->epoch));
809 getrusage(RUSAGE_SELF, &td->ts.ru_start);
811 runtime[0] = runtime[1] = 0;
813 while (td->o.loops--) {
814 fio_gettime(&td->start, NULL);
815 memcpy(&td->ts.stat_sample_time, &td->start, sizeof(td->start));
818 memcpy(&td->lastrate, &td->ts.stat_sample_time, sizeof(td->lastrate));
820 if (clear_state && clear_io_state(td))
823 prune_io_piece_log(td);
829 if (td_read(td) && td->io_bytes[DDIR_READ]) {
830 if (td->rw_end_set[DDIR_READ])
831 elapsed = utime_since(&td->start, &td->rw_end[DDIR_READ]);
833 elapsed = utime_since_now(&td->start);
835 runtime[DDIR_READ] += elapsed;
837 if (td_write(td) && td->io_bytes[DDIR_WRITE]) {
838 if (td->rw_end_set[DDIR_WRITE])
839 elapsed = utime_since(&td->start, &td->rw_end[DDIR_WRITE]);
841 elapsed = utime_since_now(&td->start);
843 runtime[DDIR_WRITE] += elapsed;
846 if (td->error || td->terminate)
849 if (td->o.verify == VERIFY_NONE)
852 if (clear_io_state(td))
855 fio_gettime(&td->start, NULL);
859 runtime[DDIR_READ] += utime_since_now(&td->start);
861 if (td->error || td->terminate)
865 update_rusage_stat(td);
866 td->ts.runtime[0] = runtime[0] / 1000;
867 td->ts.runtime[1] = runtime[1] / 1000;
868 td->ts.total_run_time = mtime_since_now(&td->epoch);
869 td->ts.io_bytes[0] = td->io_bytes[0];
870 td->ts.io_bytes[1] = td->io_bytes[1];
873 finish_log(td, td->ts.bw_log, "bw");
875 finish_log(td, td->ts.slat_log, "slat");
877 finish_log(td, td->ts.clat_log, "clat");
878 if (td->o.write_iolog_file)
879 write_iolog_close(td);
880 if (td->o.exec_postrun) {
881 if (system(td->o.exec_postrun) < 0)
882 log_err("fio: postrun %s failed\n", td->o.exec_postrun);
885 if (exitall_on_terminate)
886 terminate_threads(td->groupid);
890 printf("fio: pid=%d, err=%d/%s\n", td->pid, td->error, td->verror);
894 options_mem_free(td);
895 td_set_runstate(td, TD_EXITED);
896 return (void *) (unsigned long) td->error;
898 fio_sem_up(startup_sem);
903 * We cannot pass the td data into a forked process, so attach the td and
904 * pass it to the thread worker.
906 static int fork_main(int shmid, int offset)
908 struct thread_data *td;
911 data = shmat(shmid, NULL, 0);
912 if (data == (void *) -1) {
919 td = data + offset * sizeof(struct thread_data);
920 ret = thread_main(td);
922 return (int) (unsigned long) ret;
926 * Run over the job map and reap the threads that have exited, if any.
928 static void reap_threads(int *nr_running, int *t_rate, int *m_rate)
930 struct thread_data *td;
931 int i, cputhreads, pending, status, ret;
934 * reap exited threads (TD_EXITED -> TD_REAPED)
936 pending = cputhreads = 0;
941 * ->io_ops is NULL for a thread that has closed its
944 if (td->io_ops && !strcmp(td->io_ops->name, "cpuio"))
947 if (!td->pid || td->runstate == TD_REAPED)
949 if (td->o.use_thread) {
950 if (td->runstate == TD_EXITED) {
951 td_set_runstate(td, TD_REAPED);
958 if (td->runstate == TD_EXITED)
962 * check if someone quit or got killed in an unusual way
964 ret = waitpid(td->pid, &status, flags);
966 if (errno == ECHILD) {
967 log_err("fio: pid=%d disappeared %d\n", td->pid, td->runstate);
968 td_set_runstate(td, TD_REAPED);
972 } else if (ret == td->pid) {
973 if (WIFSIGNALED(status)) {
974 int sig = WTERMSIG(status);
977 log_err("fio: pid=%d, got signal=%d\n", td->pid, sig);
978 td_set_runstate(td, TD_REAPED);
981 if (WIFEXITED(status)) {
982 if (WEXITSTATUS(status) && !td->error)
983 td->error = WEXITSTATUS(status);
985 td_set_runstate(td, TD_REAPED);
991 * thread is not dead, continue
996 if (td->o.use_thread) {
999 if (pthread_join(td->thread, (void *) &ret))
1000 perror("pthread_join");
1004 (*m_rate) -= td->o.ratemin;
1005 (*t_rate) -= td->o.rate;
1012 if (*nr_running == cputhreads && !pending)
1013 terminate_threads(TERMINATE_ALL);
1017 * Main function for kicking off and reaping jobs, as needed.
1019 static void run_threads(void)
1021 struct thread_data *td;
1022 unsigned long spent;
1023 int i, todo, nr_running, m_rate, t_rate, nr_started;
1025 if (fio_pin_memory())
1028 if (!terse_output) {
1029 printf("Starting ");
1031 printf("%d thread%s", nr_thread, nr_thread > 1 ? "s" : "");
1035 printf("%d process%s", nr_process, nr_process > 1 ? "es" : "");
1041 signal(SIGINT, sig_handler);
1042 signal(SIGALRM, sig_handler);
1044 todo = thread_number;
1047 m_rate = t_rate = 0;
1049 for_each_td(td, i) {
1050 print_status_init(td->thread_number - 1);
1052 if (!td->o.create_serialize) {
1058 * do file setup here so it happens sequentially,
1059 * we don't want X number of threads getting their
1060 * client data interspersed on disk
1062 if (setup_files(td)) {
1065 log_err("fio: pid=%d, err=%d/%s\n", td->pid, td->error, td->verror);
1066 td_set_runstate(td, TD_REAPED);
1076 struct thread_data *map[MAX_JOBS];
1077 struct timeval this_start;
1078 int this_jobs = 0, left;
1081 * create threads (TD_NOT_CREATED -> TD_CREATED)
1083 for_each_td(td, i) {
1084 if (td->runstate != TD_NOT_CREATED)
1088 * never got a chance to start, killed by other
1089 * thread for some reason
1091 if (td->terminate) {
1096 if (td->o.start_delay) {
1097 spent = mtime_since_genesis();
1099 if (td->o.start_delay * 1000 > spent)
1103 if (td->o.stonewall && (nr_started || nr_running))
1107 * Set state to created. Thread will transition
1108 * to TD_INITIALIZED when it's done setting up.
1110 td_set_runstate(td, TD_CREATED);
1111 map[this_jobs++] = td;
1114 if (td->o.use_thread) {
1115 if (pthread_create(&td->thread, NULL, thread_main, td)) {
1116 perror("thread_create");
1122 int ret = fork_main(shm_id, i);
1127 fio_sem_down(startup_sem);
1131 * Wait for the started threads to transition to
1134 fio_gettime(&this_start, NULL);
1136 while (left && !fio_abort) {
1137 if (mtime_since_now(&this_start) > JOB_START_TIMEOUT)
1142 for (i = 0; i < this_jobs; i++) {
1146 if (td->runstate == TD_INITIALIZED) {
1149 } else if (td->runstate >= TD_EXITED) {
1153 nr_running++; /* work-around... */
1159 log_err("fio: %d jobs failed to start\n", left);
1160 for (i = 0; i < this_jobs; i++) {
1164 kill(td->pid, SIGTERM);
1170 * start created threads (TD_INITIALIZED -> TD_RUNNING).
1172 for_each_td(td, i) {
1173 if (td->runstate != TD_INITIALIZED)
1176 td_set_runstate(td, TD_RUNNING);
1179 m_rate += td->o.ratemin;
1180 t_rate += td->o.rate;
1182 fio_sem_up(td->mutex);
1185 reap_threads(&nr_running, &t_rate, &m_rate);
1191 while (nr_running) {
1192 reap_threads(&nr_running, &t_rate, &m_rate);
1200 int main(int argc, char *argv[])
1205 * We need locale for number printing, if it isn't set then just
1206 * go with the US format.
1208 if (!getenv("LC_NUMERIC"))
1209 setlocale(LC_NUMERIC, "en_US");
1211 if (parse_options(argc, argv))
1217 ps = sysconf(_SC_PAGESIZE);
1219 log_err("Failed to get page size\n");
1227 setup_log(&agg_io_log[DDIR_READ]);
1228 setup_log(&agg_io_log[DDIR_WRITE]);
1231 startup_sem = fio_sem_init(0);
1235 disk_util_timer_arm();
1242 __finish_log(agg_io_log[DDIR_READ],"agg-read_bw.log");
1243 __finish_log(agg_io_log[DDIR_WRITE],"agg-write_bw.log");
1247 fio_sem_remove(startup_sem);