[ELF] Make SHF_GNU_RETAIN sections GC roots

[MaskRay]

Summary

binutils 2.36 introduced the new section flag SHF_GNU_RETAIN (for ELFOSABI_GNU &
ELFOSABI_FREEBSD) to mark a sections as a GC root. Several LLVM side toolchain
folks (including me) were involved in the design process of SHF_GNU_RETAIN and
were happy with this proposal.

Currently GNU ld only respects SHF_GNU_RETAIN semantics for ELFOSABI_GNU &
ELFOSABI_FREEBSD object files
(https://sourceware.org/bugzilla/show_bug.cgi?id=27282). GNU ld sets EI_OSABI
to ELFOSABI_GNU for relocatable output
(https://sourceware.org/bugzilla/show_bug.cgi?id=27091). In practice the single
value EI_OSABI is neither a good indicator for object file compatibility, nor a
useful mechanism marking used ELF extensions.

For input, we respect SHF_GNU_RETAIN semantics even for ELFOSABI_NONE object
files. This is compatible with how LLD and GNU ld handle (mildly useful) STT_GNU_IFUNC
/ (emitted by GCC, considered misfeature by some folks) STB_GNU_UNIQUE input.
(As of LLVM 12.0.0, the integrated assembler does not set ELFOSABI_GNU for
STT_GNU_IFUNC/STB_GNU_UNIQUE).
Arguably STT_GNU_IFUNC/STB_GNU_UNIQUE probably need indicators in object files
but SHF_GNU_RETAIN is more likely accepted by more OSABI platforms.

For output, we take a step further than GNU ld: we don't promote ELFOSABI_NONE
to ELFOSABI_GNU for all output.

[MaskRay]

Test output flag

[jhenderson]

lld/ELF/MarkLive.cpp

267

Nit: should we have a blank line after this if statement? It's somewhat unrelated to SHF_LINK_ORDER after all.

lld/test/ELF/gc-sections-retain.s

27

Should we use FileCheck -DFILE=%t1.o to check the files in the error message are correct?

38

Maybe it would be simpler to use split-file to create two input files? The ifdef makes the test somewhat less readable to me.

[MaskRay]

lld/ELF/MarkLive.cpp

267

This version looks equally readable to me...

lld/test/ELF/gc-sections-retain.s

27

I think it is unnecessary. There are dedicates tests checking the file name. And for this test it is difficult to make the filename wrong while keeping the .o suffix

38

This is to keep _start so that there is no warning for missing entry point.
(I think this is equally readable.)

[jhenderson]

LGTM. Might be worth giving @peter.smith a chance to chime in too.

lld/ELF/MarkLive.cpp

if (auto *eh = dyn_cast<EhInputSection>(sec)) {
         continue;
 
       if (eh->areRelocsRela)
         scanEhFrameSection(*eh, eh->template relas<ELFT>());
       else
         scanEhFrameSection(*eh, eh->template rels<ELFT>());
     }
 
+    if (sec->flags & SHF_GNU_RETAIN) {
+      enqueue(sec, 0);
+      continue;
+    }
     if (sec->flags & SHF_LINK_ORDER)
       continue;
 
     if (isReserved(sec) || script->shouldKeep(sec)) {
       enqueue(sec, 0);
     } else if (isValidCIdentifier(sec->name)) {
       cNamedSections[saver.save("__start_" + sec->name)].push_back(sec);
       cNamedSections[saver.save("__stop_" + sec->name)].push_back(sec);

lld/test/ELF/gc-sections-retain.s

+# REQUIRES: x86
+## SHF_GNU_RETAIN is a generic feature defined in the OS specific range. The
+## flag marks a section as a GC root.
+
+# RUN: llvm-mc -filetype=obj -triple=x86_64 %s -o %t.o
+# RUN: ld.lld --gc-sections --print-gc-sections %t.o -o %t | count 0
+# RUN: llvm-readobj -hS %t | FileCheck %s
+# RUN: ld.lld -r -e _start --gc-sections --print-gc-sections %t.o -o %t.ro | count 0
+# RUN: llvm-readobj -hS %t.ro | FileCheck %s
+
+## SHF_GNU_RETAIN has no significance in executables/shared objects. Multiple
+## OSABI values can benefit from this flag. Test that we don't change EI_OSABI,
+## even for relocatable output.
+# CHECK:       OS/ABI: SystemV (0x0)
+
+# CHECK:      Name: .retain
+# CHECK-NEXT: Type: SHT_PROGBITS
+# CHECK-NEXT: Flags [
+# CHECK-NEXT:   SHF_ALLOC
+# CHECK-NEXT:   SHF_GNU_RETAIN
+# CHECK-NEXT: ]
+
+# RUN: llvm-mc -filetype=obj -triple=x86_64 --defsym NONALLOC=1 %s -o %t1.o
+# RUN: not ld.lld --gc-sections %t1.o -o /dev/null 2>&1 | FileCheck %s --check-prefix=ERR
+
+# ERR: error: {{.*}}.o:(.nonalloc): sh_link points to discarded section {{.*}}.o:(.discard)
+
+.global _start
+_start:
+
+.section .retain,"aR",@progbits
+.quad .foo
+
+.section .foo,"a",@progbits
+.quad 0
+
+.ifdef NONALLOC
+.section .discard,"a",@progbits
+
+## With SHF_GNU_RETAIN, .nonalloc is retained while its linked-to section
+## .discard is discarded, so there will be an error.
+.section .nonalloc,"oR",@progbits,.discard
+.quad .text
+.endif