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)
104 * allow a 2 second settle period in the beginning
106 if (mtime_since(&td->start, now) < 2000)
110 * if rate blocks is set, sample is running
112 if (td->rate_bytes) {
113 spent = mtime_since(&td->lastrate, now);
114 if (spent < td->ratecycle)
117 rate = (td->this_io_bytes[ddir] - td->rate_bytes) / spent;
118 if (rate < td->ratemin) {
119 fprintf(f_out, "%s: min rate %u not met, got %luKiB/sec\n", td->name, td->ratemin, rate);
124 td->rate_bytes = td->this_io_bytes[ddir];
125 memcpy(&td->lastrate, now, sizeof(*now));
129 static inline int runtime_exceeded(struct thread_data *td, struct timeval *t)
133 if (mtime_since(&td->epoch, t) >= td->timeout * 1000)
139 static struct fio_file *get_next_file(struct thread_data *td)
141 unsigned int old_next_file = td->next_file;
145 f = &td->files[td->next_file];
148 if (td->next_file >= td->nr_files)
155 } while (td->next_file != old_next_file);
161 * When job exits, we can cancel the in-flight IO if we are using async
162 * io. Attempt to do so.
164 static void cleanup_pending_aio(struct thread_data *td)
166 struct list_head *entry, *n;
171 * get immediately available events, if any
173 io_u_queued_complete(td, 0, NULL);
176 * now cancel remaining active events
178 if (td->io_ops->cancel) {
179 list_for_each_safe(entry, n, &td->io_u_busylist) {
180 io_u = list_entry(entry, struct io_u, list);
182 r = td->io_ops->cancel(td, io_u);
189 io_u_queued_complete(td, td->cur_depth, NULL);
193 * Helper to handle the final sync of a file. Works just like the normal
194 * io path, just does everything sync.
196 static int fio_io_sync(struct thread_data *td, struct fio_file *f)
198 struct io_u *io_u = __get_io_u(td);
204 io_u->ddir = DDIR_SYNC;
207 if (td_io_prep(td, io_u)) {
212 ret = td_io_queue(td, io_u);
214 td_verror(td, io_u->error);
217 } else if (ret == FIO_Q_QUEUED) {
218 if (io_u_queued_complete(td, 1, NULL))
220 } else if (ret == FIO_Q_COMPLETED) {
222 td_verror(td, io_u->error);
226 io_u_sync_complete(td, io_u, NULL);
233 * The main verify engine. Runs over the writes we previusly submitted,
234 * reads the blocks back in, and checks the crc/md5 of the data.
236 static void do_verify(struct thread_data *td)
240 int ret, i, min_events;
243 * sync io first and invalidate cache, to make sure we really
246 for_each_file(td, f, i) {
248 file_invalidate_cache(td, f);
251 td_set_runstate(td, TD_VERIFYING);
254 while (!td->terminate) {
255 io_u = __get_io_u(td);
259 if (runtime_exceeded(td, &io_u->start_time))
262 if (get_next_verify(td, io_u))
265 if (td_io_prep(td, io_u))
269 ret = td_io_queue(td, io_u);
272 case FIO_Q_COMPLETED:
275 if (io_u->xfer_buflen != io_u->resid && io_u->resid) {
276 int bytes = io_u->xfer_buflen - io_u->resid;
278 io_u->xfer_buflen = io_u->resid;
279 io_u->xfer_buf += bytes;
282 ret = io_u_sync_complete(td, io_u, verify_io_u);
294 if (ret < 0 || td->error)
298 * if we can queue more, do so. but check if there are
299 * completed io_u's first.
306 * Reap required number of io units, if any, and do the
307 * verification on them through the callback handler
309 if (io_u_queued_complete(td, min_events, verify_io_u))
317 cleanup_pending_aio(td);
319 td_set_runstate(td, TD_RUNNING);
323 * Not really an io thread, all it does is burn CPU cycles in the specified
326 static void do_cpuio(struct thread_data *td)
329 int split = 100 / td->cpuload;
332 while (!td->terminate) {
333 fio_gettime(&e, NULL);
335 if (runtime_exceeded(td, &e))
341 usec_sleep(td, 10000);
348 * Main IO worker function. It retrieves io_u's to process and queues
349 * and reaps them, checking for rate and errors along the way.
351 static void do_io(struct thread_data *td)
358 td_set_runstate(td, TD_RUNNING);
360 while ((td->this_io_bytes[0] + td->this_io_bytes[1]) < td->io_size) {
361 struct timeval comp_time;
369 f = get_next_file(td);
373 io_u = get_io_u(td, f);
377 memcpy(&s, &io_u->start_time, sizeof(s));
379 if (runtime_exceeded(td, &s)) {
384 ret = td_io_queue(td, io_u);
387 case FIO_Q_COMPLETED:
392 if (io_u->xfer_buflen != io_u->resid && io_u->resid) {
393 int bytes = io_u->xfer_buflen - io_u->resid;
395 io_u->xfer_buflen = io_u->resid;
396 io_u->xfer_buf += bytes;
399 fio_gettime(&comp_time, NULL);
400 bytes_done = io_u_sync_complete(td, io_u, NULL);
412 if (ret < 0 || td->error)
415 add_slat_sample(td, io_u->ddir, mtime_since(&io_u->start_time, &io_u->issue_time));
418 * See if we need to complete some commands
420 if (ret == FIO_Q_QUEUED) {
425 fio_gettime(&comp_time, NULL);
426 bytes_done = io_u_queued_complete(td, min_evts, NULL);
435 * the rate is batched for now, it should work for batches
436 * of completions except the very first one which may look
439 usec = utime_since(&s, &comp_time);
441 rate_throttle(td, usec, bytes_done, td->ddir);
443 if (check_min_rate(td, &comp_time)) {
444 if (exitall_on_terminate)
445 terminate_threads(td->groupid, 0);
446 td_verror(td, ENODATA);
451 unsigned long long b;
453 b = td->io_blocks[0] + td->io_blocks[1];
454 if (!(b % td->thinktime_blocks)) {
457 if (td->thinktime_spin)
458 __usec_sleep(td->thinktime_spin);
460 left = td->thinktime - td->thinktime_spin;
462 usec_sleep(td, left);
469 cleanup_pending_aio(td);
471 if (should_fsync(td) && td->end_fsync) {
472 td_set_runstate(td, TD_FSYNCING);
473 for_each_file(td, f, i)
479 static void cleanup_io_u(struct thread_data *td)
481 struct list_head *entry, *n;
484 list_for_each_safe(entry, n, &td->io_u_freelist) {
485 io_u = list_entry(entry, struct io_u, list);
487 list_del(&io_u->list);
495 * "randomly" fill the buffer contents
497 static void fill_rand_buf(struct io_u *io_u, int max_bs)
499 int *ptr = io_u->buf;
501 while ((void *) ptr - io_u->buf < max_bs) {
502 *ptr = rand() * 0x9e370001;
507 static int init_io_u(struct thread_data *td)
514 if (td->io_ops->flags & FIO_CPUIO)
517 if (td->io_ops->flags & FIO_SYNCIO)
520 max_units = td->iodepth;
522 max_bs = max(td->max_bs[DDIR_READ], td->max_bs[DDIR_WRITE]);
523 td->orig_buffer_size = max_bs * max_units;
525 if (td->mem_type == MEM_SHMHUGE || td->mem_type == MEM_MMAPHUGE)
526 td->orig_buffer_size = (td->orig_buffer_size + td->hugepage_size - 1) & ~(td->hugepage_size - 1);
528 td->orig_buffer_size += page_mask;
530 if (allocate_io_mem(td))
533 p = ALIGN(td->orig_buffer);
534 for (i = 0; i < max_units; i++) {
535 io_u = malloc(sizeof(*io_u));
536 memset(io_u, 0, sizeof(*io_u));
537 INIT_LIST_HEAD(&io_u->list);
539 io_u->buf = p + max_bs * i;
540 if (td_write(td) || td_rw(td))
541 fill_rand_buf(io_u, max_bs);
544 list_add(&io_u->list, &td->io_u_freelist);
550 static int switch_ioscheduler(struct thread_data *td)
552 char tmp[256], tmp2[128];
556 if (td->io_ops->flags & FIO_CPUIO)
559 sprintf(tmp, "%s/queue/scheduler", td->sysfs_root);
561 f = fopen(tmp, "r+");
563 td_verror(td, errno);
570 ret = fwrite(td->ioscheduler, strlen(td->ioscheduler), 1, f);
571 if (ferror(f) || ret != 1) {
572 td_verror(td, errno);
580 * Read back and check that the selected scheduler is now the default.
582 ret = fread(tmp, 1, sizeof(tmp), f);
583 if (ferror(f) || ret < 0) {
584 td_verror(td, errno);
589 sprintf(tmp2, "[%s]", td->ioscheduler);
590 if (!strstr(tmp, tmp2)) {
591 log_err("fio: io scheduler %s not found\n", td->ioscheduler);
592 td_verror(td, EINVAL);
601 static void clear_io_state(struct thread_data *td)
606 td->stat_io_bytes[0] = td->stat_io_bytes[1] = 0;
607 td->this_io_bytes[0] = td->this_io_bytes[1] = 0;
610 for_each_file(td, f, i) {
612 if (td->io_ops->flags & FIO_SYNCIO)
613 lseek(f->fd, SEEK_SET, 0);
616 memset(f->file_map, 0, f->num_maps * sizeof(long));
621 * Entry point for the thread based jobs. The process based jobs end up
622 * here as well, after a little setup.
624 static void *thread_main(void *data)
626 unsigned long long runtime[2];
627 struct thread_data *td = data;
634 INIT_LIST_HEAD(&td->io_u_freelist);
635 INIT_LIST_HEAD(&td->io_u_busylist);
636 INIT_LIST_HEAD(&td->io_hist_list);
637 INIT_LIST_HEAD(&td->io_log_list);
642 if (fio_setaffinity(td) == -1) {
643 td_verror(td, errno);
651 if (ioprio_set(IOPRIO_WHO_PROCESS, 0, td->ioprio) == -1) {
652 td_verror(td, errno);
657 if (nice(td->nice) == -1) {
658 td_verror(td, errno);
662 if (init_random_state(td))
665 if (td->ioscheduler && switch_ioscheduler(td))
668 td_set_runstate(td, TD_INITIALIZED);
669 fio_sem_up(&startup_sem);
670 fio_sem_down(&td->mutex);
672 if (!td->create_serialize && setup_files(td))
678 * Do this late, as some IO engines would like to have the
679 * files setup prior to initializing structures.
684 if (td->exec_prerun) {
685 if (system(td->exec_prerun) < 0)
689 fio_gettime(&td->epoch, NULL);
690 getrusage(RUSAGE_SELF, &td->ru_start);
692 runtime[0] = runtime[1] = 0;
693 while (td->loops--) {
694 fio_gettime(&td->start, NULL);
695 memcpy(&td->stat_sample_time, &td->start, sizeof(td->start));
698 memcpy(&td->lastrate, &td->stat_sample_time, sizeof(td->lastrate));
701 prune_io_piece_log(td);
703 if (td->io_ops->flags & FIO_CPUIO)
708 runtime[td->ddir] += utime_since_now(&td->start);
709 if (td_rw(td) && td->io_bytes[td->ddir ^ 1])
710 runtime[td->ddir ^ 1] = runtime[td->ddir];
712 if (td->error || td->terminate)
715 if (td->verify == VERIFY_NONE)
719 fio_gettime(&td->start, NULL);
723 runtime[DDIR_READ] += utime_since_now(&td->start);
725 if (td->error || td->terminate)
729 update_rusage_stat(td);
730 fio_gettime(&td->end_time, NULL);
731 td->runtime[0] = runtime[0] / 1000;
732 td->runtime[1] = runtime[1] / 1000;
735 finish_log(td, td->bw_log, "bw");
737 finish_log(td, td->slat_log, "slat");
739 finish_log(td, td->clat_log, "clat");
740 if (td->write_iolog_file)
741 write_iolog_close(td);
742 if (td->exec_postrun) {
743 if (system(td->exec_postrun) < 0)
744 log_err("fio: postrun %s failed\n", td->exec_postrun);
747 if (exitall_on_terminate)
748 terminate_threads(td->groupid, 0);
752 printf("fio: pid=%d, err=%d/%s\n", td->pid, td->error, td->verror);
756 td_set_runstate(td, TD_EXITED);
757 return (void *) td->error;
761 * We cannot pass the td data into a forked process, so attach the td and
762 * pass it to the thread worker.
764 static int fork_main(int shmid, int offset)
766 struct thread_data *td;
769 data = shmat(shmid, NULL, 0);
770 if (data == (void *) -1) {
777 td = data + offset * sizeof(struct thread_data);
778 ret = thread_main(td);
784 * Run over the job map and reap the threads that have exited, if any.
786 static void reap_threads(int *nr_running, int *t_rate, int *m_rate)
788 struct thread_data *td;
789 int i, cputhreads, pending, status, ret;
792 * reap exited threads (TD_EXITED -> TD_REAPED)
794 pending = cputhreads = 0;
797 * ->io_ops is NULL for a thread that has closed its
800 if (td->io_ops && td->io_ops->flags & FIO_CPUIO)
803 if (td->runstate < TD_EXITED) {
805 * check if someone quit or got killed in an unusual way
807 ret = waitpid(td->pid, &status, WNOHANG);
810 else if ((ret == td->pid) && WIFSIGNALED(status)) {
811 int sig = WTERMSIG(status);
813 log_err("fio: pid=%d, got signal=%d\n", td->pid, sig);
814 td_set_runstate(td, TD_REAPED);
819 if (td->runstate != TD_EXITED) {
820 if (td->runstate < TD_RUNNING)
829 td_set_runstate(td, TD_REAPED);
831 if (td->use_thread) {
834 if (pthread_join(td->thread, (void *) &ret))
835 perror("thread_join");
839 ret = waitpid(td->pid, &status, 0);
842 else if (WIFEXITED(status) && WEXITSTATUS(status)) {
850 (*m_rate) -= td->ratemin;
851 (*t_rate) -= td->rate;
854 if (*nr_running == cputhreads && !pending)
855 terminate_threads(TERMINATE_ALL, 0);
859 * Main function for kicking off and reaping jobs, as needed.
861 static void run_threads(void)
863 struct thread_data *td;
865 int i, todo, nr_running, m_rate, t_rate, nr_started;
867 if (fio_pin_memory())
871 printf("Starting %d thread%s\n", thread_number, thread_number > 1 ? "s" : "");
875 signal(SIGINT, sig_handler);
876 signal(SIGALRM, sig_handler);
878 todo = thread_number;
884 print_status_init(td->thread_number - 1);
886 if (!td->create_serialize) {
892 * do file setup here so it happens sequentially,
893 * we don't want X number of threads getting their
894 * client data interspersed on disk
896 if (setup_files(td)) {
899 log_err("fio: pid=%d, err=%d/%s\n", td->pid, td->error, td->verror);
900 td_set_runstate(td, TD_REAPED);
908 struct thread_data *map[MAX_JOBS];
909 struct timeval this_start;
910 int this_jobs = 0, left;
913 * create threads (TD_NOT_CREATED -> TD_CREATED)
916 if (td->runstate != TD_NOT_CREATED)
920 * never got a chance to start, killed by other
921 * thread for some reason
928 if (td->start_delay) {
929 spent = mtime_since_genesis();
931 if (td->start_delay * 1000 > spent)
935 if (td->stonewall && (nr_started || nr_running))
939 * Set state to created. Thread will transition
940 * to TD_INITIALIZED when it's done setting up.
942 td_set_runstate(td, TD_CREATED);
943 map[this_jobs++] = td;
944 fio_sem_init(&startup_sem, 1);
947 if (td->use_thread) {
948 if (pthread_create(&td->thread, NULL, thread_main, td)) {
949 perror("thread_create");
954 fio_sem_down(&startup_sem);
956 int ret = fork_main(shm_id, i);
964 * Wait for the started threads to transition to
967 fio_gettime(&this_start, NULL);
969 while (left && !fio_abort) {
970 if (mtime_since_now(&this_start) > JOB_START_TIMEOUT)
975 for (i = 0; i < this_jobs; i++) {
979 if (td->runstate == TD_INITIALIZED) {
982 } else if (td->runstate >= TD_EXITED) {
986 nr_running++; /* work-around... */
992 log_err("fio: %d jobs failed to start\n", left);
993 for (i = 0; i < this_jobs; i++) {
997 kill(td->pid, SIGTERM);
1003 * start created threads (TD_INITIALIZED -> TD_RUNNING).
1005 for_each_td(td, i) {
1006 if (td->runstate != TD_INITIALIZED)
1009 td_set_runstate(td, TD_RUNNING);
1012 m_rate += td->ratemin;
1015 fio_sem_up(&td->mutex);
1018 reap_threads(&nr_running, &t_rate, &m_rate);
1024 while (nr_running) {
1025 reap_threads(&nr_running, &t_rate, &m_rate);
1033 int main(int argc, char *argv[])
1038 * We need locale for number printing, if it isn't set then just
1039 * go with the US format.
1041 if (!getenv("LC_NUMERIC"))
1042 setlocale(LC_NUMERIC, "en_US");
1044 if (parse_options(argc, argv))
1047 if (!thread_number) {
1048 log_err("Nothing to do\n");
1052 ps = sysconf(_SC_PAGESIZE);
1054 log_err("Failed to get page size\n");
1061 setup_log(&agg_io_log[DDIR_READ]);
1062 setup_log(&agg_io_log[DDIR_WRITE]);
1065 disk_util_timer_arm();
1072 __finish_log(agg_io_log[DDIR_READ],"agg-read_bw.log");
1073 __finish_log(agg_io_log[DDIR_WRITE],"agg-write_bw.log");