Files
revng-revng/lib/RemoveExtractValues/RemoveExtractValuesPass.cpp
T
Pietro Fezzardi e2791443fb Remove extractvalue instructions in decompilation
Now extractvalue instruction are replaced by dedicated
OpaqueExtractValue custom opcode, that prevents LLVM from doing strange
things with extractvalues during optimizations (such as e.g. sinking).

This is important since extractvalue instructions and struct-typed
values in general in our LLVM IR are not real first-class citizens, but
only a byproduct of the binary lifting process, and they actually
represent bundles of registers that are returned from isolated
functions.
2023-06-30 10:48:59 +02:00

82 lines
2.7 KiB
C++

//
// Copyright rev.ng Labs Srl. See LICENSE.md for details.
//
#include "llvm/ADT/SmallVector.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Type.h"
#include "llvm/Transforms/Utils/Local.h"
#include "revng/Support/Assert.h"
#include "revng/Support/FunctionTags.h"
#include "revng/Support/IRHelpers.h"
#include "revng/Support/OpaqueFunctionsPool.h"
#include "revng-c/RemoveExtractValues/RemoveExtractValuesPass.h"
#include "revng-c/Support/FunctionTags.h"
using namespace llvm;
char RemoveExtractValues::ID = 0;
using Reg = RegisterPass<RemoveExtractValues>;
static Reg X("remove-extractvalues",
"Substitute extractvalues with opaque calls so that they don't "
"get optimized",
true,
true);
bool RemoveExtractValues::runOnFunction(llvm::Function &F) {
using namespace llvm;
// Collect all ExtractValues
SmallVector<ExtractValueInst *, 16> ToReplace;
for (auto &BB : F)
for (auto &I : BB)
if (auto *ExtractVal = llvm::dyn_cast<llvm::ExtractValueInst>(&I))
ToReplace.push_back(ExtractVal);
if (ToReplace.empty())
return false;
// Create a pool of functions with the same behavior: we will need a different
// function for each different struct
OpaqueFunctionsPool<TypePair> OpaqueEVPool(F.getParent(),
/* PurgeOnDestruction */ false);
initOpaqueEVPool(OpaqueEVPool, F.getParent());
llvm::LLVMContext &LLVMCtx = F.getContext();
IRBuilder<> Builder(LLVMCtx);
for (ExtractValueInst *I : ToReplace) {
Builder.SetInsertPoint(I);
// Collect arguments of the ExtractValue
SmallVector<Value *, 8> ArgValues = { I->getAggregateOperand() };
revng_assert(I->getNumIndices() == 1);
for (auto Idx : I->indices()) {
auto *IndexVal = ConstantInt::get(IntegerType::getInt64Ty(LLVMCtx), Idx);
ArgValues.push_back(IndexVal);
}
// Get or generate the function
auto *EVFunctionType = getOpaqueEVFunctionType(I);
const TypePair &Key = { I->getType(), I->getAggregateOperand()->getType() };
auto *ExtractValueFunction = OpaqueEVPool.get(Key,
EVFunctionType,
"OpaqueExtractvalue");
// Emit a call to the new function
CallInst *InjectedCall = Builder.CreateCall(ExtractValueFunction,
ArgValues);
I->replaceAllUsesWith(InjectedCall);
InjectedCall->copyMetadata(*I);
llvm::RecursivelyDeleteTriviallyDeadInstructions(I);
}
return true;
}