[llvm-dwarfdump][test] Add missing dedicated tests for some options

[gbreynoo]

Summary

This change adds tests specifically for --parent-recurse-depth, --quiet and -o. The test for -o found a typo in an error message which is also fixed in this change.

[Higuoxing]

llvm/test/tools/llvm-dwarfdump/X86/output.s

5

It looks that you have some typos in this test file which are causing testing failures.

8

Ditto.

12

Ditto.

llvm/test/tools/llvm-dwarfdump/X86/parent_recurse_depth.s

23

I think the following yaml code is more readable than raw assembly code. What do you think?

--- !ELF
FileHeader:
  Class:   ELFCLASS64
  Data:    ELFDATA2LSB
  Type:    ET_EXEC
  Machine: EM_X86_64
DWARF:
  debug_abbrev:
    - Table:
      - Tag:      DW_TAG_compile_unit
        Children: DW_CHILDREN_yes
        Attributes:
          - Attribute: DW_AT_producer
            Form:      DW_FORM_string
      - Tag:      DW_TAG_subprogram
        Children: DW_CHILDREN_yes
        Attributes:
          - Attribute: DW_AT_name
            Form:      DW_FORM_string
      - Tag:      DW_TAG_namespace
        Children: DW_CHILDREN_yes
        Attributes:
          - Attribute: DW_AT_name
            Form:      DW_FORM_string
      - Tag:      DW_TAG_base_type
        Children: DW_CHILDREN_no
        Attributes:
          - Attribute: DW_AT_name
            Form:      DW_FORM_string
  debug_info:
    - Version: 4
      Entries:
        - AbbrCode: 1
          Values:
            - CStr: by_hand
        - AbbrCode: 2
          Values:
            - CStr: main
        - AbbrCode: 3
          Values:
            - CStr: test
        - AbbrCode: 4
          Values:
            - CStr: int

llvm/tools/llvm-dwarfdump/llvm-dwarfdump.cpp

638

I think it might be good to surround file names with single quotes '. e.g.

Unable to open output file '/path/to/file': permission denied

[jhenderson]

llvm/tools/llvm-dwarfdump/llvm-dwarfdump.cpp

638

Whilst you're changing this message, I'd also change Unable to unable, in line with the LLVM error message style policy.

[gbreynoo]

Changed parent_recurse_depth.s to use yaml rather than assembly, fixed typo of FileCheck and fixed the error message.

[gbreynoo]

llvm/test/tools/llvm-dwarfdump/X86/parent_recurse_depth.s

23

Much better thanks.

llvm/tools/llvm-dwarfdump/llvm-dwarfdump.cpp

638

I'd have to check if OutputFilename is empty or an error like unable to open output file '': no such file or directory can be output which looks strange IMHO . Would it better to leave it as is?

[Higuoxing]

llvm/tools/llvm-dwarfdump/llvm-dwarfdump.cpp

638

Sounds reasonable to me. Thanks!

[gbreynoo]

Fix the testing of error output that has of OS specific capitalization.

[Higuoxing]

LGTM. Thanks!

[thopre]

Hi,

The test is a bit fragile as it fails if "main" is somewhere in the path of the object file created, which is likely with the development branch being called main (I personally use 1 git worktree per branch) or with the use of the term "mainline". How about the following change to consume the file name?

diff --git a/llvm/test/tools/llvm-dwarfdump/X86/parent_recurse_depth.s b/llvm/test/tools/llvm-dwarfdump/X86/parent_recurse_depth.s
index 2d573344191c..a63a918a865d 100644

• a/llvm/test/tools/llvm-dwarfdump/X86/parent_recurse_depth.s

+++ b/llvm/test/tools/llvm-dwarfdump/X86/parent_recurse_depth.s
@@ -1,8 +1,10 @@

1. RUN: yaml2obj %s -o %t.o
2. RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 0 %t.o | FileCheck %s --check-prefix=ALL
3. RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 1 %t.o | FileCheck %s --check-prefix=ONE
4. RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 2 %t.o | FileCheck %s --check-prefix=TWO
5. RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 3 %t.o | FileCheck %s --check-prefix=ALL

+# RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 0 %t.o | FileCheck %s --check-prefixes=COMMON,ALL^M
+# RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 1 %t.o | FileCheck %s --check-prefixes=COMMON,ONE^M
+# RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 2 %t.o | FileCheck %s --check-prefixes=COMMON,TWO^M
+# RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 3 %t.o | FileCheck %s --check-prefixes=COMMON,ALL^M
+^M
+# COMMON: .o: file format^M

[thopre]

I've created https://reviews.llvm.org/D103676

[gbreynoo]

Thanks thopre, good catch.

llvm/test/tools/llvm-dwarfdump/X86/output.s

+# RUN: rm -f %t1.txt %t2.txt %t3.txt
+# RUN: llvm-mc %S/brief.s -filetype obj -triple x86_64-apple-darwin -o %t.o
+
+# RUN: llvm-dwarfdump -o=- %t.o | FileCheck %s
+
+# RUN: llvm-dwarfdump -o=%t1.txt %t.o
+# RUN: FileCheck %s --input-file %t1.txt
+
+# RUN: touch %t2.txt
+# RUN: llvm-dwarfdump -o=%t2.txt %t.o
+# RUN: FileCheck %s --input-file %t2.txt
+
+# RUN: touch %t3.txt
+# RUN: chmod 444 %t3.txt
+# RUN: not llvm-dwarfdump -o=%t3.txt %t.o 2>&1 | FileCheck %s  --check-prefix=ERROR1 -DFILE=%t3.txt
+
+# RUN: not llvm-dwarfdump -o= %t.o 2>&1 | FileCheck %s  --check-prefix=ERROR2
+
+# CHECK: DW_TAG_compile_unit
+# ERROR1: unable to open output file [[FILE]]: {{[pP]}}ermission denied
+# ERROR2: unable to open output file : {{[nN]}}o such file or directory

llvm/test/tools/llvm-dwarfdump/X86/parent_recurse_depth.s

+# RUN: yaml2obj %s -o %t.o
+# RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 0 %t.o | FileCheck %s --check-prefix=ALL
+# RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 1 %t.o | FileCheck %s --check-prefix=ONE
+# RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 2 %t.o | FileCheck %s --check-prefix=TWO
+# RUN: llvm-dwarfdump --debug-info=0x00000020 -p -parent-recurse-depth 3 %t.o | FileCheck %s --check-prefix=ALL
+
+# ALL: by_hand
+# ALL: main
+# ALL: test
+# ALL: int
+
+# ONE-NOT: by_hand
+# ONE-NOT: main
+# ONE: test
+# ONE: int
+
+# TWO-NOT: by_hand
+# TWO: main
+# TWO: test
+# TWO: int
+
+--- !ELF
+FileHeader:
+  Class:   ELFCLASS64
+  Data:    ELFDATA2LSB
+  Type:    ET_EXEC
+  Machine: EM_X86_64
+DWARF:
+  debug_abbrev:
+    - Table:
+      - Tag:      DW_TAG_compile_unit
+        Children: DW_CHILDREN_yes
+        Attributes:
+          - Attribute: DW_AT_producer
+            Form:      DW_FORM_string
+      - Tag:      DW_TAG_subprogram
+        Children: DW_CHILDREN_yes
+        Attributes:
+          - Attribute: DW_AT_name
+            Form:      DW_FORM_string
+      - Tag:      DW_TAG_namespace
+        Children: DW_CHILDREN_yes
+        Attributes:
+          - Attribute: DW_AT_name
+            Form:      DW_FORM_string
+      - Tag:      DW_TAG_base_type
+        Children: DW_CHILDREN_no
+        Attributes:
+          - Attribute: DW_AT_name
+            Form:      DW_FORM_string
+  debug_info:
+    - Version: 4
+      Entries:
+        - AbbrCode: 1
+          Values:
+            - CStr: by_hand
+        - AbbrCode: 2
+          Values:
+            - CStr: main
+        - AbbrCode: 3
+          Values:
+            - CStr: test
+        - AbbrCode: 4
+          Values:
+            - CStr: int

llvm/test/tools/llvm-dwarfdump/X86/quiet.s

+# RUN: llvm-mc %S/brief.s -filetype obj -triple x86_64-apple-darwin -o %t.o
+# RUN: llvm-dwarfdump --verify %t.o | FileCheck %s
+# RUN: llvm-dwarfdump --verify --quiet %t.o | FileCheck %s --check-prefix=QUIET --allow-empty
+
+# RUN: llvm-mc %S/empty-CU.s -filetype obj -triple x86_64-apple-darwin -o %t-error.o
+# RUN: not llvm-dwarfdump --verify %t-error.o | FileCheck %s
+# RUN: not llvm-dwarfdump --verify --quiet %t-error.o | FileCheck %s --check-prefix=QUIET --allow-empty
+
+# CHECK: {{.}}
+# QUIET-NOT: {{.}}

llvm/tools/llvm-dwarfdump/llvm-dwarfdump.cpp

int main(int argc, char **argv) {
   if (Diff && Verbose) {
     WithColor::error() << "incompatible arguments: specifying both -diff and "
                           "-verbose is currently not supported";
     return 1;
   }
 
   std::error_code EC;
   ToolOutputFile OutputFile(OutputFilename, EC, sys::fs::OF_TextWithCRLF);
-  error("Unable to open output file" + OutputFilename, EC);
+  error("unable to open output file " + OutputFilename, EC);
   // Don't remove output file if we exit with an error.
   OutputFile.keep();
 
   bool OffsetRequested = false;
 
   // Defaults to dumping all sections, unless brief mode is specified in which
   // case only the .debug_info section in dumped.
 #define HANDLE_DWARF_SECTION(ENUM_NAME, ELF_NAME, CMDLINE_NAME, OPTION)        \