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
40 static unsigned long page_mask;
42 (char *) (((unsigned long) (buf) + page_mask) & ~page_mask)
45 int thread_number = 0;
49 static volatile int startup_sem;
50 static volatile int fio_abort;
51 static int exit_value;
53 struct io_log *agg_io_log[2];
55 #define TERMINATE_ALL (-1)
56 #define JOB_START_TIMEOUT (5 * 1000)
58 static inline void td_set_runstate(struct thread_data *td, int runstate)
60 td->runstate = runstate;
63 static void terminate_threads(int group_id, int forced_kill)
65 struct thread_data *td;
69 if (group_id == TERMINATE_ALL || groupid == td->groupid) {
73 td_set_runstate(td, TD_EXITED);
78 static void sig_handler(int sig)
83 disk_util_timer_arm();
84 print_thread_status();
87 printf("\nfio: terminating on signal %d\n", sig);
89 terminate_threads(TERMINATE_ALL, 0);
95 * Check if we are above the minimum rate given.
97 static int check_min_rate(struct thread_data *td, struct timeval *now)
99 unsigned long long bytes = 0;
104 * No minimum rate set, always ok
110 * allow a 2 second settle period in the beginning
112 if (mtime_since(&td->start, now) < 2000)
116 bytes += td->this_io_bytes[DDIR_READ];
118 bytes += td->this_io_bytes[DDIR_WRITE];
121 * if rate blocks is set, sample is running
123 if (td->rate_bytes) {
124 spent = mtime_since(&td->lastrate, now);
125 if (spent < td->ratecycle)
128 if (bytes < td->rate_bytes) {
129 fprintf(f_out, "%s: min rate %u not met\n", td->name, td->ratemin);
132 rate = (bytes - td->rate_bytes) / spent;
133 if (rate < td->ratemin || bytes < td->rate_bytes) {
134 fprintf(f_out, "%s: min rate %u not met, got %luKiB/sec\n", td->name, td->ratemin, rate);
140 td->rate_bytes = bytes;
141 memcpy(&td->lastrate, now, sizeof(*now));
145 static inline int runtime_exceeded(struct thread_data *td, struct timeval *t)
149 if (mtime_since(&td->epoch, t) >= td->timeout * 1000)
156 * When job exits, we can cancel the in-flight IO if we are using async
157 * io. Attempt to do so.
159 static void cleanup_pending_aio(struct thread_data *td)
161 struct list_head *entry, *n;
166 * get immediately available events, if any
168 r = io_u_queued_complete(td, 0);
173 * now cancel remaining active events
175 if (td->io_ops->cancel) {
176 list_for_each_safe(entry, n, &td->io_u_busylist) {
177 io_u = list_entry(entry, struct io_u, list);
180 * if the io_u isn't in flight, then that generally
181 * means someone leaked an io_u. complain but fix
182 * it up, so we don't stall here.
184 if ((io_u->flags & IO_U_F_FLIGHT) == 0) {
185 log_err("fio: non-busy IO on busy list\n");
188 r = td->io_ops->cancel(td, io_u);
196 r = io_u_queued_complete(td, td->cur_depth);
200 * Helper to handle the final sync of a file. Works just like the normal
201 * io path, just does everything sync.
203 static int fio_io_sync(struct thread_data *td, struct fio_file *f)
205 struct io_u *io_u = __get_io_u(td);
211 io_u->ddir = DDIR_SYNC;
214 if (td_io_prep(td, io_u)) {
220 ret = td_io_queue(td, io_u);
222 td_verror(td, io_u->error, "td_io_queue");
225 } else if (ret == FIO_Q_QUEUED) {
226 if (io_u_queued_complete(td, 1) < 0)
228 } else if (ret == FIO_Q_COMPLETED) {
230 td_verror(td, io_u->error, "td_io_queue");
234 if (io_u_sync_complete(td, io_u) < 0)
236 } else if (ret == FIO_Q_BUSY) {
237 if (td_io_commit(td))
246 * The main verify engine. Runs over the writes we previously submitted,
247 * reads the blocks back in, and checks the crc/md5 of the data.
249 static void do_verify(struct thread_data *td)
253 int ret, i, min_events;
256 * sync io first and invalidate cache, to make sure we really
259 for_each_file(td, f, i) {
260 if (fio_io_sync(td, f))
262 if (file_invalidate_cache(td, f))
269 td_set_runstate(td, TD_VERIFYING);
272 while (!td->terminate) {
275 io_u = __get_io_u(td);
279 if (runtime_exceeded(td, &io_u->start_time)) {
284 if (get_next_verify(td, io_u)) {
289 if (td_io_prep(td, io_u)) {
294 io_u->end_io = verify_io_u;
296 ret = td_io_queue(td, io_u);
299 case FIO_Q_COMPLETED:
302 else if (io_u->xfer_buflen != io_u->resid && io_u->resid) {
303 int bytes = io_u->xfer_buflen - io_u->resid;
305 io_u->xfer_buflen = io_u->resid;
306 io_u->xfer_buf += bytes;
309 ret = io_u_sync_complete(td, io_u);
316 requeue_io_u(td, &io_u);
317 ret2 = td_io_commit(td);
323 td_verror(td, -ret, "td_io_queue");
327 if (ret < 0 || td->error)
331 * if we can queue more, do so. but check if there are
332 * completed io_u's first.
335 if (queue_full(td) || ret == FIO_Q_BUSY) {
338 if (td->cur_depth > td->iodepth_low)
339 min_events = td->cur_depth - td->iodepth_low;
343 * Reap required number of io units, if any, and do the
344 * verification on them through the callback handler
346 if (io_u_queued_complete(td, min_events) < 0)
351 min_events = td->cur_depth;
354 ret = io_u_queued_complete(td, min_events);
356 cleanup_pending_aio(td);
358 td_set_runstate(td, TD_RUNNING);
362 * Not really an io thread, all it does is burn CPU cycles in the specified
365 static void do_cpuio(struct thread_data *td)
368 int split = 100 / td->cpuload;
371 while (!td->terminate) {
372 fio_gettime(&e, NULL);
374 if (runtime_exceeded(td, &e))
380 usec_sleep(td, 10000);
387 * Main IO worker function. It retrieves io_u's to process and queues
388 * and reaps them, checking for rate and errors along the way.
390 static void do_io(struct thread_data *td)
396 td_set_runstate(td, TD_RUNNING);
398 while ((td->this_io_bytes[0] + td->this_io_bytes[1]) < td->io_size) {
399 struct timeval comp_time;
412 memcpy(&s, &io_u->start_time, sizeof(s));
414 if (runtime_exceeded(td, &s)) {
419 ret = td_io_queue(td, io_u);
422 case FIO_Q_COMPLETED:
425 else if (io_u->xfer_buflen != io_u->resid && io_u->resid) {
426 int bytes = io_u->xfer_buflen - io_u->resid;
428 io_u->xfer_buflen = io_u->resid;
429 io_u->xfer_buf += bytes;
432 fio_gettime(&comp_time, NULL);
433 bytes_done = io_u_sync_complete(td, io_u);
439 * if the engine doesn't have a commit hook,
440 * the io_u is really queued. if it does have such
441 * a hook, it has to call io_u_queued() itself.
443 if (td->io_ops->commit == NULL)
444 io_u_queued(td, io_u);
447 requeue_io_u(td, &io_u);
448 ret2 = td_io_commit(td);
458 if (ret < 0 || td->error)
462 * See if we need to complete some commands
464 if (ret == FIO_Q_QUEUED || ret == FIO_Q_BUSY) {
466 if (queue_full(td) || ret == FIO_Q_BUSY) {
469 if (td->cur_depth > td->iodepth_low)
470 min_evts = td->cur_depth - td->iodepth_low;
473 fio_gettime(&comp_time, NULL);
474 bytes_done = io_u_queued_complete(td, min_evts);
483 * the rate is batched for now, it should work for batches
484 * of completions except the very first one which may look
487 usec = utime_since(&s, &comp_time);
489 rate_throttle(td, usec, bytes_done);
491 if (check_min_rate(td, &comp_time)) {
492 if (exitall_on_terminate)
493 terminate_threads(td->groupid, 0);
494 td_verror(td, ENODATA, "check_min_rate");
499 unsigned long long b;
501 b = td->io_blocks[0] + td->io_blocks[1];
502 if (!(b % td->thinktime_blocks)) {
505 if (td->thinktime_spin)
506 __usec_sleep(td->thinktime_spin);
508 left = td->thinktime - td->thinktime_spin;
510 usec_sleep(td, left);
520 ret = io_u_queued_complete(td, i);
522 if (should_fsync(td) && td->end_fsync) {
523 td_set_runstate(td, TD_FSYNCING);
524 for_each_file(td, f, i)
528 cleanup_pending_aio(td);
531 static void cleanup_io_u(struct thread_data *td)
533 struct list_head *entry, *n;
536 list_for_each_safe(entry, n, &td->io_u_freelist) {
537 io_u = list_entry(entry, struct io_u, list);
539 list_del(&io_u->list);
547 * "randomly" fill the buffer contents
549 static void fill_rand_buf(struct io_u *io_u, int max_bs)
551 int *ptr = io_u->buf;
553 while ((void *) ptr - io_u->buf < max_bs) {
554 *ptr = rand() * 0x9e370001;
559 static int init_io_u(struct thread_data *td)
566 if (td->io_ops->flags & FIO_CPUIO)
569 if (td->io_ops->flags & FIO_SYNCIO)
572 max_units = td->iodepth;
574 max_bs = max(td->max_bs[DDIR_READ], td->max_bs[DDIR_WRITE]);
575 td->orig_buffer_size = max_bs * max_units;
577 if (td->mem_type == MEM_SHMHUGE || td->mem_type == MEM_MMAPHUGE)
578 td->orig_buffer_size = (td->orig_buffer_size + td->hugepage_size - 1) & ~(td->hugepage_size - 1);
580 td->orig_buffer_size += page_mask;
582 if (allocate_io_mem(td))
585 p = ALIGN(td->orig_buffer);
586 for (i = 0; i < max_units; i++) {
587 io_u = malloc(sizeof(*io_u));
588 memset(io_u, 0, sizeof(*io_u));
589 INIT_LIST_HEAD(&io_u->list);
591 io_u->buf = p + max_bs * i;
592 if (td_write(td) || td_rw(td))
593 fill_rand_buf(io_u, max_bs);
596 io_u->flags = IO_U_F_FREE;
597 list_add(&io_u->list, &td->io_u_freelist);
605 static int switch_ioscheduler(struct thread_data *td)
607 char tmp[256], tmp2[128];
611 if (td->io_ops->flags & FIO_CPUIO)
614 sprintf(tmp, "%s/queue/scheduler", td->sysfs_root);
616 f = fopen(tmp, "r+");
618 td_verror(td, errno, "fopen");
625 ret = fwrite(td->ioscheduler, strlen(td->ioscheduler), 1, f);
626 if (ferror(f) || ret != 1) {
627 td_verror(td, errno, "fwrite");
635 * Read back and check that the selected scheduler is now the default.
637 ret = fread(tmp, 1, sizeof(tmp), f);
638 if (ferror(f) || ret < 0) {
639 td_verror(td, errno, "fread");
644 sprintf(tmp2, "[%s]", td->ioscheduler);
645 if (!strstr(tmp, tmp2)) {
646 log_err("fio: io scheduler %s not found\n", td->ioscheduler);
647 td_verror(td, EINVAL, "iosched_switch");
656 static void clear_io_state(struct thread_data *td)
661 td->ts.stat_io_bytes[0] = td->ts.stat_io_bytes[1] = 0;
662 td->this_io_bytes[0] = td->this_io_bytes[1] = 0;
665 td->last_was_sync = 0;
667 for_each_file(td, f, i) {
668 f->last_completed_pos = 0;
671 if (td->io_ops->flags & FIO_SYNCIO)
672 lseek(f->fd, SEEK_SET, 0);
675 memset(f->file_map, 0, f->num_maps * sizeof(long));
680 * Entry point for the thread based jobs. The process based jobs end up
681 * here as well, after a little setup.
683 static void *thread_main(void *data)
685 unsigned long long runtime[2];
686 struct thread_data *td = data;
693 INIT_LIST_HEAD(&td->io_u_freelist);
694 INIT_LIST_HEAD(&td->io_u_busylist);
695 INIT_LIST_HEAD(&td->io_u_requeues);
696 INIT_LIST_HEAD(&td->io_hist_list);
697 INIT_LIST_HEAD(&td->io_log_list);
702 if (fio_setaffinity(td) == -1) {
703 td_verror(td, errno, "cpu_set_affinity");
711 if (ioprio_set(IOPRIO_WHO_PROCESS, 0, td->ioprio) == -1) {
712 td_verror(td, errno, "ioprio_set");
717 if (nice(td->nice) == -1) {
718 td_verror(td, errno, "nice");
722 if (init_random_state(td))
725 if (td->ioscheduler && switch_ioscheduler(td))
728 td_set_runstate(td, TD_INITIALIZED);
729 fio_sem_up(&startup_sem);
730 fio_sem_down(&td->mutex);
732 if (!td->create_serialize && setup_files(td))
738 * Do this late, as some IO engines would like to have the
739 * files setup prior to initializing structures.
744 if (td->exec_prerun) {
745 if (system(td->exec_prerun) < 0)
749 fio_gettime(&td->epoch, NULL);
750 memcpy(&td->timeout_end, &td->epoch, sizeof(td->epoch));
751 getrusage(RUSAGE_SELF, &td->ts.ru_start);
753 runtime[0] = runtime[1] = 0;
754 while (td->loops--) {
755 fio_gettime(&td->start, NULL);
756 memcpy(&td->ts.stat_sample_time, &td->start, sizeof(td->start));
759 memcpy(&td->lastrate, &td->ts.stat_sample_time, sizeof(td->lastrate));
762 prune_io_piece_log(td);
764 if (td->io_ops->flags & FIO_CPUIO)
769 if (td_read(td) && td->io_bytes[DDIR_READ])
770 runtime[DDIR_READ] += utime_since_now(&td->start);
771 if (td_write(td) && td->io_bytes[DDIR_WRITE])
772 runtime[DDIR_WRITE] += utime_since_now(&td->start);
774 if (td->error || td->terminate)
777 if (td->verify == VERIFY_NONE)
781 fio_gettime(&td->start, NULL);
785 runtime[DDIR_READ] += utime_since_now(&td->start);
787 if (td->error || td->terminate)
791 update_rusage_stat(td);
792 fio_gettime(&td->end_time, NULL);
793 td->runtime[0] = runtime[0] / 1000;
794 td->runtime[1] = runtime[1] / 1000;
797 finish_log(td, td->ts.bw_log, "bw");
799 finish_log(td, td->ts.slat_log, "slat");
801 finish_log(td, td->ts.clat_log, "clat");
802 if (td->write_iolog_file)
803 write_iolog_close(td);
804 if (td->exec_postrun) {
805 if (system(td->exec_postrun) < 0)
806 log_err("fio: postrun %s failed\n", td->exec_postrun);
809 if (exitall_on_terminate)
810 terminate_threads(td->groupid, 0);
814 printf("fio: pid=%d, err=%d/%s\n", td->pid, td->error, td->verror);
818 td_set_runstate(td, TD_EXITED);
819 return (void *) (unsigned long) td->error;
823 * We cannot pass the td data into a forked process, so attach the td and
824 * pass it to the thread worker.
826 static int fork_main(int shmid, int offset)
828 struct thread_data *td;
831 data = shmat(shmid, NULL, 0);
832 if (data == (void *) -1) {
839 td = data + offset * sizeof(struct thread_data);
840 ret = thread_main(td);
842 return (int) (unsigned long) ret;
846 * Run over the job map and reap the threads that have exited, if any.
848 static void reap_threads(int *nr_running, int *t_rate, int *m_rate)
850 struct thread_data *td;
851 int i, cputhreads, pending, status, ret;
854 * reap exited threads (TD_EXITED -> TD_REAPED)
856 pending = cputhreads = 0;
861 * ->io_ops is NULL for a thread that has closed its
864 if (td->io_ops && td->io_ops->flags & FIO_CPUIO)
867 if (!td->pid || td->runstate == TD_REAPED)
869 if (td->use_thread) {
870 if (td->runstate == TD_EXITED) {
871 td_set_runstate(td, TD_REAPED);
878 if (td->runstate == TD_EXITED)
882 * check if someone quit or got killed in an unusual way
884 ret = waitpid(td->pid, &status, flags);
886 if (errno == ECHILD) {
887 log_err("fio: pid=%d disappeared %d\n", td->pid, td->runstate);
888 td_set_runstate(td, TD_REAPED);
892 } else if (ret == td->pid) {
893 if (WIFSIGNALED(status)) {
894 int sig = WTERMSIG(status);
896 log_err("fio: pid=%d, got signal=%d\n", td->pid, sig);
897 td_set_runstate(td, TD_REAPED);
900 if (WIFEXITED(status)) {
901 if (WEXITSTATUS(status) && !td->error)
902 td->error = WEXITSTATUS(status);
904 td_set_runstate(td, TD_REAPED);
910 * thread is not dead, continue
914 if (td->use_thread) {
917 if (pthread_join(td->thread, (void *) &ret))
918 perror("pthread_join");
922 (*m_rate) -= td->ratemin;
923 (*t_rate) -= td->rate;
929 if (*nr_running == cputhreads && !pending)
930 terminate_threads(TERMINATE_ALL, 0);
934 * Main function for kicking off and reaping jobs, as needed.
936 static void run_threads(void)
938 struct thread_data *td;
940 int i, todo, nr_running, m_rate, t_rate, nr_started;
942 if (fio_pin_memory())
946 printf("Starting %d thread%s\n", thread_number, thread_number > 1 ? "s" : "");
950 signal(SIGINT, sig_handler);
951 signal(SIGALRM, sig_handler);
953 todo = thread_number;
959 print_status_init(td->thread_number - 1);
961 if (!td->create_serialize) {
967 * do file setup here so it happens sequentially,
968 * we don't want X number of threads getting their
969 * client data interspersed on disk
971 if (setup_files(td)) {
974 log_err("fio: pid=%d, err=%d/%s\n", td->pid, td->error, td->verror);
975 td_set_runstate(td, TD_REAPED);
985 struct thread_data *map[MAX_JOBS];
986 struct timeval this_start;
987 int this_jobs = 0, left;
990 * create threads (TD_NOT_CREATED -> TD_CREATED)
993 if (td->runstate != TD_NOT_CREATED)
997 * never got a chance to start, killed by other
998 * thread for some reason
1000 if (td->terminate) {
1005 if (td->start_delay) {
1006 spent = mtime_since_genesis();
1008 if (td->start_delay * 1000 > spent)
1012 if (td->stonewall && (nr_started || nr_running))
1016 * Set state to created. Thread will transition
1017 * to TD_INITIALIZED when it's done setting up.
1019 td_set_runstate(td, TD_CREATED);
1020 map[this_jobs++] = td;
1021 fio_sem_init(&startup_sem, 1);
1024 if (td->use_thread) {
1025 if (pthread_create(&td->thread, NULL, thread_main, td)) {
1026 perror("thread_create");
1031 fio_sem_down(&startup_sem);
1033 int ret = fork_main(shm_id, i);
1041 * Wait for the started threads to transition to
1044 fio_gettime(&this_start, NULL);
1046 while (left && !fio_abort) {
1047 if (mtime_since_now(&this_start) > JOB_START_TIMEOUT)
1052 for (i = 0; i < this_jobs; i++) {
1056 if (td->runstate == TD_INITIALIZED) {
1059 } else if (td->runstate >= TD_EXITED) {
1063 nr_running++; /* work-around... */
1069 log_err("fio: %d jobs failed to start\n", left);
1070 for (i = 0; i < this_jobs; i++) {
1074 kill(td->pid, SIGTERM);
1080 * start created threads (TD_INITIALIZED -> TD_RUNNING).
1082 for_each_td(td, i) {
1083 if (td->runstate != TD_INITIALIZED)
1086 td_set_runstate(td, TD_RUNNING);
1089 m_rate += td->ratemin;
1092 fio_sem_up(&td->mutex);
1095 reap_threads(&nr_running, &t_rate, &m_rate);
1101 while (nr_running) {
1102 reap_threads(&nr_running, &t_rate, &m_rate);
1110 int main(int argc, char *argv[])
1115 * We need locale for number printing, if it isn't set then just
1116 * go with the US format.
1118 if (!getenv("LC_NUMERIC"))
1119 setlocale(LC_NUMERIC, "en_US");
1121 if (parse_options(argc, argv))
1124 if (!thread_number) {
1125 log_err("Nothing to do\n");
1129 ps = sysconf(_SC_PAGESIZE);
1131 log_err("Failed to get page size\n");
1138 setup_log(&agg_io_log[DDIR_READ]);
1139 setup_log(&agg_io_log[DDIR_WRITE]);
1144 disk_util_timer_arm();
1151 __finish_log(agg_io_log[DDIR_READ],"agg-read_bw.log");
1152 __finish_log(agg_io_log[DDIR_WRITE],"agg-write_bw.log");