3 # Copyright (C) 2013 eNovance SAS <licensing@enovance.com>
4 # Author: Erwan Velu <erwan@enovance.com>
6 # The license below covers all files distributed with fio unless otherwise
7 # noted in the file itself.
9 # This program is free software; you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License version 2 as
11 # published by the Free Software Foundation.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program; if not, write to the Free Software
20 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 TEMPLATE=/tmp/template.fio
30 MODES="write,randwrite,read,randread"
39 echo "usage of $PROG:"
41 -h : Show this help & exit
42 -c : Enable cached-based IOs
44 -a : Run sequential test then parallel one
46 -s : Run sequential test (default value)
47 one test after another then one disk after another
49 -p : Run parallel test
50 one test after anoter but all disks at the same time
52 -D iodepth : Run with the specified iodepth
54 -d disk1[,disk2,disk3,..] : Run the tests on the selected disks
55 Separated each disk with a comma
56 Disk name shall be "sdxx", /dev/ shall NOT be used here
57 -r seconds : Time in seconds per benchmark
58 0 means till the end of the device
59 Default is $RUNTIME seconds
60 -b blocksize[,blocksize1, ...] : The blocksizes to test under fio format (4k, 1m, ...)
61 Separated each blocksize with a comma
62 Default is $BLOCK_SIZE
63 -m mode1,[mode2,mode3, ...] : Define the fio IO profile to use like read, write, randread, randwrite
65 -x prefix : Add a prefix to the fio filename
66 Useful to let a context associated with the file
67 If the prefix features a / (slash), prefix will be considered as a directory
68 -A cmd_to_run : System command to run after each job (exec_postrun in fio)
69 -B cmd_to_run : System command to run before each job (exec_prerun in fio)
73 $PROG -d sdb,sdc,sdd,sde -a -b 4k,128k,1m -r 100 -a -x dellr720-day2/
75 Will generate an fio file that will run
76 - a sequential bench on /dev/sdb /dev/sdc /dev/sdd /dev/sde for block size = 4k with write,randwrite,read,randread tests
77 ETA ~ 4 tests * 4 disks * 100 seconds
78 - a sequential bench on /dev/sdb /dev/sdc /dev/sdd /dev/sde for block size = 128k with write,randwrite,read,randread tests
79 ETA ~ 4 tests * 4 disks * 100 seconds
80 - a sequential bench on /dev/sdb /dev/sdc /dev/sdd /dev/sde for block size = 1m with write,randwrite,read,randread tests
81 ETA ~ 4 tests * 4 disks * 100 seconds
82 - a parallel bench on /dev/sdb /dev/sdc /dev/sdd /dev/sde for block size = 4k with write,randwrite,read,randread tests
83 ETA ~ 4 tests * 100 seconds
84 - a parallel bench on /dev/sdb /dev/sdc /dev/sdd /dev/sde for block size = 128k with write,randwrite,read,randread tests
85 ETA ~ 4 tests * 100 seconds
86 - a parallel bench on /dev/sdb /dev/sdc /dev/sdd /dev/sde for block size = 1m with write,randwrite,read,randread tests
87 ETA ~ 4 tests * 100 seconds
89 Generating dellr720-day2/localhost-4k,128k,1m-all-write,randwrite,read,randread-sdb,sdc,sdd,sde.fio
90 Estimated Time = 6000 seconds : 1 hour 40 minutes
95 echo "iodepth=$IODEPTH" >> $TEMPLATE
97 if [ "$RUNTIME" != "0" ]; then
98 echo "runtime=$RUNTIME" >> $TEMPLATE
99 echo "time_based" >> $TEMPLATE
102 if [ "$CACHED_IO" = "FALSE" ]; then
103 echo "direct=1" >> $TEMPLATE
108 cat >$TEMPLATE << EOF
118 cat >> $OUTFILE << EOF
119 [$TYPE-$disk-$BLK_SIZE-seq]
124 write_bw_log=${PREFIX_FILENAME}$SHORT_HOSTNAME-$BLK_SIZE-$disk-$TYPE-seq.results
125 write_iops_log=${PREFIX_FILENAME}$SHORT_HOSTNAME-$BLK_SIZE-$disk-$TYPE-seq.results
127 ETA=$(($ETA + $RUNTIME))
131 for disk in $(echo $DISKS | tr "," " "); do
132 for mode in $(echo $MODES | tr "," " "); do
133 gen_seq_suite "$mode"
143 for disk in $(echo $DISKS | tr "," " "); do
144 cat >> $OUTFILE << EOF
145 [$TYPE-$disk-$BLK_SIZE-para]
149 if [ "$D" = 0 ]; then
150 echo "stonewall" >> $OUTFILE
154 cat >> $OUTFILE << EOF
157 write_bw_log=${PREFIX_FILENAME}$SHORT_HOSTNAME-$BLK_SIZE-$disk-$TYPE-para.results
158 write_iops_log=${PREFIX_FILENAME}$SHORT_HOSTNAME-$BLK_SIZE-$disk-$TYPE-para.results
162 ETA=$(($ETA + $RUNTIME))
167 for mode in $(echo $MODES | tr "," " "); do
168 gen_para_suite "$mode"
188 while getopts "hacpsd:b:r:m:x:D:A:B:" opt; do
201 if [ "$SEQ" = "-1" ]; then
207 echo "$PREFIX" | grep -q "/"
208 if [ "$?" -eq 0 ]; then
210 # No need to keep the prefix for the log files
211 # we do have a directory for that
214 # We need to keep the prefix for the log files
215 PREFIX_FILENAME=$PREFIX
222 if [ "$SEQ" = "-1" ]; then
239 echo "exec_prerun=$OPTARG" >> $TEMPLATE
242 echo "exec_postrun=$OPTARG" >> $TEMPLATE
245 echo "Invalid option: -$OPTARG" >&2
250 if [ "$SEQ" = "-1" ]; then
254 SHORT_HOSTNAME=$(hostname -s)
257 OUTFILE=${PREFIX}$SHORT_HOSTNAME-$BLOCK_SIZE-all-$MODES-$DISKS.fio
261 OUTFILE=${PREFIX}$SHORT_HOSTNAME-$BLOCK_SIZE-sequential-$MODES-$DISKS.fio
264 OUTFILE=${PREFIX}$SHORT_HOSTNAME-$BLOCK_SIZE-parallel-$MODES-$DISKS.fio
268 if [ -z "$DISKS" ]; then
269 echo "Missing DISKS !"
270 echo "Please read the help !"
279 CAUSE="You are reading data before writing them "
281 # If no write occurs, let's show a different message
282 echo $MODES | grep -q "write"
283 if [ "$?" -ne 0 ]; then
284 CAUSE="You are reading data while never wrote them before"
287 for mode in $(echo $MODES | tr "," " "); do
288 echo $mode | grep -q write
289 if [ "$?" -eq 0 ]; then
292 echo $mode | grep -q "read"
293 if [ "$?" -eq 0 ]; then
294 if [ "$FOUND_WRITE" = "NO" ]; then
295 echo "###############################################################"
296 echo "# Warning : $CAUSE#"
297 echo "# On some storage devices, this could lead to invalid results #"
299 echo "# Press Ctrl-C to adjust pattern order if you have doubts #"
300 echo "# Or Wait 5 seconds before the file will be created #"
301 echo "###############################################################"
303 # No need to try showing the message more than one time
317 echo "Generating $OUTFILE"
318 cp -f $TEMPLATE $OUTFILE
321 for BLK_SIZE in $(echo $BLOCK_SIZE | tr "," " "); do
324 ETA_H=$(($ETA / 3600))
325 ETA_M=$((($ETA - ($ETA_H*3600)) / 60))
326 if [ "$ETA" = "0" ]; then
327 echo "Cannot estimate ETA as RUNTIME=0"
329 echo "Estimated Time = $ETA seconds : $ETA_H hour $ETA_M minutes"