[ELF] Support for PT_GNU_PROPERTY in program headers and tools

[peter.smith]

Summary

The PT_GNU_PROPERTY is generated by a linker to describe the .note.gnu.property section. The Linux kernel uses this program header to locate the .note.gnu.property section. If there is a program property that requires the kernel to perform some action before loading and ELF file such as AArch64 BTI or intel CET then the program won't load unless the PT_GNU_PROPERTY program header is present. This patch adds the definition and support in llvm-readobj, llvm-objdump to print it out. Support is also added to obj2yaml so that we can write a test for it. This patch is a pre-requisite for adding support for PT_GNU_PROPERTY generation in LLD.

The definition of PT_GNU_PROPERTY can be found in https://github.com/hjl-tools/linux-abi/wiki/linux-abi-draft.pdf

[grimar]

The context is missing in the diff uploaded. A few comments from me are inlined.

llvm/test/tools/llvm-objdump/elf-pt-gnu-property.test

2

Seems most of the comments from elf-pt-gnu-property.test below can also be applied for this test case.

llvm/test/tools/llvm-readobj/elf-pt-gnu-property.test

2

Missing a full stop.

5

It is probably a bit more common to use "GNU" and "LLVM" prefixes in llvm-readobj/llvm-readelf tests.

19

Please align properly (see test\tools\llvm-readobj\program-headers.test for example).

26

Please remove the excessive identations here and in other tests.
e.g:

Class:   ELFCLASS64
Data:    ELFDATA2LSB
Type:    ET_EXEC
Machine: EM_AARCH64

35

This needs a comment about what is exactly encoded here.

42

You do not need the last line with dots.

[peter.smith]

Thanks for the comments. I've updated the diff with context, apologies it has been some time since I last posted a review and I forgot. I've also applied the suggested changes to the test.

[jhenderson]

llvm/test/tools/llvm-objdump/elf-pt-gnu-property.test

3

We've started using yaml2obj %s -o %t to avoid an unnecessary shell redirection. Probably best here too.

7

Does this output match GNU objdump's by the way?

17

If I'm not mistaken, this section is completely irrelevant for the test. The only thing that matters is that there is a segment with type PT_GNU_PROPERTY.

30

The alignment is irrelevant to the interpretation of the program header type. Delete it to keep the test simpler.

llvm/test/tools/llvm-readobj/elf-pt-gnu-property.test

3

-o

7

You can simplify this to just something like {{ }}GNU_PROPERTY{{ }}. The rest of the data is irrelevant. In fact, I wonder if we should just add an equivalent test to "elf-section-types.test" for program headers. You'll see in that test we do the bare minimum to create a section of each section type to show that llvm-readelf/llvm-readobj can display the various section types.

11–18

You don't need the rest of these fields.

27

See the other test: the section is irrelevant and can be deleted.

[peter.smith]

Thanks for the comments. I've paired the tests back to only print the header type. The GNU readelf string type matches, it looks like GNU objdump is missing the string, I've followed the same convention it uses for PT_GNU_RELRO, which is just RELRO.

llvm/test/tools/llvm-objdump/elf-pt-gnu-property.test

7

Looking at the binutils source, there doesn't seem to be an entry in objdump for PT_GNU_PROPERTY, although there is one for readelf. Going by the way PT_GNU_RELRO is printed out in objdump "RELRO", I think PROPERTY is closer to what I'd expect objdump to do.

[MaskRay]

In the description, we can briefly mention that PT_GNU_PROPERTY was introduced because old linkers just "concatenate all input .note.gnu.property sections into one output .note.gnu.property section without merging them, we may see one or more NT_GNU_PROPERTY_TYPE_0 notes in PT_NOTE segment, which are invalid.".

llvm/test/tools/llvm-readobj/elf-pt-gnu-property.test

2

... as GNU_PROPERTY is not appropriate because the LLVM style dumps the segment type as PT_GNU_PROPERTY.

We probably don't even need a comment because the test is simple enough.

[jhenderson]

LGTM, with @MaskRay's comment addressed (I don't mind if the comment is deleted, or kept, but it should at least be fixed).

On the LLD side, I'm assuming that LLD needs to emit it because the kernel in question doesn't parse the PT_NOTE segment for this section? It seems a bit superfluous otherwise...

[peter.smith]

In D70959#1768439, @jhenderson wrote:

LGTM, with @MaskRay's comment addressed (I don't mind if the comment is deleted, or kept, but it should at least be fixed).

On the LLD side, I'm assuming that LLD needs to emit it because the kernel in question doesn't parse the PT_NOTE segment for this section? It seems a bit superfluous otherwise...

Thanks I'll remove the comments. Yes the linux kernel does not parse the PT_NOTE section. This is also true for intel CET, https://bugzilla.redhat.com/show_bug.cgi?id=1721606

llvm/include/llvm/BinaryFormat/ELF.h

enum {
   PT_HIPROC = 0x7fffffff, // Highest processor-specific program hdr entry type.
 
   // x86-64 program header types.
   // These all contain stack unwind tables.
   PT_GNU_EH_FRAME = 0x6474e550,
   PT_SUNW_EH_FRAME = 0x6474e550,
   PT_SUNW_UNWIND = 0x6464e550,
 
-  PT_GNU_STACK = 0x6474e551, // Indicates stack executability.
-  PT_GNU_RELRO = 0x6474e552, // Read-only after relocation.
+  PT_GNU_STACK = 0x6474e551,    // Indicates stack executability.
+  PT_GNU_RELRO = 0x6474e552,    // Read-only after relocation.
+  PT_GNU_PROPERTY = 0x6474e553, // .note.gnu.property notes sections.
 
   PT_OPENBSD_RANDOMIZE = 0x65a3dbe6, // Fill with random data.
   PT_OPENBSD_WXNEEDED = 0x65a3dbe7,  // Program does W^X violations.
   PT_OPENBSD_BOOTDATA = 0x65a41be6,  // Section for boot arguments.
 
   // ARM program header types.
   PT_ARM_ARCHEXT = 0x70000000, // Platform architecture compatibility info
   // These all contain stack unwind tables.

llvm/lib/ObjectYAML/ELFYAML.cpp

#define ECase(X) IO.enumCase(Value, #X, ELF::X)
   ECase(PT_INTERP);
   ECase(PT_NOTE);
   ECase(PT_SHLIB);
   ECase(PT_PHDR);
   ECase(PT_TLS);
   ECase(PT_GNU_EH_FRAME);
   ECase(PT_GNU_STACK);
   ECase(PT_GNU_RELRO);
+  ECase(PT_GNU_PROPERTY);
 #undef ECase
   IO.enumFallback<Hex32>(Value);
 }
 
 void ScalarEnumerationTraits<ELFYAML::ELF_EM>::enumeration(
     IO &IO, ELFYAML::ELF_EM &Value) {
 #define ECase(X) IO.enumCase(Value, #X, ELF::X)
   ECase(EM_NONE);

llvm/test/tools/llvm-objdump/elf-pt-gnu-property.test

+## Test that -p can print PT_GNU_PROPERTY.
+
+# RUN: yaml2obj %s > %t
+# RUN: llvm-objdump -p %t | FileCheck %s
+
+# CHECK: Program Header:
+# CHECK-NEXT: GNU_PROPERTY off    0x0000000000000078 vaddr 0x0000000000000000 paddr 0x0000000000000000 align 2**3
+# CHECK-NEXT: filesz 0x0000000000000020 memsz 0x0000000000000020 flags ---
+
+--- !ELF
+FileHeader:
+  Class:   ELFCLASS64
+  Data:    ELFDATA2LSB
+  Type:    ET_EXEC
+  Machine: EM_AARCH64
+Sections:
+  - Name:         .note.gnu.property
+    Type:         SHT_NOTE
+    Flags:        [ SHF_ALLOC ]
+    Address:      0x0000000000000000
+    AddressAlign: 0x0000000000000008
+# Encodes GNU_FEATURE_1_AND with GNU_PROPERTY_AARCH64_FEATURE_1_BTI and
+# GNU_PROPERTY_AARCH64_FEATURE_1_PAC set.
+    Notes:
+      - Name: GNU
+        Desc: 000000C0040000000300000000000000
+        Type: 0x00000005
+ProgramHeaders:
+  - Type: PT_GNU_PROPERTY
+    Align: 8
+    Sections:
+      - Section: .note.gnu.property

llvm/test/tools/llvm-readobj/elf-pt-gnu-property.test

+## Test that we can print PT_GNU_PROPERTY.
+
+# RUN: yaml2obj %s > %t
+# RUN: llvm-readelf --program-headers %t | FileCheck %s --check-prefix=ELF
+# RUN: llvm-readobj --program-headers %t | FileCheck %s --check-prefix=OBJ
+
+# ELF:   GNU_PROPERTY   0x000078 0x0000000000000000 0x0000000000000000 0x000020 0x000020     0x8
+
+# OBJ:        ProgramHeader {
+# OBJ-NEXT:     Type: PT_GNU_PROPERTY (0x6474E553)
+# OBJ-NEXT:     Offset: 0x78
+# OBJ-NEXT:     VirtualAddress: 0x0
+# OBJ-NEXT:     PhysicalAddress: 0x0
+# OBJ-NEXT:     FileSize: 32
+# OBJ-NEXT:     MemSize: 32
+# OBJ-NEXT:     Flags [ (0x0)
+# OBJ-NEXT:     ]
+# OBJ-NEXT:     Alignment: 8
+
+--- !ELF
+FileHeader:
+  Class:   ELFCLASS64
+  Data:    ELFDATA2LSB
+  Type:    ET_EXEC
+  Machine: EM_AARCH64
+Sections:
+  - Name:         .note.gnu.property
+    Type:         SHT_NOTE
+    Flags:        [ SHF_ALLOC ]
+    Address:      0x0000000000000000
+    AddressAlign: 0x0000000000000008
+    Notes:
+      - Name: GNU
+# Encodes GNU_FEATURE_1_AND with GNU_PROPERTY_AARCH64_FEATURE_1_BTI and
+# GNU_PROPERTY_AARCH64_FEATURE_1_PAC set.
+        Desc: 000000C0040000000300000000000000
+        Type: 0x00000005
+ProgramHeaders:
+  - Type: PT_GNU_PROPERTY
+    Align: 8
+    Sections:
+      - Section: .note.gnu.property

llvm/test/tools/yaml2obj/ELF/program-header.yaml

- Type: PT_LOAD
     Flags: [ PF_R ]
     VAddr: 0xAAAA2000
     PAddr: 0xFFFF2000
     Sections:
       - Section: .data
   - Type: PT_GNU_EH_FRAME
   - Type: PT_GNU_STACK
   - Type: PT_GNU_RELRO
+  - Type: PT_GNU_PROPERTY
 
 #CHECK:     ProgramHeaders [
 #CHECK-NEXT:   ProgramHeader {
 #CHECK-NEXT:    Type: PT_LOAD
 #CHECK-NEXT:    Offset: 0x1000
 #CHECK-NEXT:    VirtualAddress: 0xAAAA1000
 #CHECK-NEXT:    PhysicalAddress: 0xFFFF1000
 #CHECK-NEXT:    FileSize: 20

 #CHECK-NEXT:    Type: PT_GNU_EH_FRAME (0x6474E550)
 #CHECK:       }
 #CHECK-NEXT:  ProgramHeader {
 #CHECK-NEXT:    Type: PT_GNU_STACK (0x6474E551)
 #CHECK:       }
 #CHECK-NEXT:  ProgramHeader {
 #CHECK-NEXT:    Type: PT_GNU_RELRO (0x6474E552)
 #CHECK:       }
+#CHECK-NEXT:  ProgramHeader {
+#CHECK-NEXT:    Type: PT_GNU_PROPERTY (0x6474E553)
+#CHECK:       }
 #CHECK-NEXT:]
 
 ## Check we do not allow referencing sections that do not exist.
 # RUN: not yaml2obj --docnum=2 %s -o %t 2>&1 | FileCheck %s --check-prefix=ERR
 
 # ERR: error: unknown section or fill referenced: '.foo' by program header
 # ERR: error: unknown section or fill referenced: '.bar' by program header
 

llvm/tools/llvm-objdump/ELFDump.cpp

case ELF::PT_DYNAMIC:
       outs() << " DYNAMIC ";
       break;
     case ELF::PT_GNU_EH_FRAME:
       outs() << "EH_FRAME ";
       break;
     case ELF::PT_GNU_RELRO:
       outs() << "   RELRO ";
       break;
+    case ELF::PT_GNU_PROPERTY:
+      outs() << "   GNU_PROPERTY ";
+      break;
     case ELF::PT_GNU_STACK:
       outs() << "   STACK ";
       break;
     case ELF::PT_INTERP:
       outs() << "  INTERP ";
       break;
     case ELF::PT_LOAD:
       outs() << "    LOAD ";

llvm/tools/llvm-readobj/ELFDumper.cpp

static const char *getElfSegmentType(unsigned Arch, unsigned Type) {
   LLVM_READOBJ_ENUM_CASE(ELF, PT_PHDR   );
   LLVM_READOBJ_ENUM_CASE(ELF, PT_TLS    );
 
   LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_EH_FRAME);
   LLVM_READOBJ_ENUM_CASE(ELF, PT_SUNW_UNWIND);
 
     LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_STACK);
     LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_RELRO);
+    LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_PROPERTY);
 
     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_RANDOMIZE);
     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_WXNEEDED);
     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_BOOTDATA);
 
   default:
     return "";
   }
 }
 
 static std::string getElfPtType(unsigned Arch, unsigned Type) {
   switch (Type) {
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_NULL)
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_LOAD)
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_DYNAMIC)
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_INTERP)
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_NOTE)
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_SHLIB)
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_PHDR)
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_TLS)
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_GNU_EH_FRAME)
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_SUNW_UNWIND)
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_GNU_STACK)
     LLVM_READOBJ_PHDR_ENUM(ELF, PT_GNU_RELRO)
+    LLVM_READOBJ_PHDR_ENUM(ELF, PT_GNU_PROPERTY)
   default:
     // All machine specific PT_* types
     switch (Arch) {
     case ELF::EM_ARM:
       if (Type == ELF::PT_ARM_EXIDX)
         return "EXIDX";
       break;
     case ELF::EM_MIPS: