Add effective target stack_size
[official-gcc.git] / gcc / testsuite / lib / profopt.exp
blob6519c44ce333ab0ff2c4330403d3b86b2aac84ca
1 # Copyright (C) 2001-2017 Free Software Foundation, Inc.
3 # This program is free software; you can redistribute it and/or modify
4 # it under the terms of the GNU General Public License as published by
5 # the Free Software Foundation; either version 3 of the License, or
6 # (at your option) any later version.
7 #
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # GNU General Public License for more details.
13 # You should have received a copy of the GNU General Public License
14 # along with GCC; see the file COPYING3. If not see
15 # <http://www.gnu.org/licenses/>.
17 # This script was submitted by Janis Johnson <janis187@us.ibm.com>.
19 # Test the functionality and optionally, performance improvement, of
20 # programs compiled with profile-directed optimizations. Compile and
21 # run a test with profile options, compile it with options using the
22 # profile feedback, and then run the test again. Optionally compile
23 # and run a third time without the profile-directed optimization and
24 # compare timing results of the program with normal optimization and
25 # with the profile-directed optimization. Each test is run using
26 # multiple sets of optimization and/or code generation options in
27 # addition to the profiling and feedback options.
29 # If perf_ext is defined and the performance value for the
30 # profile-directed test run is nonzero then the performance check will
31 # be done.
33 load_lib dg.exp
34 load_lib gcc-dg.exp
36 global PROFOPT_OPTIONS perf_delta
38 # The including .exp file must define these.
39 global tool profile_option feedback_option prof_ext profile_wrapper
40 if ![info exists tool] {
41 error "Tools is not specified."
43 if ![info exists prof_ext] {
44 error "No profile data file extensions specified."
47 # The maximum perforance degradation can be defined in the including file.
48 if ![info exists perf_delta] {
49 set perf_delta 4
52 # The default option list can be overridden by
53 # PROFOPT_OPTIONS="{ { list1 } ... { list2 } }"
55 if ![info exists PROFOPT_OPTIONS] {
56 set PROFOPT_OPTIONS [list \
57 { -g } \
58 { -O0 } \
59 { -O1 } \
60 { -O2 } \
61 { -O3 } \
62 { -O3 -g } \
63 { -Os } ]
67 # profopt-cleanup -- remove profiling or performance results files.
69 # TESTCASE is the name of the test
70 # EXT is the extensions of files to remove
72 proc profopt-cleanup { testcase extlist } {
73 set basename [file tail $testcase]
74 set base [file rootname $basename]
75 foreach ext $extlist {
76 set files [glob -nocomplain $base.$ext]
77 if { $files != "" } {
78 eval "remote_file build delete $files"
84 # profopt-target-cleanup -- remove profiling result files.
86 # DIR is the name of the directory
87 # TESTCASE is the name of the test
88 # EXT is the extensions of files to remove
90 proc profopt-target-cleanup { dir testcase ext } {
91 global additional_sources_used
92 set basename [file tail $testcase]
93 set base [file rootname $basename]
94 set file "$dir/$base.$ext"
95 eval "remote_file target delete $file"
97 if [info exists additional_sources_used] {
98 foreach srcfile $additional_sources_used {
99 set basename [file tail $srcfile]
100 set base [file rootname $basename]
101 set file "$dir/$base.$ext"
102 eval "remote_file target delete $file"
108 # profopt-perf-value -- get performance value for a test
110 # TESTCASE is the name of the test
111 # PERF_EXT is the extension of the performance result file
112 # OPTSTR is the string of compiler options
114 proc profopt-perf-value { testcase perf_ext optstr } {
115 set basename [file tail $testcase]
116 set base [file rootname $basename]
117 set files [glob -nocomplain $base.$perf_ext]
118 # The file doesn't exist; let the caller decide if that's a problem.
119 if { $files == "" } {
120 return -2
122 remote_upload host $base.$perf_ext $base.$perf_ext
123 set fd [open $base.$perf_ext r]
124 gets $fd line
125 set val -2
126 if [regexp "TIME" $line] {
127 if [regexp "TIME -1" $line] {
128 fail "$testcase perf check: no consistent time available, $optstr"
129 set val -1
130 } elseif ![regexp "(\[0-9\]+)" "$line" val] {
131 set val -2
134 # Report problems with an existing file.
135 if { $val == -2 } {
136 fail "$testcase perf check: file $base.$perf_ext has wrong format, $optstr"
138 close $fd
139 profopt-cleanup $testcase $perf_ext
140 return $val
144 # dg-final-generate -- process code to run after the profile-generate step
146 # ARGS is the line number of the directive followed by the commands.
148 proc dg-final-generate { args } {
149 global generate_final_code
151 if { [llength $args] > 2 } {
152 error "[lindex $args 0]: too many arguments"
153 return
155 append generate_final_code "[lindex $args 1]\n"
159 # dg-final-use -- process code to run after the profile-use step
161 # ARGS is the line number of the directive followed by the commands.
163 proc dg-final-use { args } {
164 global use_final_code
166 if { [llength $args] > 2 } {
167 error "[lindex $args 0]: too many arguments"
168 return
170 append use_final_code "[lindex $args 1]\n"
174 # dg-final-use-not-autofdo -- process code to run after the profile-use step
175 # but only if not running autofdo
176 # ARGS is the line number of the directive followed by the commands.
178 proc dg-final-use-not-autofdo { args } {
179 global use_final_code
180 global run_autofdo
182 if { [llength $args] > 2 } {
183 error "[lindex $args 0]: too many arguments"
184 return
187 if { $run_autofdo == 1 } {
188 return
190 append use_final_code "[lindex $args 1]\n"
194 # dg-final-use-autofdo -- process code to run after the profile-use step
195 # but only if running autofdo
196 # ARGS is the line number of the directive followed by the commands.
199 proc dg-final-use-autofdo { args } {
200 global use_final_code
201 global run_autofdo
203 if { [llength $args] > 2 } {
204 error "[lindex $args 0]: too many arguments"
205 return
208 if { $run_autofdo != 1 } {
209 return
211 append use_final_code "[lindex $args 1]\n"
215 # profopt-final-code -- run final code
217 # WHICH is "generate" or "use".
218 # FINAL_CODE is the TCL code to run.
219 # TESTCASE is the name of the test, for error messages.
221 proc profopt-final-code { which final_code name } {
222 # This is copied from dg-test in dg.exp of DejaGnu.
223 regsub -all "\\\\(\[{}\])" $final_code "\\1" final_code
224 proc profopt-final-proc { args } $final_code
225 if [catch "profopt-final-proc $name" errmsg] {
226 perror "$name: error executing dg-final-${which}: $errmsg"
227 unresolved "$name: Error executing dg-final-${which}: $errmsg"
232 # profopt-get-options -- process test directives
234 # SRC is the full pathname of the testcase.
236 proc profopt-get-options { src } {
237 # dg-options sets a variable called dg-extra-tool-flags.
238 set dg-extra-tool-flags ""
240 # dg-require-* sets dg-do-what.
241 upvar dg-do-what dg-do-what
243 # current_compiler_flags reads tool_flags from the same stack frame
244 # as dg-extra-tool-flags
245 set tool_flags ""
247 set tmp [dg-get-options $src]
248 foreach op $tmp {
249 set cmd [lindex $op 0]
250 if { ![string compare "dg-options" $cmd] \
251 || ![string compare "dg-additional-options" $cmd] \
252 || ![string compare "dg-skip-if" $cmd] \
253 || ![string compare "dg-final-generate" $cmd] \
254 || ![string compare "dg-final-use" $cmd] \
255 || ![string compare "dg-final-use-not-autofdo" $cmd] \
256 || ![string compare "dg-final-use-autofdo" $cmd] \
257 || ![string compare "dg-additional-sources" $cmd] \
258 || [string match "dg-require-*" $cmd] } {
259 set status [catch "$op" errmsg]
260 if { $status != 0 } {
261 perror "$src: $errmsg for \"$op\"\n"
262 unresolved "$src: $errmsg for \"$op\""
263 return
265 } else {
266 # Ignore unrecognized dg- commands, but warn about them.
267 warning "profopt.exp does not support $cmd"
271 # Return flags to use for compiling the primary source file and for
272 # linking.
273 return ${dg-extra-tool-flags}
276 # auto-profopt-execute -- Compile for auto profiling and then feedback,
277 # then normal. SRC is the full path name of the testcase.
278 proc auto-profopt-execute { src } {
279 global profile_wrapper
280 global profile_option
281 global feedback_option
282 global run_autofdo
283 global srcdir
285 if { ! [check_profiling_available "-fauto-profile"] } {
286 regsub "(?q)$srcdir/" $src "" testcase
287 unsupported "$src -fauto-profile"
288 return
290 set profile_wrapper [profopt-perf-wrapper]
291 set profile_option "-g"
292 set feedback_option "-fauto-profile"
293 set run_autofdo 1
294 profopt-execute $src
295 unset profile_wrapper
296 unset profile_option
297 unset feedback_option
298 unset run_autofdo
302 # c-prof-execute -- compile for profiling and then feedback, then normal
304 # SRC is the full pathname of the testcase.
306 proc profopt-execute { src } {
307 global srcdir tmpdir
308 global PROFOPT_OPTIONS
309 global tool profile_option feedback_option prof_ext perf_ext perf_delta
310 global profile_wrapper run_autofdo ld_library_path
311 global generate_final_code use_final_code
312 global verbose
313 global testname_with_flags
315 if ![info exists profile_option] {
316 error "No profile option specified for first compile."
318 if ![info exists feedback_option] {
319 error "No feedback option specified for second compile."
321 if ![info exists profile_wrapper] {
322 set profile_wrapper ""
324 if ![info exists run_autofdo] {
325 set run_autofdo ""
328 # Use the default option list or one defined for a set of tests.
329 if ![info exists PROFOPT_OPTIONS] {
330 error "PROFOPT_OPTIONS is not defined"
332 set prof_option_list $PROFOPT_OPTIONS
334 regsub "(?q)$srcdir/" $src "" testcase
335 # If we couldn't rip $srcdir out of `src' then just do the best we can.
336 # The point is to reduce the unnecessary noise in the logs. Don't strip
337 # out too much because different testcases with the same name can confuse
338 # `test-tool'.
339 if [string match "/*" $testcase] {
340 set testcase "[file tail [file dirname $src]]/[file tail $src]"
343 # Several procedures access the name of the test with torture flags,
344 # normally defined in dg-test. Profile optimization tests don't
345 # use dg-test, so define it here to make it accessible via
346 # testname-for-summary.
347 set testname_with_flags $testcase
349 set executable $tmpdir/[file tail [file rootname $src].x]
350 set basename [file tail $testcase]
351 set base [file rootname $basename]
353 set count 0
354 foreach option $prof_option_list {
355 set execname1 "${executable}${count}1"
356 set execname2 "${executable}${count}2"
357 set execname3 "${executable}${count}3"
358 incr count
360 remote_file build delete $execname1
361 remote_file build delete $execname2
362 remote_file build delete $execname3
363 verbose "Testing $testcase, $option" 1
365 # Remove old performance data files.
366 if [info exists perf_ext] {
367 profopt-cleanup $testcase $perf_ext
370 # Process test directives.
372 set generate_final_code ""
373 set use_final_code ""
374 set dg-do-what [list "run" "" P]
375 set extra_flags [profopt-get-options $src]
376 if { [lindex ${dg-do-what} 1 ] == "N" } {
377 unsupported "$testcase"
378 unset testname_with_flags
379 verbose "$src not supported on this target, skipping it" 3
380 return
383 # schedule removal of dump files et al
384 # Do this before the call below destroys additional_sources..
385 append use_final_code [schedule-cleanups "$option $extra_flags"]
386 set extra_options [dg-additional-files-options "" "$src"]
388 # Remove old profiling data files. Make sure additional_sources_used is
389 # valid, by running it after dg-additional-files-options.
390 foreach ext $prof_ext {
391 profopt-target-cleanup $tmpdir $base $ext
392 profopt-target-cleanup $tmpdir $base "perf.data"
395 # Tree profiling requires TLS runtime support, which may need
396 # additional flags.
397 if { [string first "-fprofile-generate" $profile_option] >= 0 } {
398 set extra_flags [add_options_for_tls $extra_flags]
401 # Compile for profiling.
403 set options "$extra_options"
404 lappend options "additional_flags=$option $extra_flags $profile_option"
405 set optstr "$option $profile_option"
406 set comp_output [${tool}_target_compile "$src" "$execname1" executable $options]
407 if ![${tool}_check_compile "$testcase compilation" $optstr $execname1 $comp_output] {
408 unresolved "$testcase execution, $optstr"
409 unresolved "$testcase compilation, $option $feedback_option"
410 unresolved "$testcase execution, $option $feedback_option"
411 continue
414 # Run the profiled test.
415 if { $run_autofdo == 1 } {
416 if { ![info exists ld_library_path]} {
417 set ld_library_path ""
419 set orig_ld_library_path "[getenv LD_LIBRARY_PATH]"
420 setenv LD_LIBRARY_PATH "$ld_library_path:$orig_ld_library_path"
421 verbose -log "Running $profile_wrapper -o $tmpdir/$base.perf.data $execname1"
422 set id [remote_spawn "" "$profile_wrapper -o $tmpdir/$base.perf.data $execname1" "readonly"]
423 setenv LD_LIBRARY_PATH $orig_ld_library_path
424 if { $id < 0 } {
425 warning "Failed to run profiler"
426 set status "fail"
427 } else {
428 set result [remote_wait "" 300]
429 set status [lindex $result 0]
430 verbose "perf result $result"
431 if { $status == 0 } {
432 set status "pass"
433 } else {
434 set status "fail"
437 } else {
438 set result [${tool}_load $execname1 "" ""]
439 set status [lindex $result 0]
442 set missing_file 0
443 set bprefix ""
444 # Make sure the profile data was generated, and fail if not.
445 if { $status == "pass" } {
446 # convert profile
447 if { $run_autofdo == 1 } {
448 set bprefix "afdo."
449 set cmd "create_gcov --binary $execname1 --profile=$tmpdir/$base.perf.data -gcov_version=1 --gcov=$tmpdir/$bprefix$base.$ext"
450 verbose "Running $cmd"
451 set id [remote_spawn "" $cmd]
452 if { $id < 0 } {
453 unsupported "$src -fauto-profile: cannot run create_gcov"
454 set status "fail"
455 return
457 set status [remote_wait "" 300]
458 set status "pass"
461 foreach ext $prof_ext {
462 remote_upload target $tmpdir/$bprefix$base.$ext
463 set files [glob -nocomplain $bprefix$base.$ext]
464 if { $files == "" } {
465 set status "fail"
466 set missing_file 1
467 fail "$testcase execution: file $bprefix$base.$ext does not exist, $option $profile_option"
471 if { $missing_file == 0 } {
472 $status "$testcase execution, $optstr"
475 # If there is dg-final code to execute for the generate step, do it
476 # even if it failed; it might clean up temporary files.
477 if ![string match $generate_final_code ""] {
478 profopt-final-code "generate" $generate_final_code $testcase
481 remote_file build delete $execname1
483 # Quit for this round if it failed
484 if { $status != "pass" } {
485 unresolved "$testcase compilation, $option $feedback_option"
486 unresolved "$testcase execution, $option $feedback_option"
487 continue
490 # Compile with feedback-directed optimizations.
492 set options "$extra_options"
493 lappend options "additional_flags=$option $extra_flags $feedback_option"
494 set optstr "$option $feedback_option"
495 if { [string first "-fauto-profile" $options] >= 0} {
496 set options [regsub -- "-fauto-profile" $options "-fauto-profile=$tmpdir/$bprefix$base.$ext"]
499 set comp_output [${tool}_target_compile "$src" "$execname2" "executable" $options]
501 # Prune warnings we know are unwanted.
502 set comp_output [prune_warnings $comp_output]
504 if ![${tool}_check_compile "$testcase compilation" $optstr $execname2 $comp_output] {
505 unresolved "$testcase execution, $optstr"
506 continue
509 # Run the profile-directed optimized test.
511 set result [${tool}_load "$execname2" "" ""]
512 set status [lindex $result 0]
513 $status "$testcase execution, $optstr"
515 # If there is dg-final code to execute for the use step, do it.
516 if ![string match $use_final_code ""] {
517 profopt-final-code "use" $use_final_code $testcase
520 # Remove the profiling data files.
521 foreach ext $prof_ext {
522 profopt-target-cleanup $tmpdir "$bprefix$base" $ext
523 profopt-target-cleanup $tmpdir $base "perf.data"
524 profopt-target-cleanup $tmpdir $base "gcda.imports"
527 if { $status != "pass" } {
528 continue
531 # If the test is not expected to produce performance data then
532 # we're done now.
533 if ![info exists perf_ext] {
534 remote_file build delete $execname2
535 continue
538 # Get the performance data from the test built with
539 # profile-directed optimization. If the file doesn't exist or if
540 # the value is zero, skip the performance comparison.
541 set val2 [profopt-perf-value $testcase $perf_ext $optstr]
542 if { $val2 <= 0 } {
543 remote_file build delete $execname2
544 continue
547 # Compile with normal optimizations.
549 set options "$extra_options"
550 lappend options "additional_flags=$option"
551 set optstr "$option"
552 set comp_output [${tool}_target_compile "$src" "$execname3" "executable" $options]
553 if ![${tool}_check_compile "$testcase compilation" $optstr $execname3 $comp_output] {
554 unresolved "$testcase execution, $optstr"
555 unresolved "$testcase perf check, $optstr"
556 continue
559 # Run the test with normal optimizations.
561 set result [${tool}_load "$execname3" "" ""]
562 set status [lindex $result 0]
563 $status "$testcase execution, $optstr"
564 if { $status != "pass" } {
565 unresolved "$testcase perf check, $optstr"
566 continue
569 # Get the performance data from the test built with normal
570 # optimization.
571 set val1 [profopt-perf-value $testcase $perf_ext $optstr]
572 if { $val1 < 0 } {
573 if { $val1 == -2 } {
574 # The data file existed with the profile-directed
575 # optimization so this one should, too.
576 fail "$testcase perf check: file $base.$perf_ext does not exist, $optstr"
578 continue
581 # Compare results of the two runs and fail if the time with the
582 # profile-directed optimization is significantly more than the time
583 # without it.
584 set status "pass"
585 if { $val2 > $val1 } {
586 # Check for a performance degration outside of allowable limits.
587 if { [expr $val2 - $val1] > [expr [expr $val1 * $perf_delta] / 100] } {
588 set status "fail"
591 if { $status == "fail" } {
592 fail "$testcase perf check: orig: $val1 new: $val2, $optstr"
593 } else {
594 $status "$testcase perf check, $optstr"
595 verbose "$testcase orig: $val1 new: $val2, $optstr" 2
596 remote_file build delete $execname2
597 remote_file build delete $execname3
600 unset testname_with_flags