1# Copyright (C) 1997-2018 Free Software Foundation, Inc. 2 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. 12# 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/>. 16 17# DejaGnu's dg-test defines extra flags that are used to compile a test. 18# Access them for directives that need to examine all options that are 19# used for a test, including checks for non-cached effective targets. 20# We don't know how far up the call chain it is but we know we'll hit 21# it eventually, and that we're at least 3 calls down. 22 23proc current_compiler_flags { } { 24 set frames 2 25 while { ![info exists flags1] } { 26 set frames [expr $frames + 1] 27 upvar $frames dg-extra-tool-flags flags1 28 } 29 upvar $frames tool_flags flags2 30 return "$flags1 $flags2" 31} 32 33# DejaGnu's dg-test defines a test name that includes torture options 34# which is used in most pass/fail messages. Grab a copy of it. 35 36proc testname-for-summary { } { 37 global testname_with_flags 38 39 # A variable called "name" is too generic, so identify dg-test by 40 # the existence of dg-extra-tool-flags. 41 if ![info exists testname_with_flags] { 42 set frames 2 43 while { ![info exists flags] } { 44 set frames [expr $frames + 1] 45 upvar $frames dg-extra-tool-flags flags 46 } 47 48 # We've got the stack level for dg-test; get the variable we want. 49 upvar $frames name name 50 set testname_with_flags $name 51 52 # If there are flags, add an extra space to improve readability of 53 # the test summary. 54 if { [llength $testname_with_flags] > 1 } { 55 set testname_with_flags "$testname_with_flags " 56 } 57 } 58 return "$testname_with_flags" 59} 60 61# If this target does not support weak symbols, skip this test. 62 63proc dg-require-weak { args } { 64 set weak_available [ check_weak_available ] 65 if { $weak_available == -1 } { 66 upvar name name 67 unresolved "$name" 68 } 69 if { $weak_available != 1 } { 70 upvar dg-do-what dg-do-what 71 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 72 } 73} 74 75# If this target does not support overriding weak symbols, skip this 76# test. 77 78proc dg-require-weak-override { args } { 79 set weak_override_available [ check_weak_override_available ] 80 if { $weak_override_available == -1 } { 81 upvar name name 82 unresolved "$name" 83 } 84 if { $weak_override_available != 1 } { 85 upvar dg-do-what dg-do-what 86 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 87 } 88} 89 90# If this target does not support the "visibility" attribute, skip this 91# test. 92 93proc dg-require-visibility { args } { 94 set visibility_available [ check_visibility_available [lindex $args 1 ] ] 95 if { $visibility_available == -1 } { 96 upvar name name 97 unresolved "$name" 98 } 99 if { $visibility_available != 1 } { 100 upvar dg-do-what dg-do-what 101 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 102 } 103} 104 105# If this target does not support the "alias" attribute, skip this 106# test. 107 108proc dg-require-alias { args } { 109 set alias_available [ check_alias_available ] 110 if { $alias_available == -1 } { 111 upvar name name 112 unresolved "$name" 113 } 114 if { $alias_available < 2 } { 115 upvar dg-do-what dg-do-what 116 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 117 } 118} 119 120# If this target does not support the "ifunc" attribute, skip this 121# test. 122 123proc dg-require-ifunc { args } { 124 if { ![ check_ifunc_available ] } { 125 upvar dg-do-what dg-do-what 126 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 127 } 128} 129 130# If this target's linker does not support the --gc-sections flag, 131# skip this test. 132 133proc dg-require-gc-sections { args } { 134 if { ![ check_gc_sections_available ] } { 135 upvar dg-do-what dg-do-what 136 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 137 } 138} 139 140# If this target does not support profiling, skip this test. 141 142proc dg-require-profiling { args } { 143 if { ![ check_profiling_available [lindex $args 1] ] } { 144 upvar dg-do-what dg-do-what 145 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 146 } 147} 148 149# If this target does not support DLL attributes skip this test. 150 151proc dg-require-dll { args } { 152 # As a special case, the mcore-*-elf supports these attributes. 153 # All Symbian OS targets also support these attributes. 154 if { [istarget mcore-*-elf] 155 || [istarget *-*-symbianelf] } { 156 return 157 } 158 # PE/COFF targets support dllimport/dllexport. 159 if { [gcc_target_object_format] == "pe" } { 160 return 161 } 162 163 upvar dg-do-what dg-do-what 164 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 165} 166 167# If this host does not support an ASCII locale, skip this test. 168 169proc dg-require-ascii-locale { args } { 170 if { ![ check_ascii_locale_available] } { 171 upvar dg-do-what dg-do-what 172 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 173 } 174} 175 176proc dg-require-iconv { args } { 177 if { ![ check_iconv_available ${args} ] } { 178 upvar dg-do-what dg-do-what 179 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 180 } 181} 182 183# If this target does not have sufficient stack size, skip this test. 184 185proc dg-require-stack-size { args } { 186 if { ![is-effective-target stack_size] } { 187 return 188 } 189 190 set stack_size [dg-effective-target-value stack_size] 191 set required [expr [lindex $args 1]] 192 if { $stack_size < $required } { 193 upvar dg-do-what dg-do-what 194 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 195 } 196} 197 198# If this target does not support named sections skip this test. 199 200proc dg-require-named-sections { args } { 201 if { ![ check_named_sections_available ] } { 202 upvar dg-do-what dg-do-what 203 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 204 } 205} 206 207# If the target does not match the required effective target, skip this test. 208# Only apply this if the optional selector matches. 209 210proc dg-require-effective-target { args } { 211 set args [lreplace $args 0 0] 212 # Verify the number of arguments. The last is optional. 213 if { [llength $args] < 1 || [llength $args] > 2 } { 214 error "syntax error, need a single effective-target keyword with optional selector" 215 } 216 217 # Don't bother if we're already skipping the test. 218 upvar dg-do-what dg-do-what 219 if { [lindex ${dg-do-what} 1] == "N" } { 220 return 221 } 222 223 # Evaluate selector if present. 224 if { [llength $args] == 2 } { 225 switch [dg-process-target-1 [lindex $args 1]] { 226 "S" { } 227 "N" { return } 228 } 229 } 230 231 if { ![is-effective-target [lindex $args 0]] } { 232 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 233 } 234} 235 236# If this target does not have fork, skip this test. 237 238proc dg-require-fork { args } { 239 if { ![check_fork_available] } { 240 upvar dg-do-what dg-do-what 241 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 242 } 243} 244 245# If this target does not have mkfifo, skip this test. 246 247proc dg-require-mkfifo { args } { 248 if { ![check_mkfifo_available] } { 249 upvar dg-do-what dg-do-what 250 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 251 } 252} 253 254# If this target does not use __cxa_atexit, skip this test. 255 256proc dg-require-cxa-atexit { args } { 257 if { ![ check_cxa_atexit_available ] } { 258 upvar dg-do-what dg-do-what 259 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 260 } 261} 262 263# If the host is remote rather than the same as the build system, skip 264# this test. Some tests are incompatible with DejaGnu's handling of 265# remote hosts, which involves copying the source file to the host and 266# compiling it with a relative path and "-o a.out". 267 268proc dg-require-host-local { args } { 269 if [ is_remote host ] { 270 upvar dg-do-what dg-do-what 271 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 272 } 273} 274 275proc dg-require-linker-plugin { args } { 276 set linker_plugin_available [ check_linker_plugin_available ] 277 if { $linker_plugin_available == 0 } { 278 upvar dg-do-what dg-do-what 279 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 280 } 281} 282 283# If this target does not support the "stack-check" option, skip this 284# test. 285 286proc dg-require-stack-check { args } { 287 set stack_check_available [ check_stack_check_available [lindex $args 1 ] ] 288 if { $stack_check_available == -1 } { 289 upvar name name 290 unresolved "$name" 291 } 292 if { $stack_check_available != 1 } { 293 upvar dg-do-what dg-do-what 294 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 295 } 296} 297 298# Add any target-specific flags needed for accessing the given list 299# of features. This must come after all dg-options. 300 301proc dg-add-options { args } { 302 upvar dg-extra-tool-flags extra-tool-flags 303 304 foreach arg [lrange $args 1 end] { 305 if { [info procs add_options_for_$arg] != "" } { 306 set extra-tool-flags \ 307 [eval [list add_options_for_$arg ${extra-tool-flags}]] 308 } else { 309 error "Unrecognized option type: $arg" 310 } 311 } 312} 313 314# Compare flags for a test directive against flags that will be used to 315# compile the test: multilib flags, flags for torture options, and either 316# the default flags for this group of tests or flags specified with a 317# previous dg-options directive. 318 319proc check-flags { args } { 320 global compiler_flags 321 global TOOL_OPTIONS 322 global TEST_ALWAYS_FLAGS 323 324 # The args are within another list; pull them out. 325 set args [lindex $args 0] 326 327 # Start the list with a dummy tool name so the list will match "*" 328 # if there are no flags. 329 set compiler_flags " toolname " 330 append compiler_flags [current_compiler_flags] 331 # If running a subset of the test suite, $TOOL_OPTIONS may not exist. 332 catch {append compiler_flags " $TOOL_OPTIONS "} 333 # If running a subset of the test suite, $TEST_ALWAYS_FLAGS may not exist. 334 catch {append compiler_flags " $TEST_ALWAYS_FLAGS "} 335 set dest [target_info name] 336 if [board_info $dest exists cflags] { 337 append compiler_flags "[board_info $dest cflags] " 338 } 339 if [board_info $dest exists multilib_flags] { 340 append compiler_flags "[board_info $dest multilib_flags] " 341 } 342 343 # The next two arguments are optional. If they were not specified, 344 # use the defaults. 345 if { [llength $args] == 2 } { 346 lappend $args [list "*"] 347 } 348 if { [llength $args] == 3 } { 349 lappend $args [list ""] 350 } 351 352 # If the option strings are the defaults, or the same as the 353 # defaults, there is no need to call check_conditional_xfail to 354 # compare them to the actual options. 355 if { [string compare [lindex $args 2] "*"] == 0 356 && [string compare [lindex $args 3] "" ] == 0 } { 357 set result 1 358 } else { 359 # The target list might be an effective-target keyword, so replace 360 # the original list with "*-*-*", since we already know it matches. 361 set result [check_conditional_xfail [lreplace $args 1 1 "*-*-*"]] 362 } 363 364 # Any value in this variable was left over from an earlier test. 365 set compiler_flags "" 366 367 return $result 368} 369 370# Skip the test (report it as UNSUPPORTED) if the target list and 371# included flags are matched and the excluded flags are not matched. 372# 373# The first argument is the line number of the dg-skip-if directive 374# within the test file. Remaining arguments are as for xfail lists: 375# message { targets } { include } { exclude } 376# 377# This tests against multilib flags plus either the default flags for this 378# group of tests or flags specified with a previous dg-options command. 379 380proc dg-skip-if { args } { 381 # Verify the number of arguments. The last two are optional. 382 set args [lreplace $args 0 0] 383 if { [llength $args] < 2 || [llength $args] > 4 } { 384 error "dg-skip-if 2: need 2, 3, or 4 arguments" 385 } 386 387 # Don't bother if we're already skipping the test. 388 upvar dg-do-what dg-do-what 389 if { [lindex ${dg-do-what} 1] == "N" } { 390 return 391 } 392 393 set selector [list target [lindex $args 1]] 394 if { [dg-process-target-1 $selector] == "S" } { 395 if [check-flags $args] { 396 upvar dg-do-what dg-do-what 397 set dg-do-what [list [lindex ${dg-do-what} 0] "N" "P"] 398 } 399 } 400} 401 402# Like check_conditional_xfail, but callable from a dg test. 403 404proc dg-xfail-if { args } { 405 # Verify the number of arguments. The last three are optional. 406 set args [lreplace $args 0 0] 407 if { [llength $args] < 2 || [llength $args] > 4 } { 408 error "dg-xfail-if: need 2, 3, or 4 arguments" 409 } 410 411 # Don't change anything if we're already skipping the test. 412 upvar dg-do-what dg-do-what 413 if { [lindex ${dg-do-what} 1] == "N" } { 414 return 415 } 416 417 set selector [list target [lindex $args 1]] 418 if { [dg-process-target-1 $selector] == "S" } { 419 global compiler_conditional_xfail_data 420 421 # The target list might be an effective-target keyword. Replace 422 # the original list with "*-*-*", since we already know it matches. 423 set args [lreplace $args 1 1 "*-*-*"] 424 425 # Supply default values for unspecified optional arguments. 426 if { [llength $args] == 2 } { 427 lappend $args [list "*"] 428 } 429 if { [llength $args] == 3 } { 430 lappend $args [list ""] 431 } 432 433 set compiler_conditional_xfail_data $args 434 } 435} 436 437# Like dg-xfail-if but for the execute step. 438 439proc dg-xfail-run-if { args } { 440 # Verify the number of arguments. The last two are optional. 441 set args [lreplace $args 0 0] 442 if { [llength $args] < 2 || [llength $args] > 4 } { 443 error "dg-xfail-run-if: need 2, 3, or 4 arguments" 444 } 445 446 # Don't bother if we're already skipping the test. 447 upvar dg-do-what dg-do-what 448 if { [lindex ${dg-do-what} 1] == "N" } { 449 return 450 } 451 452 set selector [list target [lindex $args 1]] 453 if { [dg-process-target-1 $selector] == "S" } { 454 if [check-flags $args] { 455 upvar dg-do-what dg-do-what 456 set dg-do-what [list [lindex ${dg-do-what} 0] "S" "F"] 457 } 458 } 459} 460 461# Record whether the program is expected to return a nonzero status. 462 463set shouldfail 0 464 465proc dg-shouldfail { args } { 466 # Don't bother if we're already skipping the test. 467 upvar dg-do-what dg-do-what 468 if { [lindex ${dg-do-what} 1] == "N" } { 469 return 470 } 471 472 global shouldfail 473 474 set args [lreplace $args 0 0] 475 if { [llength $args] > 1 } { 476 set selector [list target [lindex $args 1]] 477 if { [dg-process-target-1 $selector] == "S" } { 478 # The target matches, now check the flags. 479 if [check-flags $args] { 480 set shouldfail 1 481 } 482 } 483 } else { 484 set shouldfail 1 485 } 486} 487 488# Intercept the call to the DejaGnu version of dg-process-target to 489# support use of an effective-target keyword in place of a list of 490# target triplets to xfail or skip a test. 491# 492# The argument to dg-process-target is the keyword "target" or "xfail" 493# followed by a selector: 494# target-triplet-1 ... 495# effective-target-keyword 496# selector-expression 497# 498# For a target list the result is "S" if the target is selected, "N" otherwise. 499# For an xfail list the result is "F" if the target is affected, "P" otherwise. 500 501# In contexts that allow either "target" or "xfail" the argument can be 502# target selector1 xfail selector2 503# which returns "N" if selector1 is not selected, otherwise the result of 504# "xfail selector2". 505# 506# A selector expression appears within curly braces and uses a single logical 507# operator: !, &&, or ||. An operand is another selector expression, an 508# effective-target keyword, or a list of target triplets within quotes or 509# curly braces. 510 511if { [info procs saved-dg-process-target] == [list] } { 512 rename dg-process-target saved-dg-process-target 513 514 # Evaluate an operand within a selector expression. 515 proc selector_opd { op } { 516 set selector "target" 517 lappend selector $op 518 set answer [ expr { [dg-process-target $selector] == "S" } ] 519 verbose "selector_opd: `$op' $answer" 2 520 return $answer 521 } 522 523 # Evaluate a target triplet list within a selector expression. 524 # Unlike other operands, this needs to be expanded from a list to 525 # the same string as "target". 526 proc selector_list { op } { 527 set selector "target [join $op]" 528 set answer [ expr { [dg-process-target $selector] == "S" } ] 529 verbose "selector_list: `$op' $answer" 2 530 return $answer 531 } 532 533 # Evaluate a selector expression. 534 proc selector_expression { exp } { 535 if { [llength $exp] == 2 } { 536 if [string match "!" [lindex $exp 0]] { 537 set op1 [lindex $exp 1] 538 set answer [expr { ! [selector_opd $op1] }] 539 } else { 540 # Assume it's a list of target triplets. 541 set answer [selector_list $exp] 542 } 543 } elseif { [llength $exp] == 3 } { 544 set op1 [lindex $exp 0] 545 set opr [lindex $exp 1] 546 set op2 [lindex $exp 2] 547 if [string match "&&" $opr] { 548 set answer [expr { [selector_opd $op1] && [selector_opd $op2] }] 549 } elseif [string match "||" $opr] { 550 set answer [expr { [selector_opd $op1] || [selector_opd $op2] }] 551 } else { 552 # Assume it's a list of target triplets. 553 set answer [selector_list $exp] 554 } 555 } else { 556 # Assume it's a list of target triplets. 557 set answer [selector_list $exp] 558 } 559 560 verbose "selector_expression: `$exp' $answer" 2 561 return $answer 562 } 563 564 # Evaluate "target selector" or "xfail selector". 565 566 proc dg-process-target-1 { args } { 567 verbose "dg-process-target-1: `$args'" 2 568 569 # Extract the 'what' keyword from the argument list. 570 set selector [string trim [lindex $args 0]] 571 if [regexp "^xfail " $selector] { 572 set what "xfail" 573 } elseif [regexp "^target " $selector] { 574 set what "target" 575 } else { 576 error "syntax error in target selector \"$selector\"" 577 } 578 579 # Extract the rest of the list, which might be a keyword. 580 regsub "^${what}" $selector "" rest 581 set rest [string trim $rest] 582 583 if [is-effective-target-keyword $rest] { 584 # The selector is an effective target keyword. 585 if [is-effective-target $rest] { 586 return [expr { $what == "xfail" ? "F" : "S" }] 587 } else { 588 return [expr { $what == "xfail" ? "P" : "N" }] 589 } 590 } 591 592 if [string match "{*}" $rest] { 593 if [selector_expression [lindex $rest 0]] { 594 return [expr { $what == "xfail" ? "F" : "S" }] 595 } else { 596 return [expr { $what == "xfail" ? "P" : "N" }] 597 } 598 } 599 600 # The selector is not an effective-target keyword, so process 601 # the list of target triplets. 602 return [saved-dg-process-target $selector] 603 } 604 605 # Intercept calls to the DejaGnu function. In addition to 606 # processing "target selector" or "xfail selector", handle 607 # "target selector1 xfail selector2". 608 609 proc dg-process-target { args } { 610 verbose "replacement dg-process-target: `$args'" 2 611 612 set selector [string trim [lindex $args 0]] 613 614 # If the argument list contains both 'target' and 'xfail', 615 # process 'target' and, if that succeeds, process 'xfail'. 616 if [regexp "^target .* xfail .*" $selector] { 617 set xfail_index [string first "xfail" $selector] 618 set xfail_selector [string range $selector $xfail_index end] 619 set target_selector [string range $selector 0 [expr $xfail_index-1]] 620 set target_selector [string trim $target_selector] 621 if { [dg-process-target-1 $target_selector] == "N" } { 622 return "N" 623 } 624 return [dg-process-target-1 $xfail_selector] 625 626 } 627 return [dg-process-target-1 $selector] 628 } 629} 630