Simplify testing symbol sections

While fixing some bugs in __attribute__((section)), I found it difficult
to write tests. Make testing easier: introduce the
scan-assembler-symbol-section and scan-symbol-section helpers. See
in-line documentation for details.

Testing:

* Run `make check` on x86_64-linux-gnu with --disable-multilib
  --enable-checking=release --enable-languages=c,c++. Observe no new
  failures in test results.
* Run `make check` on macOS x86_64-apple-darwin16.7.0 with
  --disable-multilib --enable-checking=release --enable-languages=c,c++.
  Observe no new failures in test results.
* Run test-framework.exp with CHECK_TEST_FRAMEWORK=1, and post-process
  results with test-framework.awk. Observe no new failures test
  results.

2019-11-12  Matthew Glazar <strager.nds@gmail.com>

* gcc/testsuite/lib/scanasm.exp (dg-scan): Extract file globbing
code ...
(dg_glob_remote): ... into this new procedure.
(scan-assembler-symbol-section): Define.
(scan-symbol-section): Define.
---
 gcc/testsuite/g++.dg/gomp/tls-5.C             |   2 +
 gcc/testsuite/g++.dg/opt/const4.C             |   3 +-
 gcc/testsuite/gcc.dg/20021029-1.c             |   1 +
 gcc/testsuite/gcc.dg/array-quals-1.c          |  20 ++
 gcc/testsuite/gcc.dg/darwin-sections.c        |   2 +
 gcc/testsuite/gcc.dg/pr25376.c                |   1 +
 .../dg-scan-symbol-section-1-exp-F.S          |  13 ++
 .../dg-scan-symbol-section-2-exp-F.S          |   9 +
 .../dg-scan-symbol-section-3-exp-F.S          |  10 +
 .../dg-scan-symbol-section-exp-P.S            |  50 +++++
 .../gcc.test-framework/test-framework.exp     |   3 +-
 gcc/testsuite/lib/scanasm.exp                 | 184 +++++++++++++++++-
 12 files changed, 292 insertions(+), 6 deletions(-)
 create mode 100644
gcc/testsuite/gcc.test-framework/dg-scan-symbol-section-1-exp-F.S
 create mode 100644
gcc/testsuite/gcc.test-framework/dg-scan-symbol-section-2-exp-F.S
 create mode 100644
gcc/testsuite/gcc.test-framework/dg-scan-symbol-section-3-exp-F.S
 create mode 100644
gcc/testsuite/gcc.test-framework/dg-scan-symbol-section-exp-P.S

     unresolved "$testcase $name $printable_pattern"
@@ -73,6 +70,13 @@ proc dg-scan { name positive testcase output_file
orig_args } {
     }
 }

+proc dg_glob_remote { file_pattern } {
+    if { [is_remote host] } {
+    remote_upload host $file_pattern
+    }
+    return [glob -nocomplain $file_pattern]
+}
+
 # Look for a pattern in the .s file produced by the compiler.  See
 # dg-scan for details.

@@ -155,6 +159,178 @@ proc scan-not-hidden { args } {
     dg-scan "scan-not-hidden" 0 $testcase $output_file $args
 }

+# Check that symbols are emitted in the desired section.
+# Like scan-symbol-section, but using the assembly output generated by
+# the compiler.
+#
+# Example:
+#
+# // All numbered functions (func1, func2, etc.) must be in the .text
section or
+# // in a .text sub-section (like .text._func1).
+# { dg-final { scan-assembler-symbol-section {^_func[1-5]$} {^\.text($|\.)} } }
+
+proc scan-assembler-symbol-section { args } {
+    set testcase [testname-for-summary]
+    set filename [lindex $testcase 0]
+    set output_file "[file rootname [file tail $filename]].s"
+    set symbol_pattern [lindex $args 0]
+    set expected_section_pattern [lindex $args 1]
+    dg-scan-symbol-section \
+    "scan-assembler-symbol-section" \
+    $testcase \
+    $output_file \
+    $symbol_pattern \
+    $expected_section_pattern
+}
+
+# Check that symbols are emitted in the desired section.
+#
+# Symbols and sections are interpreted as regexp patterns.
+#
+# If no matching symbol is found, scan-symbol-section reports a FAILure.
+#
+# Usage:
+#
+# { dg-final { scan-symbol-section FILENAME SYMBOL SECTION } }
+#
+# Examples:
+#
+# // The my_var C symbol must be in the .data section (or in a
.data._my_var section
+# // if -ffunction-sections is in use).
+# { dg-final { scan-symbol-section "my-test.s" {^_my_var$}
{^\.data(\._my_var)?$} } }
+#
+# // All numbered functions (func1, func2, etc.) must be in the .text section
+# // (and not in any other section like .text._func1).
+# { dg-final { scan-symbol-section "my-test.s" {^_func[1-5]$} {^\.text$} } }
+#
+# Caveats:
+#
+# * Only ELF and Mach-O targets are supported. Other
+#   targets, like PE/COFF, might appear to work.
+# * For Mach-O targets, the section name matched by scan-symbol-section has one
+#   of two forms:
+#   * The Mach-O segment name followed by a comma (',') followed by the Mach-O
+#     section name. For example, "__TEXT,__text". (There is no whitespace
+#     between the Mach-O segment name and the Mach-O section name.)
+#   * ".const", ".data", or ".text". For example, the .text assembler directive
+#     causes the section name to be ".text" (not "__TEXT,__text"). (However, a
+#     directive such as .section __TEXT,__text will cause the section
name to be
+#     "__TEXT,__text".)
+# * Because scan-symbol-section parses assembly code, scan-symbol-section is
+#   unaware of section rewriting performed by the linker. For example, the
+#   sections .text._f1 and .text._f2 would normally be merged by binutils'
+#   linker into one section called .text, but scan-symbol-section reports the
+#   sections as .text._f1 and .text._f2 (and not .text).
+# * The symbol pattern matches any assembly label, including local labels which
+#   begin with `.L`.
+
+proc scan-symbol-section { args } {
+    set testcase [testname-for-summary]
+    set output_file [lindex $args 0]
+    set symbol_pattern [lindex $args 1]
+    set expected_section_pattern [lindex $args 2]
+    dg-scan-symbol-section \
+    "scan-symbol-section" \
+    $testcase \
+    $output_file \
+    $symbol_pattern \
+    $expected_section_pattern
+}
+
+# Check that symbols are emitted in the desired section.
+#
+# Avoid calling this function directly. In tests, use scan-symbol-section,
+# scan-assembler-symbol-section, or scan-lto-assembler-symbol-section instead.
+
+proc dg-scan-symbol-section { name testcase output_file
symbol_pattern expected_section_pattern } {
+    set printable_symbol_pattern [make_pattern_printable $symbol_pattern]
+    set printable_expected_section_pattern [make_pattern_printable
$expected_section_pattern]
+
+    set files [dg_glob_remote $output_file]
+    if { $files == "" } {
+    verbose -log "$testcase: output file does not exist"
+    unresolved "$testcase $name symbol $printable_symbol_pattern has
section $printable_expected_section_pattern"
+    return
+    }
+
+    parse_section_of_symbols $output_file section_by_symbol
+
+    set found_symbol 0
+    foreach symbol_name [lsort [array names section_by_symbol]] {
+        if { [regexp -- $symbol_pattern $symbol_name] } {
+            set section $section_by_symbol($symbol_name)
+            set description "$testcase $name symbol
$printable_symbol_pattern (found $symbol_name) has section
$printable_expected_section_pattern"
+            if { $section == "" } {
+                fail "$description (no section detected)"
+            } else {
+                set description "$description (found $section)"
+                if { [regexp -- $expected_section_pattern $section] } {
+                    pass $description
+                } else {
+                    fail $description
+                }
+            }
+            set found_symbol 1
+        }
+    }
+    if { ! $found_symbol } {
+        fail "$testcase $name symbol $printable_symbol_pattern
(symbol not found) has section $printable_expected_section_pattern"
+    }
+}
+
+# Extract a symbol and section names from pre-processed assembly source code.
+#
+# This function adds entries in the RESULT array where the key is the symbol's
+# name (including any leading underscores) and the value is the section's name
+# (including any leading periods).
+#
+# For example, given the following assembly source code in file.s:
+#
+#         .text
+#         .function _my_function
+# _my_function:
+#         nop
+#         .data
+# _my_data:
+#         .long 42
+#
+# Executing 'parse_section_of_symbols "file.s" symbols' would have the same
+# effect as the following code:
+#
+# set $result(_my_function) .text
+# set $result(_my_data) .data
+
+proc parse_section_of_symbols { filename result } {
+    upvar $result up_result
+
+    set section_pattern {^\s*(?:\.section\s+(.*)|(\.const|\.data|\.text)\s*)$}
+    set label_pattern {^(\S+):$}
+
+    set fd [open $filename r]
+    set current_section ""
+    while { [gets $fd line] >= 0 } {
+        if { [regexp -- $label_pattern $line dummy symbol_name] } {
+            set up_result($symbol_name) $current_section
+        } elseif { [regexp -- $section_pattern $line dummy
section_directive_arguments full_section_directive] } {
+            if { $full_section_directive eq "" } {
+                # Example: .section .text,"ax",progbits
+                # Example: .section __TEXT,__text
+                set arguments [split $section_directive_arguments ","]
+                set current_section [string trim [lindex $arguments 0]]
+                set arg_1 [string trim [lindex $arguments 1]]
+                if { [regexp {^_} $arg_1] } {
+                    # The second argument looks like a Mach-O section name.
+                    set current_section "$current_section,$arg_1"
+                }
+            } else {
+                # Example: .text
+                set current_section "$full_section_directive"
+            }
+        }
+    }
+    close $fd
+}
+
 # Look for a pattern in OUTPUT_FILE.  See dg-scan for details.

 proc scan-file { output_file args } {


Message ID	CAC-ggsEmdWw4bcbm+_3CpS2a_CGnU_cCzw8u2_eoEWcitgStzg@mail.gmail.com
State	New
Headers	show Return-Path: <gcc-patches-return-514270-incoming=patchwork.ozlabs.org@gcc.gnu.org> DomainKey-Signature: a=rsa-sha1; c=nofws; d=gcc.gnu.org; h=list-id :list-unsubscribe:list-archive:list-post:list-help:sender :mime-version:from:date:message-id:subject:to:content-type; q= dns; s=default; b=Z/CYsAy/hjToZUZdDKPQ+jAHPqkTz3jWxUk3BW/mz+R6Su J1om5xv+XBUPiwVa8tqxqYJiDWxvtu6sU0XPrsvmXLJIp7kx/jEYpjza2YUFfmWb 9LnBuPXxRW4DORvA11KFrBEuWjHvecOZeFHqIfb+WqEn8AKs8zaSyFFgFN93U= Mailing-List: contact gcc-patches-help@gcc.gnu.org; run by ezmlm Precedence: bulk Sender: gcc-patches-owner@gcc.gnu.org MIME-Version: 1.0 From: Strager Neds <strager.nds@gmail.com> Date: Wed, 20 Nov 2019 22:08:10 -0800 Message-ID: <CAC-ggsEmdWw4bcbm+_3CpS2a_CGnU_cCzw8u2_eoEWcitgStzg@mail.gmail.com> Subject: [PATCH] Simplify testing symbol sections To: gcc-patches@gcc.gnu.org Content-Type: text/plain; charset="UTF-8"
Series	Simplify testing symbol sections \| expand Simplify testing symbol sections

Simplify testing symbol sections

Commit Message

Comments

Patch