[llvm-objdump] - Rewrite malformed-archives.test to use YAML descriptions.

[grimar]

Summary

Currently the test uses 14 precompiled binaries. With the functionality
implemented in D89949, it is possible to remove them and use YAMLs instead.

Depends on D89949.

[grimar]

• Minor simplification.

[jhenderson]

llvm/test/tools/llvm-objdump/malformed-archives.test

1–3

2

5–6

I'd add comments before each test case to make it clear what it is testing.

6–7

Optional nit, here and below.

10–14

Looking at the original libbogus1.a and libbogus2.a, I think the test was testing one or both of two possible things:

1. That the first bad member is reported, if there are multiple bad members.
2. That errors in second and subsequent members are picked up, and appropriate offsets reported, even if the first member size is valid.

I think the second point, in particular the bit about the offset being correct, is probably somewhat useful.

31

A comment showing the structure here might be good. Alternatively, what happens if you change the Terminator to be something shorter? Would that be sufficient to produce the same failure?

38–40

The order earlier in the file is RUN/YAML/message, but it's switched here. I don't really mind which way around it is, but it should at least be consistent.

49–80

Aside: Not really sure this should be an error.

178–181

Aside: This test has nothing to do with llvm-objdump. Probably wants moving into the Object or tools/llvm-ar testing.

[grimar]

• Addressed review comments.
• Rebased after update of D89949.

llvm/test/tools/llvm-objdump/malformed-archives.test

10–14

I've restored that case.

31

Alternatively, what happens if you change the Terminator to be something shorter? Would that be sufficient to produce the same failure?

All fields, including the "Terminator" are filled to their expected length with the 0x20 (space) character.
So, no, it will not work here. We need to truncate the header of a member somehow.

I've made the sequence a bit shorter though.

49–80

I don't know either. But note that this only happens for BSD and DARWIN64:

  if (Kind == Archive::K_BSD || Kind == Archive::K_DARWIN64) {
    if (ArMemHdr->Name[0] == ' ') {
      uint64_t Offset = reinterpret_cast<const char *>(ArMemHdr) -
                        Parent->getData().data();
      return malformedError("name contains a leading space for archive member "
                            "header at offset " + Twine(Offset));
...

178–181

True.

[jhenderson]

llvm/test/tools/llvm-objdump/malformed-archives.test

6

"and vice versa" implies the second case is valid (whilst the first isn't), which isn't actually true.

10

Nit. Same below.

14–16

Here and throughout, we should probably check the name in the error, message, right?

45–46

I had trouble understanding the original comment, so I've suggested an alternative.

49

75

88

126

139

152

165

[grimar]

• Addressed review comments.

llvm/test/tools/llvm-objdump/malformed-archives.test

45–46

Thanks.

[jhenderson]

LGTM!

llvm/test/tools/llvm-objdump/malformed-archives.test

-// These test checks that llvm-objdump will not crash with malformed Archive
-// files.  So the check line is not all that important but the bug fixes to
-// make sure llvm-objdump is robust is what matters.
-# RUN: not llvm-objdump --macho --archive-headers \
-# RUN:   %p/Inputs/libbogus1.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus1 %s 
+## These test checks that llvm-objdump will not crash with malformed archive
+## files. The check line is not all that important but the bug fixes to
+## make sure llvm-objdump is robust is what matters.
 
-# bogus1: libbogus1.a': truncated or malformed archive (characters in size field in archive header are not all decimal numbers: '10%' for archive member header at offset 8)
+## Check we report an error when unable to read the size field on an archive as an integer.
+## Check two cases: when the first member is valid, but the second is not and vice versa.
 
-# RUN: not llvm-objdump --macho --archive-headers \
-# RUN:   %p/Inputs/libbogus2.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus2 %s 
+# RUN: yaml2obj --docnum=1 -DFIRST="Size: '1%'" %s -o %t.libbogus1a.a
+# RUN: not llvm-objdump --macho --archive-headers %t.libbogus1a.a 2>&1 | \
+# RUN:  FileCheck -check-prefix=BOGUS1 -DVAL='1%' -DOFFSET=8 %s
 
-# bogus2: libbogus2.a': truncated or malformed archive (characters in size field in archive header are not all decimal numbers: '1%' for archive member header at offset 170)
+# RUN: yaml2obj --docnum=1 %s -o %t.libbogus1b.a
+# RUN: not llvm-objdump --macho --archive-headers %t.libbogus1b.a 2>&1 | \
+# RUN:  FileCheck -check-prefix=BOGUS1 -DVAL=10% -DOFFSET=68 %s
 
-# RUN: not llvm-objdump --macho --archive-headers \
-# RUN:   %p/Inputs/libbogus3.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus3 %s 
+# BOGUS1: .a': truncated or malformed archive (characters in size field in archive header are not all decimal numbers: '[[VAL]]' for archive member header at offset [[OFFSET]])
 
-# bogus3: libbogus3.a': truncated or malformed archive (offset to next archive member past the end of the archive after member foo.c)
+--- !Arch
+Members:
+  - [[FIRST={}]]
+  - Size: '10%'
 
-# RUN: not llvm-objdump --macho --archive-headers \
-# RUN:   %p/Inputs/libbogus4.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus4 %s 
+## Check we report an error when an archive is truncated and are unable to skip the data of a member and read the next one.
 
-# bogus4: libbogus4.a': truncated or malformed archive (remaining size of archive too small for next archive member header for foo.c)
+# RUN: yaml2obj --docnum=2 %s -o %t.libbogus2.a
+# RUN: not llvm-objdump --macho --archive-headers %t.libbogus2.a 2>&1 | \
+# RUN:  FileCheck -check-prefix=BOGUS2 %s
 
-# RUN: not llvm-objdump --macho --archive-headers \
-# RUN:   %p/Inputs/libbogus5.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus5 %s 
+# BOGUS2: libbogus2.a': truncated or malformed archive (offset to next archive member past the end of the archive after member foo.c)
 
-# bogus5: libbogus5.a': truncated or malformed archive (terminator characters in archive member "@\n" not the correct "`\n" values for the archive member header for hello.c)
+--- !Arch
+Members:
+  - Name: 'foo.c'
+    Size: '1'
 
-# RUN: not llvm-objdump --macho --archive-headers \
-# RUN:   %p/Inputs/libbogus6.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus6 %s 
+## Check we report an error when we are unable to read the header of a truncated member (but still are able to read its name).
 
-# bogus6: libbogus6.a': truncated or malformed archive (name contains a leading space for archive member header at offset 96)
+# RUN: yaml2obj --docnum=3 %s -o %t.libbogus3.a
+# RUN: not llvm-objdump --macho --archive-headers %t.libbogus3.a 2>&1 | \
+# RUN:  FileCheck -check-prefix=BOGUS3 %s
 
-# RUN: not llvm-objdump --macho --archive-headers \
-# RUN:   %p/Inputs/libbogus7.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus7 %s 
+# BOGUS3: libbogus3.a': truncated or malformed archive (remaining size of archive too small for next archive member header for foo.c)
 
-# bogus7: libbogus7.a': truncated or malformed archive (long name length characters after the #1/ are not all decimal numbers: '@123$' for archive member header at offset 8)
+--- !Arch
+## It is the content based on an arbitrary valid named member. All fields except the first one ("Name")
+## are dropped, what makes the archive member to be truncated, but still allows to print its name.
+Content: "666f6f2e632020202020202020202020" ## "foo.c           "
 
-# RUN: not llvm-objdump --macho --archive-headers \
-# RUN:   %p/Inputs/libbogus8.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus8 %s 
+## Check we report an error when terminator characters in archive member are not the correct "`\n" values.
+
+# RUN: yaml2obj --docnum=4 %s -o %t.libbogus4.a
+# RUN: not llvm-objdump --macho --archive-headers %t.libbogus4.a 2>&1 | \
+# RUN:  FileCheck -check-prefix=BOGUS4 %s
+
+# BOGUS4: libbogus4.a': truncated or malformed archive (terminator characters in archive member "@\n" not the correct "`\n" values for the archive member header for hello.c)
+
+--- !Arch
+Members:
+  - Name:       'hello.c/'
+    Terminator: "@\n"
+
+## Document we report an error when parsing a BSD archive and the name of a member contains a leading space.
+
+# RUN: yaml2obj --docnum=5 %s -o %t.libbogus5.a
+# RUN: not llvm-objdump --macho --archive-headers %t.libbogus5.a 2>&1 | \
+# RUN:  FileCheck -check-prefix=BOGUS5 %s
+
+# BOGUS5: libbogus5.a': truncated or malformed archive (name contains a leading space for archive member header at offset 68)
+
+--- !Arch
+Members:
+  - Name: '#1/0' ## Triggers parsing as BFD archive.
+  - Name: ' '
+
+## Check we report an error when members long name length characters after
+## the "#1/" are not all decimal numbers.
+
+# RUN: yaml2obj --docnum=6 %s -o %t.libbogus6.a
+# RUN: not llvm-objdump --macho --archive-headers %t.libbogus6.a 2>&1 | \
+# RUN:  FileCheck -check-prefix=BOGUS6 %s
 
-# bogus8: libbogus8.a(<file index: 1>): truncated or malformed archive (long name length: 1234 extends past the end of the member or archive for archive member header at offset 86)
+# BOGUS6: libbogus6.a': truncated or malformed archive (long name length characters after the #1/ are not all decimal numbers: '@123$' for archive member header at offset 8)
 
-# RUN: not llvm-objdump -s %p/Inputs/libbogus9.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus9 %s 
+--- !Arch
+Members:
+  - Name: '#1/@123$'
 
-# bogus9: libbogus9.a(<file index: 0>): truncated or malformed archive (long name offset characters after the '/' are not all decimal numbers: '&a25*' for archive member header at offset 94)
+## Check we report an error when members long name length characters extends past the end of the archive.
 
-# RUN: not llvm-objdump -s %p/Inputs/libbogus10.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus10 %s 
+# RUN: yaml2obj --docnum=7 %s -o %t.libbogus7.a
+# RUN: not llvm-objdump --macho --archive-headers %t.libbogus7.a 2>&1 | \
+# RUN:  FileCheck -check-prefix=BOGUS7 %s
 
-# bogus10: libbogus10.a(<file index: 0>): truncated or malformed archive (long name offset 507 past the end of the string table for archive member header at offset 94)
+# BOGUS7: libbogus7.a': truncated or malformed archive (long name length: 1 extends past the end of the member or archive for archive member header at offset 8)
 
+--- !Arch
+Members:
+  - Name: '#1/1'
+
+## Check we report an error when members long name length characters after
+## the "/" are not all decimal numbers.
+
+# RUN: yaml2obj --docnum=8 %s -o %t.libbogus8.a
+# RUN: not llvm-objdump -s %t.libbogus8.a 2>&1 | FileCheck -check-prefix=BOGUS8 %s
+
+# BOGUS8: truncated or malformed archive (long name offset characters after the '/' are not all decimal numbers: '&a25*' for archive member header at offset 68)
+
+--- !Arch
+Members:
+## We need the first member to be a valid member to trigger the right error to be reported.
+  - Name: 'hello.c/'
+  - Name: "/&a25*"
+
+## Check we report an error when the long name offset goes past the end of the string table.
+
+# RUN: yaml2obj --docnum=9 %s -o %t.libbogus9.a
+# RUN: not llvm-objdump -s %t.libbogus9.a 2>&1 | FileCheck -check-prefix=BOGUS9 %s
+
+# BOGUS9: libbogus9.a(<file index: 0>): truncated or malformed archive (long name offset 1 past the end of the string table for archive member header at offset 68)
+
+--- !Arch
+Members:
+  - Name: '//' ## String table.
+  - Name: '/1'
+
+## Check we report an error when characters in UID field in archive header are not all decimal numbers.
+
+# RUN: yaml2obj --docnum=10 %s -o %t.libbogus10.a
 # RUN: not llvm-objdump --macho --archive-headers \
-# RUN:   %p/Inputs/libbogus11.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus11 %s 
+# RUN:   %t.libbogus10.a 2>&1 | FileCheck -check-prefix=BOGUS10 %s 
+
+# BOGUS10: libbogus10.a(hello.c): truncated or malformed archive (characters in UID field in archive header are not all decimal numbers: '~97&' for the archive member header at offset 8)
 
-# bogus11: libbogus11.a(hello.c): truncated or malformed archive (characters in UID field in archive header are not all decimal numbers: '~97&' for the archive member header at offset 8)
+--- !Arch
+Members:
+  - Name: hello.c
+    UID:  '~97&'
 
+## Check we report an error when characters in GID field in archive header are not all decimal numbers.
+
+# RUN: yaml2obj --docnum=11 %s -o %t.libbogus11.a
 # RUN: not llvm-objdump --macho --archive-headers \
-# RUN:   %p/Inputs/libbogus12.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus12 %s 
+# RUN:   %t.libbogus11.a 2>&1 | FileCheck -check-prefix=BOGUS11 %s 
+
+# BOGUS11: libbogus11.a(hello.c): truncated or malformed archive (characters in GID field in archive header are not all decimal numbers: '#55!' for the archive member header at offset 8)
 
-# bogus12: libbogus12.a(hello.c): truncated or malformed archive (characters in GID field in archive header are not all decimal numbers: '#55!' for the archive member header at offset 8)
+--- !Arch
+Members:
+  - Name: hello.c
+    GID:  '#55!'
 
+## Check we report an error when characters in AccessMode field in archive header are not all decimal numbers.
+
+# RUN: yaml2obj --docnum=12 %s -o %t.libbogus12.a
 # RUN: not llvm-objdump --macho --archive-headers \
-# RUN:   %p/Inputs/libbogus13.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus13 %s 
+# RUN:   %t.libbogus12.a 2>&1 | FileCheck -check-prefix=BOGUS12 %s 
+
+# BOGUS12: libbogus12.a(hello.c): truncated or malformed archive (characters in AccessMode field in archive header are not all decimal numbers: 'Feed' for the archive member header at offset 8)
+
+--- !Arch
+Members:
+  - Name:       hello.c
+    AccessMode: 'Feed'
+
+## Check we report an error when characters in LastModified field in archive header are not all decimal numbers.
 
-# bogus13: libbogus13.a(hello.c): truncated or malformed archive (characters in AccessMode field in archive header are not all decimal numbers: 'Feed' for the archive member header at offset 8)
+# RUN: yaml2obj --docnum=13 %s -o %t.libbogus13.a
+# RUN: llvm-objdump --macho --archive-headers %t.libbogus13.a 2>&1 | \
+# RUN:   FileCheck -check-prefix=BOGUS13A %s 
 
-# RUN: llvm-objdump --macho --archive-headers %p/Inputs/libbogus14.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus14 %s 
+# BOGUS13A: ----------  0/0 0 (date: "1foobar273" contains non-decimal chars) hello.c
 
-# bogus14: -rw-r--r--124/0     102 (date: "1foobar273" contains non-decimal chars) hello.c
+--- !Arch
+Members:
+  - Name:         hello.c
+    LastModified: '1foobar273'
 
-# RUN: not llvm-ar tv %p/Inputs/libbogus14.a \
-# RUN:   2>&1 | FileCheck -check-prefix=bogus14a %s 
+# RUN: not llvm-ar tv %t.libbogus13.a 2>&1 | \
+# RUN:   FileCheck -check-prefix=BOGUS13B %s 
 
-# bogus14a: truncated or malformed archive (characters in LastModified field in archive header are not all decimal numbers: '1foobar273' for the archive member header at offset 8)
+# BOGUS13B: error: truncated or malformed archive (characters in LastModified field in archive header are not all decimal numbers: '1foobar273' for the archive member header at offset 8)