Skip to content

Add section type to support CFI jump table relaxation. #149259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions llvm/docs/Extensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -581,6 +581,26 @@ This section stores pairs of (jump table address, number of entries).
This information is useful for tools that need to statically reconstruct
the control flow of executables.

``SHT_LLVM_CFI_JUMP_TABLE`` Section (CFI jump table)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This section contains the instructions that make up a `CFI jump table`_.
It is expected to be ``SHF_ALLOC`` and may be laid out like a normal
section. The ``SHT_LLVM_CFI_JUMP_TABLE`` section type gives the linker
permission to modify the section in ways that would not normally be
permitted, in order to optimize calls via the jump table.

Each ``sh_entsize`` sized slice of a section of this type containing
exactly one relocation may be considered to be a jump table entry
that branches to the target of the relocation. This allows the linker
to replace the jump table entry with the function body if it is small
enough, or if the function is the last function in the jump table.

A section of this type does not have to be placed according to its
name. The linker may place the section in whichever output section it
sees fit (generally the section that would provide the best locality).

.. _CFI jump table: https://clang.llvm.org/docs/ControlFlowIntegrityDesign.html#forward-edge-cfi-for-indirect-function-calls

CodeView-Dependent
------------------

Expand Down
1 change: 1 addition & 0 deletions llvm/include/llvm/BinaryFormat/ELF.h
Original file line number Diff line number Diff line change
Expand Up @@ -1159,6 +1159,7 @@ enum : unsigned {
SHT_LLVM_OFFLOADING = 0x6fff4c0b, // LLVM device offloading data.
SHT_LLVM_LTO = 0x6fff4c0c, // .llvm.lto for fat LTO.
SHT_LLVM_JT_SIZES = 0x6fff4c0d, // LLVM jump tables sizes.
SHT_LLVM_CFI_JUMP_TABLE = 0x6fff4c0e, // LLVM CFI jump table.
// Android's experimental support for SHT_RELR sections.
// https://android.googlesource.com/platform/bionic/+/b7feec74547f84559a1467aca02708ff61346d2a/libc/include/elf.h#512
SHT_ANDROID_RELR = 0x6fffff00, // Relocation entries; only offsets.
Expand Down
4 changes: 3 additions & 1 deletion llvm/lib/MC/MCParser/ELFAsmParser.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,7 @@ bool ELFAsmParser::parseSectionArguments(bool IsPush, SMLoc loc) {
return TokError("expected end of directive");
}

if (Mergeable)
if (Mergeable || TypeName == "llvm_cfi_jump_table")
if (parseMergeSize(Size))
return true;
if (Flags & ELF::SHF_LINK_ORDER)
Expand Down Expand Up @@ -637,6 +637,8 @@ bool ELFAsmParser::parseSectionArguments(bool IsPush, SMLoc loc) {
Type = ELF::SHT_LLVM_LTO;
else if (TypeName == "llvm_jt_sizes")
Type = ELF::SHT_LLVM_JT_SIZES;
else if (TypeName == "llvm_cfi_jump_table")
Type = ELF::SHT_LLVM_CFI_JUMP_TABLE;
else if (TypeName.getAsInteger(0, Type))
return TokError("unknown section type");
}
Expand Down
4 changes: 3 additions & 1 deletion llvm/lib/MC/MCSectionELF.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -176,11 +176,13 @@ void MCSectionELF::printSwitchToSection(const MCAsmInfo &MAI, const Triple &T,
OS << "llvm_lto";
else if (Type == ELF::SHT_LLVM_JT_SIZES)
OS << "llvm_jt_sizes";
else if (Type == ELF::SHT_LLVM_CFI_JUMP_TABLE)
OS << "llvm_cfi_jump_table";
else
OS << "0x" << Twine::utohexstr(Type);

if (EntrySize) {
assert(Flags & ELF::SHF_MERGE);
assert((Flags & ELF::SHF_MERGE) || Type == ELF::SHT_LLVM_CFI_JUMP_TABLE);
OS << "," << EntrySize;
}

Expand Down
1 change: 1 addition & 0 deletions llvm/lib/Object/ELF.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,7 @@ StringRef llvm::object::getELFSectionTypeName(uint32_t Machine, unsigned Type) {
STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_OFFLOADING);
STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_LTO);
STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_JT_SIZES)
STRINGIFY_ENUM_CASE(ELF, SHT_LLVM_CFI_JUMP_TABLE)
STRINGIFY_ENUM_CASE(ELF, SHT_GNU_ATTRIBUTES);
STRINGIFY_ENUM_CASE(ELF, SHT_GNU_HASH);
STRINGIFY_ENUM_CASE(ELF, SHT_GNU_verdef);
Expand Down
17 changes: 16 additions & 1 deletion llvm/test/MC/AsmParser/llvm_section_types.s
Original file line number Diff line number Diff line change
@@ -1,22 +1,34 @@
## Verify that LLVM-specific section types are correctly inferred from assembly input.
## Verify that LLVM-specific section types are correctly inferred from assembly input and printed.
# RUN: llvm-mc -triple i386-pc-linux %s | FileCheck --check-prefix=ASM %s
# RUN: llvm-mc -triple i386-pc-linux -filetype=obj -o %t %s
# RUN: llvm-readobj -S %t | FileCheck %s
# ASM: .section .section1,"",@llvm_bb_addr_map
.section .section1,"",@llvm_bb_addr_map
.byte 1
# ASM: .section .section2,"",@llvm_call_graph_profile
.section .section2,"",@llvm_call_graph_profile
.byte 1
# ASM: .section .section3,"",@llvm_odrtab
.section .section3,"",@llvm_odrtab
.byte 1
# ASM: .section .section4,"",@llvm_linker_options
.section .section4,"",@llvm_linker_options
.byte 1
# ASM: .section .section5,"",@llvm_sympart
.section .section5,"",@llvm_sympart
.byte 1
# ASM: .section .section6,"",@llvm_dependent_libraries
.section .section6,"",@llvm_dependent_libraries
.byte 1
# ASM: .section .section7,"",@llvm_offloading
.section .section7,"",@llvm_offloading
.byte 1
# ASM: .section .section8,"",@llvm_lto
.section .section8,"",@llvm_lto
.byte 1
# ASM: .section .section9,"",@llvm_cfi_jump_table,1
.section .section9,"",@llvm_cfi_jump_table,1
.byte 1

# CHECK: Name: .section1
# CHECK-NEXT: Type: SHT_LLVM_BB_ADDR_MAP
Expand All @@ -34,3 +46,6 @@
# CHECK-NEXT: Type: SHT_LLVM_OFFLOADING
# CHECK: Name: .section8
# CHECK-NEXT: Type: SHT_LLVM_LTO
# CHECK: Name: .section9
# CHECK-NEXT: Type: SHT_LLVM_CFI_JUMP_TABLE
# CHECK: EntrySize: 1