Files
revng-revng/lib/EarlyFunctionAnalysis/PromoteGlobalToLocalVars.cpp
Pietro Fezzardi df3bd470a1 Enforce determinism on CSV handling
Various parts of revng replace `llvm::GlobalVariable`s representing CSVs
with Allocal/Load/Store. In particular, these are PromoteCSV,
RootAnalyzer and PromoteGlobalToLocalVars.

Before this commit, those places were sloppy when replacing CSVs with
Alloca/Load/Store, and did that iterating on a container sorted by
pointers. This caused Alloca/Load/Store to be emitted in different order
accross runs, which in turn caused more non-determinism down the
pipeline.

This commit fixes the non-deterministic behavior, sorting CSVs based on
their names, which should always be present and deterministic.
2024-03-19 09:43:59 +01:00

54 lines
1.7 KiB
C++

/// \file PromoteGlobalToLocalVars.cpp
/// Promote CSVs in form of global variables to local variables.
//
// This file is distributed under the MIT License. See LICENSE.md for details.
//
#include "llvm/ADT/STLExtras.h"
#include "llvm/IR/IRBuilder.h"
#include "revng/EarlyFunctionAnalysis/PromoteGlobalToLocalVars.h"
#include "revng/Support/IRHelpers.h"
#include "revng/Support/OpaqueRegisterUser.h"
using namespace llvm;
llvm::PreservedAnalyses
PromoteGlobalToLocalPass::run(llvm::Function &F,
llvm::FunctionAnalysisManager &FAM) {
// Collect the CSVs used by the current function.
std::map<GlobalVariable *, Value *> CSVMap;
for (auto &BB : F) {
for (auto &I : BB) {
Value *Pointer = nullptr;
if (auto *Load = dyn_cast<LoadInst>(&I))
Pointer = skipCasts(Load->getPointerOperand());
else if (auto *Store = dyn_cast<StoreInst>(&I))
Pointer = skipCasts(Store->getPointerOperand());
else
continue;
if (auto *CSV = dyn_cast_or_null<GlobalVariable>(Pointer))
CSVMap.try_emplace(CSV);
}
}
// Create an equivalent local variable, replace all the uses of the CSV.
IRBuilder<> Builder(&F.getEntryBlock().front());
for (GlobalVariable *CSV : toSortedByName(llvm::make_first_range(CSVMap))) {
auto *CSVTy = CSV->getValueType();
auto *Alloca = Builder.CreateAlloca(CSVTy, nullptr, CSV->getName());
replaceAllUsesInFunctionWith(&F, CSV, Alloca);
CSVMap[CSV] = Alloca;
}
// Load all the CSVs and store their value onto the local variables.
for (const auto &[CSV, Alloca] : CSVMap)
Builder.CreateStore(createLoad(Builder, CSV), Alloca);
return PreservedAnalyses::none();
}