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
34 #include <sys/ioctl.h>
42 #define ALIGN(buf) (char *) (((unsigned long) (buf) + MASK) & ~(MASK))
45 int thread_number = 0;
48 char *fio_inst_prefix = _INST_PREFIX;
50 static volatile int startup_sem;
52 #define TERMINATE_ALL (-1)
53 #define JOB_START_TIMEOUT (5 * 1000)
55 static void terminate_threads(int group_id)
57 struct thread_data *td;
61 if (group_id == TERMINATE_ALL || groupid == td->groupid) {
68 static void sig_handler(int sig)
73 disk_util_timer_arm();
74 print_thread_status();
77 printf("\nfio: terminating on signal\n");
79 terminate_threads(TERMINATE_ALL);
85 * Check if we are above the minimum rate given.
87 static int check_min_rate(struct thread_data *td, struct timeval *now)
94 * allow a 2 second settle period in the beginning
96 if (mtime_since(&td->start, now) < 2000)
100 * if rate blocks is set, sample is running
102 if (td->rate_bytes) {
103 spent = mtime_since(&td->lastrate, now);
104 if (spent < td->ratecycle)
107 rate = (td->this_io_bytes[ddir] - td->rate_bytes) / spent;
108 if (rate < td->ratemin) {
109 fprintf(f_out, "%s: min rate %d not met, got %ldKiB/sec\n", td->name, td->ratemin, rate);
114 td->rate_bytes = td->this_io_bytes[ddir];
115 memcpy(&td->lastrate, now, sizeof(*now));
119 static inline int runtime_exceeded(struct thread_data *td, struct timeval *t)
123 if (mtime_since(&td->epoch, t) >= td->timeout * 1000)
129 static inline void td_set_runstate(struct thread_data *td, int runstate)
131 td->runstate = runstate;
134 static struct fio_file *get_next_file(struct thread_data *td)
136 unsigned int old_next_file = td->next_file;
140 f = &td->files[td->next_file];
143 if (td->next_file >= td->nr_files)
150 } while (td->next_file != old_next_file);
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 timespec ts = { .tv_sec = 0, .tv_nsec = 0};
162 struct list_head *entry, *n;
163 struct io_completion_data icd;
168 * get immediately available events, if any
170 r = td_io_getevents(td, 0, td->cur_depth, &ts);
173 ios_completed(td, &icd);
177 * now cancel remaining active events
179 if (td->io_ops->cancel) {
180 list_for_each_safe(entry, n, &td->io_u_busylist) {
181 io_u = list_entry(entry, struct io_u, list);
183 r = td->io_ops->cancel(td, io_u);
190 r = td_io_getevents(td, td->cur_depth, td->cur_depth, NULL);
193 ios_completed(td, &icd);
199 * Helper to handle the final sync of a file. Works just like the normal
200 * io path, just does everything sync.
202 static int fio_io_sync(struct thread_data *td, struct fio_file *f)
204 struct io_u *io_u = __get_io_u(td);
205 struct io_completion_data icd;
211 io_u->ddir = DDIR_SYNC;
214 if (td_io_prep(td, io_u)) {
219 ret = td_io_queue(td, io_u);
221 td_verror(td, io_u->error);
226 ret = td_io_getevents(td, 1, td->cur_depth, NULL);
233 ios_completed(td, &icd);
235 td_verror(td, icd.error);
243 * The main verify engine. Runs over the writes we previusly submitted,
244 * reads the blocks back in, and checks the crc/md5 of the data.
246 void do_verify(struct thread_data *td)
249 struct io_u *io_u, *v_io_u = NULL;
250 struct io_completion_data icd;
255 * sync io first and invalidate cache, to make sure we really
258 for_each_file(td, f, i) {
260 file_invalidate_cache(td, f);
263 td_set_runstate(td, TD_VERIFYING);
269 gettimeofday(&t, NULL);
270 if (runtime_exceeded(td, &t))
273 io_u = __get_io_u(td);
277 if (get_next_verify(td, io_u)) {
282 f = get_next_file(td);
288 if (td_io_prep(td, io_u)) {
293 ret = td_io_queue(td, io_u);
295 td_verror(td, io_u->error);
301 * we have one pending to verify, do that while
302 * we are doing io on the next one
304 if (do_io_u_verify(td, &v_io_u))
307 ret = td_io_getevents(td, 1, 1, NULL);
314 v_io_u = td->io_ops->event(td, 0);
317 io_completed(td, v_io_u, &icd);
320 td_verror(td, icd.error);
321 put_io_u(td, v_io_u);
327 * if we can't submit more io, we need to verify now
329 if (queue_full(td) && do_io_u_verify(td, &v_io_u))
334 do_io_u_verify(td, &v_io_u);
337 cleanup_pending_aio(td);
339 td_set_runstate(td, TD_RUNNING);
343 * Not really an io thread, all it does is burn CPU cycles in the specified
346 static void do_cpuio(struct thread_data *td)
349 int split = 100 / td->cpuload;
352 while (!td->terminate) {
353 gettimeofday(&e, NULL);
355 if (runtime_exceeded(td, &e))
361 usec_sleep(td, 10000);
368 * Main IO worker function. It retrieves io_u's to process and queues
369 * and reaps them, checking for rate and errors along the way.
371 static void do_io(struct thread_data *td)
373 struct io_completion_data icd;
379 td_set_runstate(td, TD_RUNNING);
381 while (td->this_io_bytes[td->ddir] < td->io_size) {
382 struct timespec ts = { .tv_sec = 0, .tv_nsec = 0};
383 struct timespec *timeout;
390 f = get_next_file(td);
394 io_u = get_io_u(td, f);
398 memcpy(&s, &io_u->start_time, sizeof(s));
400 ret = td_io_queue(td, io_u);
402 td_verror(td, io_u->error);
407 add_slat_sample(td, io_u->ddir, mtime_since(&io_u->start_time, &io_u->issue_time));
409 if (td->cur_depth < td->iodepth) {
417 ret = td_io_getevents(td, min_evts, td->cur_depth, timeout);
425 ios_completed(td, &icd);
427 td_verror(td, icd.error);
432 * the rate is batched for now, it should work for batches
433 * of completions except the very first one which may look
436 gettimeofday(&e, NULL);
437 usec = utime_since(&s, &e);
439 rate_throttle(td, usec, icd.bytes_done[td->ddir]);
441 if (check_min_rate(td, &e)) {
443 terminate_threads(td->groupid);
444 td_verror(td, ENOMEM);
448 if (runtime_exceeded(td, &e))
452 usec_sleep(td, td->thinktime);
457 cleanup_pending_aio(td);
459 if (should_fsync(td) && td->end_fsync) {
460 td_set_runstate(td, TD_FSYNCING);
461 for_each_file(td, f, i)
467 static void cleanup_io_u(struct thread_data *td)
469 struct list_head *entry, *n;
472 list_for_each_safe(entry, n, &td->io_u_freelist) {
473 io_u = list_entry(entry, struct io_u, list);
475 list_del(&io_u->list);
483 * "randomly" fill the buffer contents
485 static void fill_rand_buf(struct io_u *io_u, int max_bs)
487 int *ptr = io_u->buf;
489 while ((void *) ptr - io_u->buf < max_bs) {
490 *ptr = rand() * 0x9e370001;
495 static int init_io_u(struct thread_data *td)
501 if (td->io_ops->flags & FIO_CPUIO)
504 if (td->io_ops->flags & FIO_SYNCIO)
507 max_units = td->iodepth;
509 td->orig_buffer_size = td->max_bs * max_units + MASK;
511 if (allocate_io_mem(td))
514 p = ALIGN(td->orig_buffer);
515 for (i = 0; i < max_units; i++) {
516 io_u = malloc(sizeof(*io_u));
517 memset(io_u, 0, sizeof(*io_u));
518 INIT_LIST_HEAD(&io_u->list);
520 io_u->buf = p + td->max_bs * i;
521 if (td_write(td) || td_rw(td))
522 fill_rand_buf(io_u, td->max_bs);
525 list_add(&io_u->list, &td->io_u_freelist);
531 static int switch_ioscheduler(struct thread_data *td)
533 char tmp[256], tmp2[128];
537 if (td->io_ops->flags & FIO_CPUIO)
540 sprintf(tmp, "%s/queue/scheduler", td->sysfs_root);
542 f = fopen(tmp, "r+");
544 td_verror(td, errno);
551 ret = fwrite(td->ioscheduler, strlen(td->ioscheduler), 1, f);
552 if (ferror(f) || ret != 1) {
553 td_verror(td, errno);
561 * Read back and check that the selected scheduler is now the default.
563 ret = fread(tmp, 1, sizeof(tmp), f);
564 if (ferror(f) || ret < 0) {
565 td_verror(td, errno);
570 sprintf(tmp2, "[%s]", td->ioscheduler);
571 if (!strstr(tmp, tmp2)) {
572 log_err("fio: io scheduler %s not found\n", td->ioscheduler);
573 td_verror(td, EINVAL);
582 static void clear_io_state(struct thread_data *td)
587 td->stat_io_bytes[0] = td->stat_io_bytes[1] = 0;
588 td->this_io_bytes[0] = td->this_io_bytes[1] = 0;
591 for_each_file(td, f, i) {
593 if (td->io_ops->flags & FIO_SYNCIO)
594 lseek(f->fd, SEEK_SET, 0);
597 memset(f->file_map, 0, f->num_maps * sizeof(long));
602 * Entry point for the thread based jobs. The process based jobs end up
603 * here as well, after a little setup.
605 static void *thread_main(void *data)
607 struct thread_data *td = data;
614 INIT_LIST_HEAD(&td->io_u_freelist);
615 INIT_LIST_HEAD(&td->io_u_busylist);
616 INIT_LIST_HEAD(&td->io_hist_list);
617 INIT_LIST_HEAD(&td->io_log_list);
622 if (fio_setaffinity(td) == -1) {
623 td_verror(td, errno);
634 if (ioprio_set(IOPRIO_WHO_PROCESS, 0, td->ioprio) == -1) {
635 td_verror(td, errno);
640 if (nice(td->nice) == -1) {
641 td_verror(td, errno);
645 if (init_random_state(td))
648 if (td->ioscheduler && switch_ioscheduler(td))
651 td_set_runstate(td, TD_INITIALIZED);
652 fio_sem_up(&startup_sem);
653 fio_sem_down(&td->mutex);
655 if (!td->create_serialize && setup_files(td))
658 gettimeofday(&td->epoch, NULL);
661 system(td->exec_prerun);
663 while (td->loops--) {
664 getrusage(RUSAGE_SELF, &td->ru_start);
665 gettimeofday(&td->start, NULL);
666 memcpy(&td->stat_sample_time, &td->start, sizeof(td->start));
669 memcpy(&td->lastrate, &td->stat_sample_time, sizeof(td->lastrate));
672 prune_io_piece_log(td);
674 if (td->io_ops->flags & FIO_CPUIO)
679 td->runtime[td->ddir] += mtime_since_now(&td->start);
680 if (td_rw(td) && td->io_bytes[td->ddir ^ 1])
681 td->runtime[td->ddir ^ 1] = td->runtime[td->ddir];
683 update_rusage_stat(td);
685 if (td->error || td->terminate)
688 if (td->verify == VERIFY_NONE)
692 gettimeofday(&td->start, NULL);
696 td->runtime[DDIR_READ] += mtime_since_now(&td->start);
698 if (td->error || td->terminate)
703 finish_log(td, td->bw_log, "bw");
705 finish_log(td, td->slat_log, "slat");
707 finish_log(td, td->clat_log, "clat");
708 if (td->write_iolog_file)
709 write_iolog_close(td);
710 if (td->exec_postrun)
711 system(td->exec_postrun);
713 if (exitall_on_terminate)
714 terminate_threads(td->groupid);
720 td_set_runstate(td, TD_EXITED);
726 * We cannot pass the td data into a forked process, so attach the td and
727 * pass it to the thread worker.
729 static void *fork_main(int shmid, int offset)
731 struct thread_data *td;
734 data = shmat(shmid, NULL, 0);
735 if (data == (void *) -1) {
740 td = data + offset * sizeof(struct thread_data);
747 * Run over the job map and reap the threads that have exited, if any.
749 static void reap_threads(int *nr_running, int *t_rate, int *m_rate)
751 struct thread_data *td;
755 * reap exited threads (TD_EXITED -> TD_REAPED)
760 * ->io_ops is NULL for a thread that has closed its
763 if (td->io_ops && td->io_ops->flags & FIO_CPUIO)
766 if (td->runstate != TD_EXITED)
769 td_set_runstate(td, TD_REAPED);
771 if (td->use_thread) {
774 if (pthread_join(td->thread, (void *) &ret))
775 perror("thread_join");
777 waitpid(td->pid, NULL, 0);
780 (*m_rate) -= td->ratemin;
781 (*t_rate) -= td->rate;
784 if (*nr_running == cputhreads)
785 terminate_threads(TERMINATE_ALL);
789 * Main function for kicking off and reaping jobs, as needed.
791 static void run_threads(void)
793 struct thread_data *td;
795 int i, todo, nr_running, m_rate, t_rate, nr_started;
797 if (fio_pin_memory())
801 printf("Starting %d thread%s\n", thread_number, thread_number > 1 ? "s" : "");
805 signal(SIGINT, sig_handler);
806 signal(SIGALRM, sig_handler);
808 todo = thread_number;
814 print_status_init(td->thread_number - 1);
818 if (!td->create_serialize)
822 * do file setup here so it happens sequentially,
823 * we don't want X number of threads getting their
824 * client data interspersed on disk
826 if (setup_files(td)) {
827 td_set_runstate(td, TD_REAPED);
835 struct thread_data *map[MAX_JOBS];
836 struct timeval this_start;
837 int this_jobs = 0, left;
840 * create threads (TD_NOT_CREATED -> TD_CREATED)
843 if (td->runstate != TD_NOT_CREATED)
847 * never got a chance to start, killed by other
848 * thread for some reason
855 if (td->start_delay) {
856 spent = mtime_since_genesis();
858 if (td->start_delay * 1000 > spent)
862 if (td->stonewall && (nr_started || nr_running))
866 * Set state to created. Thread will transition
867 * to TD_INITIALIZED when it's done setting up.
869 td_set_runstate(td, TD_CREATED);
870 map[this_jobs++] = td;
871 fio_sem_init(&startup_sem, 1);
874 if (td->use_thread) {
875 if (pthread_create(&td->thread, NULL, thread_main, td)) {
876 perror("thread_create");
881 fio_sem_down(&startup_sem);
883 fork_main(shm_id, i);
890 * Wait for the started threads to transition to
893 gettimeofday(&this_start, NULL);
896 if (mtime_since_now(&this_start) > JOB_START_TIMEOUT)
901 for (i = 0; i < this_jobs; i++) {
905 if (td->runstate == TD_INITIALIZED) {
908 } else if (td->runstate >= TD_EXITED) {
912 nr_running++; /* work-around... */
918 log_err("fio: %d jobs failed to start\n", left);
919 for (i = 0; i < this_jobs; i++) {
923 kill(td->pid, SIGTERM);
929 * start created threads (TD_INITIALIZED -> TD_RUNNING).
932 if (td->runstate != TD_INITIALIZED)
935 td_set_runstate(td, TD_RUNNING);
938 m_rate += td->ratemin;
941 fio_sem_up(&td->mutex);
944 reap_threads(&nr_running, &t_rate, &m_rate);
951 reap_threads(&nr_running, &t_rate, &m_rate);
959 int main(int argc, char *argv[])
961 if (parse_options(argc, argv))
964 if (!thread_number) {
965 log_err("Nothing to do\n");
969 disk_util_timer_arm();