Files
revng-revng/lib/EarlyFunctionAnalysis/CollectFunctionsFromCalleesPass.cpp
Alessandro Di Federico f68b7866b3 Introduce BasicBlockID
This commit introduces `BasicBlockID` as the unique identifier for a
`efa::BasicBlock` into the CFG. A `BasicBlockID` is defined by a
`MetaAddress` plus an incremental integer. This enables us to have
multiple instances of the same block in a single function, which is
particularly useful when inlining multiple times the same function.

Apart from this, the commit also does the following:

* It drops representing `MetaAddress`es a `structs` in the IR. This created
  several issues related to ABI. We now represent them as strings.

* It defines more functions in `support.h`, instead of defining prototypes
  by hand in `CodeGenerator.cpp` and the like. Specifically, `unknownPC`
  and `raise_exception_helper`. We also introduce a C "constructor" for
  `PlainMetaAddress`.

* It significantly reduces the API of `GeneratedCodeBasicInfo`, which
  was supposed to be put on a diet since a long time.  Specifically,
  many jump target related methods have been moved to free functions in
  `IRHelpers.h`.  Also `GCBI::getSuccessors` has been pushed into its
  only user, `PruneRetSuccessors`, to prevent further usage of a
  deprecated API. In the future, it would be nice to drop it entirely.

* It introduces `efa::BasicBlock::InlinedFrom`.

* Introduce an enum to represent named argument indices for `newpc`.
  This enables us to more effectively manipulate its argument list.

* It improves the verification and error reporting for
  `efa::FunctionMetadata`.

* Update tests.

This commit is preliminary to another piece of work to improve the
generality of inlining beyond the simple "fake function" scenario, for
which the feature was originally conceived.
2023-02-23 14:51:10 +01:00

78 lines
2.5 KiB
C++

/// \file CollectFunctionsFromCalleesPass.cpp
/// \brief Collect the function entry points from the callees.
//
// This file is distributed under the MIT License. See LICENSE.md for details.
//
#include "llvm/IR/Module.h"
#include "revng/EarlyFunctionAnalysis/CollectFunctionsFromCalleesPass.h"
#include "revng/EarlyFunctionAnalysis/FunctionMetadataCache.h"
using namespace llvm;
char CollectFunctionsFromCalleesWrapperPass::ID = 0;
using Register = RegisterPass<CollectFunctionsFromCalleesWrapperPass>;
static Register Y("collect-functions-from-callees",
"Functions from callees collection pass",
true,
true);
static Logger<> Log("functions-from-callees-collection");
using CFFCWP = CollectFunctionsFromCalleesWrapperPass;
void CFFCWP::getAnalysisUsage(AnalysisUsage &AU) const {
AU.setPreservesAll();
AU.addRequired<LoadModelWrapperPass>();
AU.addRequired<FunctionMetadataCachePass>();
AU.addRequired<GeneratedCodeBasicInfoWrapperPass>();
}
static void collectFunctionsFromCallees(Module &M,
GeneratedCodeBasicInfo &GCBI,
model::Binary &Binary) {
Function &Root = *M.getFunction("root");
// Static symbols have already been registered during lifting phase. Now
// register all the other candidate entry points.
for (BasicBlock &BB : Root) {
if (getType(&BB) != BlockType::JumpTargetBlock)
continue;
MetaAddress Entry = getBasicBlockAddress(getJumpTargetBlock(&BB));
if (Binary.Functions().find(Entry) != Binary.Functions().end())
continue;
uint32_t Reasons = GCBI.getJTReasons(&BB);
bool IsCallee = hasReason(Reasons, JTReason::Callee);
if (IsCallee) {
// Create the function
Binary.Functions()[Entry];
revng_log(Log, "Found function from callee: " << BB.getName().str());
}
}
}
bool CollectFunctionsFromCalleesWrapperPass::runOnModule(Module &M) {
auto &LMWP = getAnalysis<LoadModelWrapperPass>().get();
auto &GCBI = getAnalysis<GeneratedCodeBasicInfoWrapperPass>().getGCBI();
collectFunctionsFromCallees(M, GCBI, *LMWP.getWriteableModel());
return false;
}
PreservedAnalyses
CollectFunctionsFromCalleesPass::run(Module &M, ModuleAnalysisManager &MAM) {
auto *LM = MAM.getCachedResult<LoadModelAnalysis>(M);
if (!LM)
return PreservedAnalyses::all();
auto &GCBI = MAM.getResult<GeneratedCodeBasicInfoAnalysis>(M);
collectFunctionsFromCallees(M, GCBI, *LM->getWriteableModel());
return PreservedAnalyses::all();
}