Files
revng-revng/lib/HelperArgumentsAnalysis/HelpersModuleToDeclarations.cpp
Giacomo Vercesi 798af62b87 Introduce helpers declarations
Re-organize the variants of `libtcg-helpers-*.bc` as such:
* `libtcg-helpers-full-$ARCH.bc`: unchanged, contains all helper
  function with their bodies and all CSVs.
* `libtcg-helpers-declarations-only-$ARCH.bc`: all helper
  functions have been turned to declarations. All CSVs (except a couple
  of special ones) have been dropped.
* `libtcg-helpers-to-inline-$ARCH.bc`: only functions with the
  `revng_inline` section retain their body. Only CSVs that are used by
  these functions are present.

Lift now loads only the `declarations-only` variant of helpers, as
their body is not required until `inline-helpers`. In `inline-helpers`
the `to-inline` variant is loaded and linked, which then allows the
helpers to be inlined.
2026-02-05 10:20:45 +01:00

83 lines
2.8 KiB
C++

//
// This file is distributed under the MIT License. See LICENSE.md for details.
//
#include "llvm/IR/Module.h"
#include "llvm/Pass.h"
#include "revng/Model/FunctionTags.h"
#include "PostProcessingHelpers.h"
using namespace llvm;
class HelpersModuleToDeclarations : public llvm::ModulePass {
public:
static char ID;
public:
HelpersModuleToDeclarations() : llvm::ModulePass(ID) {}
bool runOnModule(llvm::Module &M) override {
for (Function &F : M) {
// Only the full module requires debugging information. Remove the !dbg
// tag and the body of the functions. Later `-globaldce` and
// `-strip-dead-debug-info` will take care of dropping all the unused
// data.
F.eraseMetadata(LLVMContext::MD_dbg);
deleteOnlyBody(F);
}
// The global variables are not needed in this module. Drop their debug info
// and their initializer. GlobalDCE will be run later to remove them. This
// is except a couple of special ones that are always needed.
for (GlobalVariable &GV : M.globals()) {
GV.eraseMetadata(LLVMContext::MD_dbg);
if (not isSpecialGV(GV))
GV.setInitializer(nullptr);
}
// Assume the module M already contains the functions.
// Collect all functions whose name starts with "helper_" to prevent DCE
llvm::DenseSet<Function *> Helpers;
for (Function &F : M)
if (isHelper(F))
Helpers.insert(&F);
PointerType *PointerType = PointerType::get(M.getContext(), 0);
// Create constant array initializer with function pointers to the helpers
// functions. Since all the helper functions are declarations they might be
// removed by a globaldce, to prevent that store their pointer in a global
// variable with external linkage.
std::vector<Constant *> FunctionPointers;
for (Function *F : Helpers)
FunctionPointers.push_back(ConstantExpr::getBitCast(F, PointerType));
// Create array type: [N x <function pointer type>]
ArrayType *FunctionArray = ArrayType::get(PointerType,
FunctionPointers.size());
Constant *Initializer = ConstantArray::get(FunctionArray, FunctionPointers);
new GlobalVariable(M,
FunctionArray,
true,
GlobalValue::ExternalLinkage,
Initializer,
HelpersListName);
// Tag all globals
tagQEMUGlobalsAndFunctions(M);
return true;
}
};
char HelpersModuleToDeclarations::ID = 0;
using Register = RegisterPass<HelpersModuleToDeclarations>;
static Register X("helpers-module-to-declarations",
"Purge all helper functions but keep their "
"declarations alive in a array of pointers.",
true,
true);