revng-revng/lib/AdjustStackPointer/AdjustStackPointerPass.cpp

//
// Copyright (c) rev.ng Srls. See LICENSE.md for details.
//

#include "llvm/ADT/StringRef.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/PassManager.h"
#include "llvm/IR/Value.h"
#include "llvm/IR/Verifier.h"
#include "llvm/PassSupport.h"
#include "llvm/Passes/PassBuilder.h"
#include "llvm/Passes/PassPlugin.h"

#include "revng/Support/Assert.h"

#include "revng-c/AdjustStackPointer/AdjustStackPointerPass.h"

using namespace llvm;

bool adjustStackPointer(Function &F) {

  auto *StackInitFun = F.getParent()->getFunction("revng_init_local_sp");
  if (nullptr == StackInitFun)
    return false;

  CallInst *CallStackInit = nullptr;

  for (BasicBlock &BB : F) {
    for (Instruction &I : BB) {
      auto *Call = dyn_cast<CallInst>(&I);
      // Skip instructions that are not CallInst and calls to Functions
      // different from revng_init_local_sp
      if (nullptr == Call or Call->getCalledFunction() != StackInitFun)
        continue;
      revng_assert(nullptr == CallStackInit);
      CallStackInit = Call;
    }
  }

  if (nullptr == CallStackInit)
    return false;

  auto *FType = StackInitFun->getFunctionType();
  revng_assert(FType->getNumParams() == 1U);
  auto *OffsetType = llvm::cast<IntegerType>(FType->getParamType(0U));
  unsigned NBits = OffsetType->getBitWidth();
  APInt AbsOfLowerNegativeOffset(NBits /* bit width */,
                                 0ULL /* initial value*/);

  for (Use &U : CallStackInit->uses()) {
    if (auto *BinOp = dyn_cast<BinaryOperator>(U.getUser())) {

      // Only consider add and sub instructions
      auto OpKind = BinOp->getOpcode();
      if (OpKind != Instruction::Add and OpKind != Instruction::Sub)
        continue;

      // Get the other operand (the offset that is being added or subtracted
      // from the stack pointer.
      auto SPOperandIndex = U.getOperandNo();
      auto OtherOpIndex = SPOperandIndex ? 0U : 1U;
      auto *OtherOperand = U.getUser()->getOperand(OtherOpIndex);

      // In sub instructions, the stack pointer must be the first operand.
      revng_assert(SPOperandIndex == 0 or OpKind == Instruction::Add);

      // Ignore cases where the offset is not constant.
      auto *ConstOffset = dyn_cast<ConstantInt>(OtherOperand);
      if (nullptr == ConstOffset)
        continue;

      auto Offset = ConstOffset->getValue();

      // Ensure that the Offset is always in the range of values that can be
      // represented exactly with NBits bits.
      // The minimum signed value is not valid, because it is not possible to
      // represent its negation exactly with NBits bits.
      auto SMax = APInt::getSignedMaxValue(NBits).getSExtValue();
      auto SMin = APInt::getSignedMinValue(NBits).getSExtValue();
      revng_assert(Offset.getSExtValue() > SMin
                   and Offset.getSExtValue() <= SMax);
      // Make both Offset and LowerNegativeOffset have the same number of bits.
      Offset = Offset.sextOrTrunc(NBits);

      if (OpKind == Instruction::Add) {
        // Only if Offset is strictly less than zero we might need to update
        // AbsOfLowerNegativeOffset.
        if (Offset.isNegative()) {
          // If Offset + AbsOfLowerNegativeOffset is also strictly less than
          // zero, then Offset is the lower negative offset we have found so
          // far, so we need to update AbsOfLowerNegativeOffset.
          bool Overflow = false;
          APInt Diff = Offset.sadd_ov(AbsOfLowerNegativeOffset, Overflow);
          revng_assert(not Overflow);
          if (Diff.isNegative()) {
            // Subtract the Diff from AbsOfLowerNegativeOffset.
            // Here Diff is always negative, so subtracting it from
            // AbsOfLowerNegativeOffset always yields a strictly positive value.
            // It is expected to never overflow, because of the assumptions we
            // have made on Offset.
            APInt Tmp = AbsOfLowerNegativeOffset.ssub_ov(Diff, Overflow);
            revng_assert(not Overflow);
            AbsOfLowerNegativeOffset = Tmp;
          }
        }
      } else /* (OpKind == Instruction::Sub) */ {
        // If Offset is larger than AbsOfLowerNegativeOffset, Offset is the
        // larger value that we have subtracted from the stack pointer so far,
        // so we have to update AbsOfLowerNegativeOffset.
        if (Offset.isStrictlyPositive()
            and Offset.sgt(AbsOfLowerNegativeOffset)) {
          AbsOfLowerNegativeOffset = Offset;
        }
      }
    }
  }
  revng_assert(AbsOfLowerNegativeOffset.isNonNegative());

  bool NeedsChange = AbsOfLowerNegativeOffset.isStrictlyPositive();
  if (NeedsChange) {
    // Start inserting instructions after the CallStackInit call.
    IRBuilder<> Builder(CallStackInit);

    // Create a new call to revng_init_local_sp, which takes the adjusted
    // offset as argument.
    Value *OffsetValue = ConstantInt::get(OffsetType, AbsOfLowerNegativeOffset);
    auto *CallInitAdjustedStack = Builder.CreateCall(StackInitFun, OffsetValue);

    // Zero extend the offset value if it's smaller than the return type of the
    // StackInitFun.
    auto *RetType = cast<IntegerType>(StackInitFun->getReturnType());
    revng_assert(RetType->getBitWidth() >= OffsetType->getBitWidth());
    if (RetType->getBitWidth() > OffsetType->getBitWidth())
      OffsetValue = Builder.CreateZExt(OffsetValue, RetType);

    // Create an addition that adjusts the stack poiner value returned from
    // CallInitAdjustedStack, by summing to it the offset value.
    // The idea behind this operation is that, later on, one can run a constant
    // propagation that will remove all the accesses to the stack pointer at
    // negative constant offsets. Nevertheless, the adjusted offset will remain
    // as argument of the new call to revng_init_local_sp. This operation is
    // necessary to ease the DLA, which currently does not support negative
    // offsets well.
    auto *AdjustedSP = Builder.CreateAdd(CallInitAdjustedStack, OffsetValue);
    CallStackInit->replaceAllUsesWith(AdjustedSP);

    // Now that it has no more uses, we can erase the previous call to
    // revng_init_local_sp, that is not necessary.
    CallStackInit->eraseFromParent();
  }

  revng_assert(not verifyFunction(F));
  return NeedsChange;
}

PreservedAnalyses
AdjustStackPointerPass::run(Function &F, FunctionAnalysisManager &FAM) {
  // Non-isolated functions are not affected.
  if (not F.getMetadata("revng.func.entry"))
    return PreservedAnalyses::all();

  if (adjustStackPointer(F))
    return PreservedAnalyses::none();
  return PreservedAnalyses::all();
}

bool LegacyPMAdjustStackPointerPass::runOnFunction(llvm::Function &F) {
  // Non-isolated functions are not affected.
  if (not F.getMetadata("revng.func.entry"))
    return false;

  return adjustStackPointer(F);
}

static bool regPassCallback(StringRef Name,
                            FunctionPassManager &FPM,
                            ArrayRef<PassBuilder::PipelineElement>) {
  if (Name == "adjust-stack-pointer") {
    FPM.addPass(AdjustStackPointerPass());
    return true;
  }
  return false;
};

// Registration stuff for the pass, using the new PassManager
extern "C" ::llvm::PassPluginLibraryInfo LLVM_ATTRIBUTE_WEAK
llvmGetPassPluginInfo() {
  PassPluginLibraryInfo Pass;
  Pass.APIVersion = LLVM_PLUGIN_API_VERSION;
  Pass.PluginName = "Adjust Stack Pointer Pass";
  Pass.PluginVersion = "v0.1";
  Pass.RegisterPassBuilderCallbacks = [](PassBuilder &PB) {
    PB.registerPipelineParsingCallback(regPassCallback);
  };

  return Pass;
}

// Registration code for the pass, using the legacy PassManager.
char LegacyPMAdjustStackPointerPass::ID = 0;

using RegPass = RegisterPass<LegacyPMAdjustStackPointerPass>;
static RegPass X("adjust-stack-pointer", "Adjust Stack Pointer Legacy Pass");