Files
clang-p2996/bolt/lib/Passes/FixRISCVCallsPass.cpp
Job Noorman 7fa33773e3 [BOLT][RISCV] Handle long tail calls (#67098)
Long tail calls use the following instruction sequence on RISC-V:

```
1: auipc xi, %pcrel_hi(sym)
jalr zero, %pcrel_lo(1b)(xi)
```

Since the second instruction in isolation looks like an indirect branch,
this confused BOLT and most functions containing a long tail call got
marked with "unknown control flow" and didn't get optimized as a
consequence.

This patch fixes this by detecting long tail call sequence in
`analyzeIndirectBranch`. `FixRISCVCallsPass` also had to be updated to
expand long tail calls to `PseudoTAIL` instead of `PseudoCALL`.

Besides this, this patch also fixes a minor issue with compressed tail
calls (`c.jr`) not being detected.

Note that I had to change `BinaryFunction::postProcessIndirectBranches`
slightly: the documentation of `MCPlusBuilder::analyzeIndirectBranch`
mentions that the [`Begin`, `End`) range contains the instructions
immediately preceding `Instruction`. However, in
`postProcessIndirectBranches`, *all* the instructions in the BB where
passed in the range. This made it difficult to find the preceding
instruction so I made sure *only* the preceding instructions are passed.
2023-10-05 08:55:30 +00:00

86 lines
2.2 KiB
C++

#include "bolt/Passes/FixRISCVCallsPass.h"
#include "bolt/Core/ParallelUtilities.h"
#include <iterator>
using namespace llvm;
namespace llvm {
namespace bolt {
void FixRISCVCallsPass::runOnFunction(BinaryFunction &BF) {
auto &BC = BF.getBinaryContext();
auto &MIB = BC.MIB;
auto *Ctx = BC.Ctx.get();
for (auto &BB : BF) {
for (auto II = BB.begin(); II != BB.end();) {
if (MIB->isCall(*II) && !MIB->isIndirectCall(*II)) {
auto *Target = MIB->getTargetSymbol(*II);
assert(Target && "Cannot find call target");
MCInst OldCall = *II;
auto L = BC.scopeLock();
if (MIB->isTailCall(*II))
MIB->createTailCall(*II, Target, Ctx);
else
MIB->createCall(*II, Target, Ctx);
MIB->moveAnnotations(std::move(OldCall), *II);
++II;
continue;
}
auto NextII = std::next(II);
if (NextII == BB.end())
break;
if (MIB->isRISCVCall(*II, *NextII)) {
auto *Target = MIB->getTargetSymbol(*II);
assert(Target && "Cannot find call target");
MCInst OldCall = *NextII;
auto L = BC.scopeLock();
if (MIB->isTailCall(*NextII))
MIB->createTailCall(*II, Target, Ctx);
else
MIB->createCall(*II, Target, Ctx);
MIB->moveAnnotations(std::move(OldCall), *II);
// The original offset was set on the jalr of the auipc+jalr pair. Since
// the whole pair is replaced by a call, adjust the offset by -4 (the
// size of a auipc).
if (std::optional<uint32_t> Offset = MIB->getOffset(*II)) {
assert(*Offset >= 4 && "Illegal jalr offset");
MIB->setOffset(*II, *Offset - 4);
}
II = BB.eraseInstruction(NextII);
continue;
}
++II;
}
}
}
void FixRISCVCallsPass::runOnFunctions(BinaryContext &BC) {
if (!BC.isRISCV() || !BC.HasRelocations)
return;
ParallelUtilities::WorkFuncTy WorkFun = [&](BinaryFunction &BF) {
runOnFunction(BF);
};
ParallelUtilities::runOnEachFunction(
BC, ParallelUtilities::SchedulingPolicy::SP_INST_LINEAR, WorkFun, nullptr,
"FixRISCVCalls");
}
} // namespace bolt
} // namespace llvm