2 # This file is part of NIT ( http://www.nitlanguage.org ).
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 # This shell script helps running benchmarks
18 # TODO: cleanup and libify the helper-parts
20 source .
/bench_plot.sh
22 ## CONFIGURATION OPTIONS ##
24 # Default number of times a command must be run with bench_command
25 # Can be overrided with 'the option -n'
28 pep8analysis
=..
/..
/pep8analysis
30 ### HELPER FUNCTIONS ##
38 # Run a single command multiple time and store the execution times
39 # in the current $res file.
41 # $1: title of the command
42 # $2: long desription of the command
43 # rest: the command to execute
44 function bench_command
()
46 if [ "$dry_run" = "true" ]; then return; fi
51 if test "$verbose" = true
; then outputopts
="/dev/stdout"; else outputopts
="/dev/null"; fi
53 echo "$title" > "$timeout"
54 echo "# $desc" >> "$timeout"
55 echo "\$ $@" >> "$timeout"
57 echo "** [$title] $desc **"
60 # Execute the commands $count times
61 for i
in `seq 1 "$count"`; do
62 /usr
/bin
/time -f
"%U" -o
"$timeout" -a
"$@" > $outputopts 2>&1 || die
"$1: failed"
67 line
=`compute_stats "$timeout"`
72 # Run a simble command witout storing the execution time
73 # Used to display command on verbose and skip long executions when dry_run is given
74 # $@ command to execute
75 function run_command
()
77 if [ "$dry_run" = "true" ]; then return; fi
79 "$@" || die
"$@: failed"
82 # Check if the test should be skiped according to its name
83 # $1: name of the test
84 # $2: description of the test
85 # $NOTSKIPED: arguments
88 if test -z
"$NOTSKIPED"; then
92 if test "$NOTSKIPED" = "all"; then
94 elif echo "$1" |
egrep "$NOTSKIPED" >/dev
/null
2>&1; then
95 : # Found one to execute
99 if test -n
"$html"; then
100 echo >>"$html" "<h2>$1</h2>"
110 # Run standards benchs on a compiler command
112 # rest: command to run (executable + options)
113 function run_compiler
()
117 if test -n
"$fast"; then
118 run_command
"$@" ..
/src
/nitg.nit
-o
"nitg.$title.bin"
119 bench_command
"nitg-g" "nitg --global ../src/test_parser.nit" "./nitg.$title.bin" -v
--global
--no
-cc ..
/src
/test_parser.nit
120 run_command
"$@" ..
/src
/nit.nit
-o
"nit.$title.bin"
121 bench_command
"nit" "nit ../src/test_parser.nit ../src/location.nit" "./nit.$title.bin" -v ..
/src
/test_parser.nit
-- -n ..
/src
/location.nit
122 run_command
"$@" ..
/examples
/shoot
/src
/shoot_logic.nit
-o
"shoot.$title.bin"
123 bench_command
"shoot" "shoot_logic" "./shoot.$title.bin"
124 run_command
"$@" ..
/tests
/bench_bintree_gen.nit
-o
"bintrees.$title.bin"
125 bench_command
"bintrees" "bench_bintree_gen 16" "./bintrees.$title.bin" 16
127 run_command
"$@" ..
/src
/nitg.nit
-o
"nitg.$title.bin"
128 bench_command
"nitg-g" "nitg --global --no-cc ../src/nitmetrics.nit" "./nitg.$title.bin" -v
--global
--no
-cc ..
/src
/nitmetrics.nit
129 bench_command
"nitg-s" "nitg --separate ../src/nitg.nit" "./nitg.$title.bin" -v
--no
-cc
--separate ..
/src
/nitg.nit
130 run_command
"$@" ..
/src
/nit.nit
-o
"nit.$title.bin"
131 bench_command
"nit" "nit ../src/test_parser.nit ../src/rapid_type_analysis.nit" "./nit.$title.bin" -v ..
/src
/test_parser.nit
-- -n ..
/src
/rapid_type_analysis.nit
132 run_command
"$@" ..
/examples
/shoot
/src
/shoot_logic.nit
-o
"shoot.$title.bin"
133 bench_command
"shoot" "shoot_logic 30" "./shoot.$title.bin" 30
134 run_command
"$@" ..
/tests
/bench_bintree_gen.nit
-o
"bintrees.$title.bin"
135 bench_command
"bintrees" "bench_bintree_gen 18" "./bintrees.$title.bin" 18
136 if test -f
"$pep8analysis/src/pep8analysis.nit"; then
137 run_command
"$@" "$pep8analysis/src/pep8analysis.nit" -I
"$pep8analysis/lib" -o
"pep8a.$title.bin"
138 bench_command
"pep8analisis" "bench_bintree_gen 18" "./pep8a.$title.bin" "$pep8analysis/tests/privat/"*.pep
147 echo "run_bench: [options]* benchname"
148 echo " -v: verbose mode"
149 echo " -n count: number of execution for each bar (default: $count)"
150 echo " --dry: Do not run the commands, just reuse the data and generate the graph"
151 echo " --fast: Run less and faster tests"
152 echo " --html: Generate and HTML output"
153 echo " -h: this help"
157 while [ "$stop" = false
]; do
159 -v
) verbose
=true
; shift;;
161 -n
) count
="$2"; shift; shift;;
162 --dry
) dry_run
=true
; shift;;
163 --fast
) fast
=true
; shift;;
164 --html
) html
="index.html"; echo >"$html" "<html><head></head><body>"; shift;;
171 if test -z
"$NOTSKIPED"; then
173 echo "List of available benches:"
174 echo "* all: run all the benches"
179 # force to use the last nitg, not the bootstraped one
180 test -f .
/nitg || ..
/bin
/nitg ..
/src
/nitg.nit
-v
182 ## EFFECTIVE BENCHS ##
184 function bench_steps
()
187 skip_test
"$name" && return
188 prepare_res
"$name-nitg.dat" "nitg-g" "Various steps of nitg --global"
189 bench_command
"parse" "" .
/nitg
--global
--only
-parse ..
/src
/nitg.nit
190 bench_command
"metamodel" "" .
/nitg
--global
--only
-metamodel ..
/src
/nitg.nit
191 bench_command
"generate c" "" .
/nitg
--global
--no
-cc ..
/src
/nitg.nit
192 bench_command
"full" "" .
/nitg
--global ..
/src
/nitg.nit
-o
"nitg_nitg.bin"
194 prepare_res
"$name-nitg-s.dat" "nitg-s" "Various steps of nitg --separate"
195 bench_command
"parse" "" .
/nitg
--separate
--only
-parse ..
/src
/nitg.nit
196 bench_command
"metamodel" "" .
/nitg
--separate
--only
-metamodel ..
/src
/nitg.nit
197 bench_command
"generate c" "" .
/nitg
--separate
--no
-cc ..
/src
/nitg.nit
198 bench_command
"full" "" .
/nitg
--separate ..
/src
/nitg.nit
-o
"nitg_nitg-e.bin"
200 prepare_res
"$name-nitg-e.dat" "nitg-e" "Various steps of nitg --erasure"
201 bench_command
"parse" "" .
/nitg
--erasure
--only
-parse ..
/src
/nitg.nit
202 bench_command
"metamodel" "" .
/nitg
--erasure
--only
-metamodel ..
/src
/nitg.nit
203 bench_command
"generate c" "" .
/nitg
--erasure
--no
-cc ..
/src
/nitg.nit
204 bench_command
"full" "" .
/nitg
--erasure ..
/src
/nitg.nit
-o
"nitg_nitg-e.bin"
210 # $#: options to compare
211 function bench_nitg
-g_options
()
215 name
="$FUNCNAME-$tag"
216 skip_test
"$name" && return
217 prepare_res
"$name.dat" "no options" "nitg-g without options"
218 run_compiler
"nitg-g" .
/nitg
--global
220 if test "$1" = NOALL
; then
222 elif test -n
"$2"; then
223 prepare_res
"$name-all.dat" "all" "nitg-g with all options $@"
224 run_compiler
"nitg-g-$tag" .
/nitg
--global $@
229 prepare_res
"$name$ot.dat" "$opt" "nitg-g with option $opt"
230 run_compiler
"nitg-g$ot" .
/nitg
--global
$opt
235 bench_nitg
-g_options
"slower" --hardening
236 bench_nitg
-g_options
"nocheck" --no
-check
-covariance
--no
-check
-attr
-isset
--no
-check
-assert
--no
-check
-autocast
--no
-check
-other
238 function bench_nitg
-s_options
()
242 name
="$FUNCNAME-$tag"
243 skip_test
"$name" && return
244 prepare_res
"$name.dat" "no options" "nitg-s without options"
245 run_compiler
"nitg-s" .
/nitg
--separate
247 if test "$1" = NOALL
; then
249 elif test -n
"$2"; then
250 prepare_res
"$name-all.dat" "all" "nitg-s with all options $@"
251 run_compiler
"nitg-s-$tag" .
/nitg
--separate $@
256 prepare_res
"$name-$ot.dat" "$opt" "nitg-s with option $opt"
257 run_compiler
"nitg-s$ot" .
/nitg
--separate
$opt
262 bench_nitg
-s_options
"slower" --hardening
--no
-inline
-intern
--no
-union
-attribute
--no
-shortcut
-equal
--no
-shortcut
-range
"--no-gcc-directive likely" "--no-gcc-directive noreturn"
263 bench_nitg
-s_options
"nocheck" --no
-check
-covariance
--no
-check
-attr
-isset
--no
-check
-assert
--no
-check
-autocast
--no
-check
-other
264 bench_nitg
-s_options
"faster" --inline
-coloring
-numbers
--inline
-some
-methods
--direct
-call
-monomorph
"--inline-some-methods --direct-call-monomorph"
266 function bench_nitg
-e_options
()
270 name
="$FUNCNAME-$tag"
271 skip_test
"$name" && return
272 prepare_res
"$name.dat" "no options" "nitg-e without options"
273 run_compiler
"nitg-e" .
/nitg
--erasure
275 if test "$1" = NOALL
; then
277 elif test -n
"$2"; then
278 prepare_res
"$name-all.dat" "all" "nitg-e with all options $@"
279 run_compiler
"nitg-e-$tag" .
/nitg
--erasure $@
284 prepare_res
"$name$ot.dat" "$opt" "nitg-e with option $opt"
285 run_compiler
"nitg-e$ot" .
/nitg
--erasure
$opt
290 bench_nitg
-e_options
"slower" --hardening
--no
-inline
-intern
--no
-union
-attribute
--no
-shortcut
-equal
--no
-shortcut
-range
291 bench_nitg
-e_options
"nocheck" --no
-check
-covariance
--no
-check
-attr
-isset
--no
-check
-assert
--no
-check
-autocast
--no
-check
-other
--no
-check
-erasure
-cast
292 bench_nitg
-e_options
"faster" --inline
-coloring
-numbers
294 function bench_engines
()
297 skip_test
"$name" && return
298 prepare_res
"$name-nitg-g.dat" "nitg-g" "nitg with --global"
299 run_compiler
"nitg-g" .
/nitg
--global
300 prepare_res
"$name-nitg-s.dat" "nitg-s" "nitg with --separate"
301 run_compiler
"nitg-s" .
/nitg
--separate
302 prepare_res
"$name-nitg-e.dat" "nitg-e" "nitg with --erasure"
303 run_compiler
"nitg-e" .
/nitg
--erasure
308 function bench_nitg
-e_gc
()
311 skip_test
"$name" && return
312 prepare_res
"$name-nitg-e-malloc.dat" "nitg-e-malloc" "nitg with --erasure and malloc"
313 NIT_GC_OPTION
="malloc" run_compiler
"nitg-e-malloc" .
/nitg
--erasure
314 prepare_res
"$name-nitg-e.dat" "nitg-e" "nitg with --erasure"
315 run_compiler
"nitg-e" .
/nitg
--erasure
320 function bench_cc_nitg
-e
()
323 skip_test
"$name" && return
324 for o
in "gcc0:CC=\"ccache gcc\" CFLAGS=-O0" "cl0:CC=\"ccache clang\" CFLAGS=-O0" "gccs:CC=\"ccache gcc\" CFLAGS=-Os" "cls:CC=\"ccache clang\" CFLAGS=-Os" "gcc2:CC=\"ccache gcc\" CFLAGS=-O2" "cl2:CC=\"ccache clang\" CFLAGS=-O2" "gcc3:CC=\"ccache gcc\" CFLAGS=-O3" "cl3:CC=\"ccache clang\" CFLAGS=-O3"; do
325 f
=`echo "$o" | cut -f1 -d:`
326 o
=`echo "$o" | cut -f2 -d:`
327 prepare_res
"$name-nitg-e-$f.dat" "nitg-e-$f" "nitg with --erasure --make-flags $o"
328 run_compiler
"nitg-e-$f" .
/nitg
--erasure
--make-flags
"$o"
334 function bench_policy
()
337 skip_test
"$name" && return
338 prepare_res
"$name-nitg-s.dat" "nitg-s" "nitg with --separate"
339 run_compiler
"nitg-s" .
/nitg
--separate
340 prepare_res
"$name-nitg-e.dat" "nitg-e" "nitg with --erasure"
341 run_compiler
"nitg-e" .
/nitg
--erasure
342 prepare_res
"$name-nitg-su.dat" "nitg-su" "nitg with --separate --no-check-covariance"
343 run_compiler
"nitg-su" .
/nitg
--separate
--no
-check
-covariance
344 prepare_res
"$name-nitg-eu.dat" "nitg-eu" "nitg with --erasure --no-check-covariance --no-check-erasure-cast"
345 run_compiler
"nitg-eu" .
/nitg
--erasure
--no
-check
-covariance
--no
-check
-erasure
-cast
350 function bench_nullables
()
353 skip_test
"$name" && return
354 prepare_res
"$name-nitc.dat" "nitc" "nitc no options"
355 run_compiler
"nitc" .
/nitg
--separate
356 prepare_res
"$name-nitc-ni.dat" "nitc-ni" "nitc --no-check-attr-isset"
357 run_compiler
"nitc" .
/nitg
--separate
--no
-check
-attr
-isset
358 prepare_res
"$name-nitc-nu.dat" "nitc-nu" "nitc --no-union-attribute"
359 run_compiler
"nitc" .
/nitg
--separate
--no
-union
-attribute
360 prepare_res
"$name-nitc-nu-ni.dat" "nitc-nu-ni" "nitc --no-union-attribute --no-check-attr-isset"
361 run_compiler
"nitc" .
/nitg
--separate
--no
-union
-attribute
--no
-check
-attr
-isset
366 function bench_compilation_time
369 skip_test
"$name" && return
370 prepare_res
"$name-nitg-g.dat" "nitg-g" "nitg --global"
371 for i
in ..
/examples
/hello_world.nit ..
/src
/test_parser.nit ..
/src
/nitg.nit
; do
372 bench_command
`basename "$i" .nit` "" .
/nitg
--global
"$i" --no
-cc
374 prepare_res
"$name-nitg-s.dat" "nitg-s" "nitg --separate"
375 for i
in ..
/examples
/hello_world.nit ..
/src
/test_parser.nit ..
/src
/nitg.nit
; do
376 bench_command
`basename "$i" .nit` "" .
/nitg
--separate
"$i" --no
-cc
378 prepare_res
"$name-nitg-e.dat" "nitg-e" "nitg --erasure"
379 for i
in ..
/examples
/hello_world.nit ..
/src
/test_parser.nit ..
/src
/nitg.nit
; do
380 bench_command
`basename "$i" .nit` "" .
/nitg
--erasure
"$i" --no
-cc
384 bench_compilation_time
386 if test -n
"$html"; then
387 echo >>"$html" "</body></html>"
390 if test -n
"$died"; then
391 echo "Some commands failed"