[llvm-ar][test] Add testing for bitcode file handling

[gbreynoo]

Summary

This change adds testing for handling of bitcode files in archives, particularly the creation of symbol tables and through MRI scripts. Although there is some testing of bitcode handling in the archive library testing, this was not covered.

[jhenderson]

llvm/test/tools/llvm-ar/bitcode-add.ll

4–5 ↗

(On Diff #442110)

Fold these two into one line and then cd into them immediately before doing the mkdir and llvm-as commands, so that you can drop the %t from those commands.

11 ↗

(On Diff #442110)

I'd add c to this command, to suppress the new archive creation warning (it's not generally an issue, but could cause confusion if a user tried to inspect the verbose output or run the command directly and started getting additional output). Ditto elsewhere in the file.

15 ↗

(On Diff #442110)

Should you check that there are no other files too (e.g. by adding --implicit-check-not={{.}} to your FileCheck command)?

17–18 ↗

(On Diff #442110)

This is only going to prevent ldata and lfunc appearing before gdata and gfunc. Given that you sort before the checks, this will always pass, regardless of whats in the output!

You probably want to be using --implicit-check-not={{.}} and check the entire contents of the output (using SYMS-NEXT as appropriate too for improved output messages).

30 ↗

(On Diff #442110)

31 ↗

(On Diff #442110)

What's in the output in this case? Can we check for that and use --implicit-check-not={{.}} to make the test more robust to changes in how the "Archive map" header is formatted?

38 ↗

(On Diff #442110)

These "update" test cases are about creating a symbol table in an existing archive, but the test is called "bitcode-add.ll". Is the test misnamed? These update cases, aren't really "adding" anything.

41 ↗

(On Diff #442110)

48 ↗

(On Diff #442110)

Do you need the S here? What does suppressing the archive symtab in this case actually achieve? Ditto below.

60–62 ↗

(On Diff #442110)

Again, not a test case to do with "adding" anything.

llvm/test/tools/llvm-ar/mri-bitcode.ll

1 ↗

(On Diff #442110)

This test basically looks identical to the other test, except that MRI scripts are used to drive the program. I feel like it would be better to include the MRI cases alongside the non-MRI cases in the same test file.

[gbreynoo]

Combined tests into one file, added us of --implicit-check-not, supressed archive creation warnings and fixed comments.

[gbreynoo]

llvm/test/tools/llvm-ar/bitcode-add.ll

38 ↗

(On Diff #442110)

I agree the test is poorly named, hopefully the more general name is more fitting?

60 ↗

(On Diff #442110)

I forgot to change these uses of %t, I'll fix it.

60–62 ↗

(On Diff #442110)

As mentioned above.

llvm/test/tools/llvm-ar/mri-bitcode.ll

1 ↗

(On Diff #442110)

Agreed, I've combined them.

[gbreynoo]

Removed missed use of %t.

[MaskRay]

llvm/test/tools/llvm-ar/bitcode.ll

23

These lines can use -NEXT:

36

These lines can use -NEXT:

90

Prefer cmp for binary files.

[jhenderson]

Looks good once the outstanding comments have been addressed.

llvm/test/tools/llvm-ar/bitcode.ll

82

This comment looks garbled.

[thakis]

As far as I can tell, this test doesn't pass: http://45.33.8.238/linux/81164/step_12.txt

Please take a look and revert for now if it takes a while to fix.

[gbreynoo]

Thanks, reverting

[gbreynoo]

Currently testing on other machines.

[gbreynoo]

The issue stemmed from the output of sort differing between OS, removing it's use should fix things.

llvm/test/tools/llvm-ar/bitcode.ll

+## Show that when bitcode is added to an archive it is handled correctly.
+## The symbol table is as expected and it can be extracted without issue.
+
+# RUN: rm -rf %t
+# RUN: split-file %s %t && mkdir -p %t/extracted
+# RUN: cd %t
+# RUN: llvm-as a.ll -o a.bc
+
+## Create symtab from bitcode for a new archive.
+# RUN: llvm-ar rcs new.a a.bc
+# RUN: llvm-ar t new.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+# RUN: llvm-nm --print-armap new.a | sort | FileCheck --check-prefix=SYMS %s --implicit-check-not={{.}}
+
+# FILES: a.bc
+
+# SYMS:      -------- D gdata
+# SYMS-NEXT: -------- d ldata
+# SYMS-NEXT: -------- T gfunc
+# SYMS-NEXT: -------- t lfunc
+# SYMS-NEXT: a.bc:
+# SYMS-NEXT: Archive map
+# SYMS-NEXT: gdata in a.bc
+# SYMS-NEXT: gfunc in a.bc
+
+## Update symtab from bitcode in an existing archive.
+# RUN: llvm-ar rcS update.a a.bc
+# RUN: llvm-ar t update.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+## Check no symbol table is present.
+# RUN: llvm-nm --print-armap update.a | FileCheck --check-prefix=NOSYMS %s --implicit-check-not={{.}}
+# RUN: llvm-ar s update.a
+# RUN: llvm-ar t update.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+# RUN: llvm-nm --print-armap update.a | sort | FileCheck --check-prefix=SYMS %s --implicit-check-not={{.}}
+
+# NOSYMS: a.bc:
+# NOSYMS:      -------- D gdata
+# NOSYMS-NEXT: -------- T gfunc
+# NOSYMS-NEXT: -------- d ldata
+# NOSYMS-NEXT: -------- t lfunc
+
+## Create symtab from bitcode for a regular archive via MRI script.
+# RUN: llvm-ar -M < add.mri
+# RUN: llvm-ar t mri.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+# RUN: llvm-nm --print-armap mri.a | sort | FileCheck --check-prefix=SYMS %s --implicit-check-not={{.}}
+
+## Create symtab from bitcode for a new thin archive.
+# RUN: llvm-ar rcs --thin new-thin.a a.bc
+# RUN: llvm-ar t new-thin.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+# RUN: llvm-nm --print-armap new-thin.a | sort | FileCheck --check-prefix=SYMS %s --implicit-check-not={{.}}
+
+## Update symtab from bitcode in an existing thin archive.
+# RUN: llvm-ar rcS --thin update-thin.a a.bc
+# RUN: llvm-ar t update-thin.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+## Check no symbol table is present.
+# RUN: llvm-nm --print-armap update-thin.a | FileCheck --check-prefix=NOSYMS %s --implicit-check-not={{.}}
+# RUN: llvm-ar s update-thin.a
+# RUN: llvm-ar t update-thin.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+# RUN: llvm-nm --print-armap update-thin.a | sort | FileCheck --check-prefix=SYMS %s --implicit-check-not={{.}}
+
+## Create symtab from bitcode for a thin archive via MRI script.
+# RUN: llvm-ar -M < add-thin.mri
+# RUN: llvm-ar t mri-thin.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+# RUN: llvm-nm --print-armap mri-thin.a | sort | FileCheck --check-prefix=SYMS %s --implicit-check-not={{.}}
+
+## Create symtab from bitcode from another archive.
+# RUN: llvm-ar rcs input.a a.bc
+# RUN: llvm-ar qsL lib.a input.a
+# RUN: llvm-ar t lib.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+# RUN: llvm-nm --print-armap lib.a | sort | FileCheck --check-prefix=SYMS %s --implicit-check-not={{.}}
+
+## Create symtab from bitcode from another archive via MRI script.
+# RUN: llvm-ar -M < addlib.mri
+# RUN: llvm-ar t mri-addlib.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+# RUN: llvm-nm --print-armap mri-addlib.a | sort | FileCheck --check-prefix=SYMS %s --implicit-check-not={{.}}
+
+## Create symtab from bitcode from another thin archive.
+# RUN: llvm-ar rcs --thin input-thin.a a.bc
+# RUN: llvm-ar qsL --thin lib-thin.a input-thin.a
+# RUN: llvm-ar t lib-thin.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+# RUN: llvm-nm --print-armap lib-thin.a | sort | FileCheck --check-prefix=SYMS %s --implicit-check-not={{.}}
+
+## Create symtab from bitcode from another thin archive via MRI script.
+# RUN: llvm-ar -M < addlib-thin.mri
+# RUN: llvm-ar t mri-addlib-thin.a | FileCheck --check-prefix=FILES %s --implicit-check-not={{.}}
+# RUN: llvm-nm --print-armap mri-addlib-thin.a | sort | FileCheck --check-prefix=SYMS %s --implicit-check-not={{.}}
+
+## Extract bitcode and ensure it has not been changed.
+# RUN: cd extracted
+# RUN: llvm-ar x ../new.a a.bc
+# RUN: cmp a.bc a.bc
+
+#--- a.ll
+@gdata = global i32 0
+@ldata = internal global i32 0
+define void @gfunc() { ret void }
+define internal void @lfunc() { ret void }
+
+#--- add.mri
+CREATE mri.a
+ADDMOD a.bc
+SAVE
+END
+
+#--- add-thin.mri
+CREATETHIN mri-thin.a
+ADDMOD a.bc
+SAVE
+END
+
+#--- addlib.mri
+CREATE mri-addlib.a
+ADDLIB input.a
+SAVE
+END
+
+#--- addlib-thin.mri
+CREATE mri-addlib-thin.a
+ADDLIB input-thin.a
+SAVE
+END