X86PadShortFunction.cpp

Go to the documentation of this file.

//===-------- X86PadShortFunction.cpp - pad short functions -----------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file defines the pass which will pad short functions to prevent
// a stall if a function returns before the return address is ready. This
// is needed for some Intel Atom processors.
//
//===----------------------------------------------------------------------===//
 
 
#include "X86.h"
#include "X86InstrInfo.h"
#include "X86Subtarget.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/Analysis/ProfileSummaryInfo.h"
#include "llvm/CodeGen/LazyMachineBlockFrequencyInfo.h"
#include "llvm/CodeGen/MachineBlockFrequencyInfo.h"
#include "llvm/CodeGen/MachineFunctionAnalysisManager.h"
#include "llvm/CodeGen/MachineFunctionPass.h"
#include "llvm/CodeGen/MachineInstrBuilder.h"
#include "llvm/CodeGen/MachinePassManager.h"
#include "llvm/CodeGen/MachineSizeOpts.h"
#include "llvm/CodeGen/Passes.h"
#include "llvm/CodeGen/TargetSchedule.h"
#include "llvm/IR/Analysis.h"
#include "llvm/IR/Function.h"
 
using namespace llvm;
 
#define DEBUG_TYPE "x86-pad-short-functions"
 
STATISTIC(NumBBsPadded, "Number of basic blocks padded");
 
namespace {
  struct VisitedBBInfo {
    // HasReturn - Whether the BB contains a return instruction
    bool HasReturn = false;
 
    // Cycles - Number of cycles until return if HasReturn is true, otherwise
    // number of cycles until end of the BB
    unsigned int Cycles = 0;
 
    VisitedBBInfo() = default;
    VisitedBBInfo(bool HasReturn, unsigned int Cycles)
      : HasReturn(HasReturn), Cycles(Cycles) {}
  };
 
  struct X86PadShortFunctionsLegacy : public MachineFunctionPass {
    static char ID;
    X86PadShortFunctionsLegacy() : MachineFunctionPass(ID) {}
 
    bool runOnMachineFunction(MachineFunction &MF) override;
 
    void getAnalysisUsage(AnalysisUsage &AU) const override {
      AU.addRequired<ProfileSummaryInfoWrapperPass>();
      AU.addRequired<LazyMachineBlockFrequencyInfoPass>();
      AU.addPreserved<LazyMachineBlockFrequencyInfoPass>();
      MachineFunctionPass::getAnalysisUsage(AU);
    }
 
    MachineFunctionProperties getRequiredProperties() const override {
      return MachineFunctionProperties().setNoVRegs();
    }
 
    StringRef getPassName() const override {
      return "X86 Atom pad short functions";
    }
  };
 
  class X86PadShortFunctionsImpl {
  public:
    bool runOnMachineFunction(
        MachineFunction &MF, llvm::function_ref<ProfileSummaryInfo *()> GetPSI,
        llvm::function_ref<MachineBlockFrequencyInfo *()> GetMBFI);
 
  private:
    void findReturns(MachineBasicBlock *MBB,
                     unsigned int Cycles = 0);
 
    bool cyclesUntilReturn(MachineBasicBlock *MBB,
                           unsigned int &Cycles);
 
    void addPadding(MachineBasicBlock *MBB,
                    MachineBasicBlock::iterator &MBBI,
                    unsigned int NOOPsToAdd);
 
    const unsigned int Threshold = 4;
 
    // ReturnBBs - Maps basic blocks that return to the minimum number of
    // cycles until the return, starting from the entry block.
    DenseMap<MachineBasicBlock*, unsigned int> ReturnBBs;
 
    // VisitedBBs - Cache of previously visited BBs.
    DenseMap<MachineBasicBlock*, VisitedBBInfo> VisitedBBs;
 
    TargetSchedModel TSM;
  };
 
  char X86PadShortFunctionsLegacy::ID = 0;
}
 
FunctionPass *llvm::createX86PadShortFunctionsLegacyPass() {
  return new X86PadShortFunctionsLegacy();
}
 
bool X86PadShortFunctionsLegacy::runOnMachineFunction(MachineFunction &MF) {
  if (skipFunction(MF.getFunction()))
    return false;
 
  X86PadShortFunctionsImpl Impl;
  return Impl.runOnMachineFunction(
      MF,
      [&]() { return &getAnalysis<ProfileSummaryInfoWrapperPass>().getPSI(); },
      [&]() {
        return &getAnalysis<LazyMachineBlockFrequencyInfoPass>().getBFI();
      });
}
 
PreservedAnalyses
X86PadShortFunctionsPass::run(MachineFunction &MF,
                              MachineFunctionAnalysisManager &MFAM) {
  X86PadShortFunctionsImpl Impl;
  bool Changed = Impl.runOnMachineFunction(
      MF,
      [&]() {
        return MFAM.getResult<ModuleAnalysisManagerMachineFunctionProxy>(MF)
            .getCachedResult<ProfileSummaryAnalysis>(
                *MF.getFunction().getParent());
      },
      [&]() { return &MFAM.getResult<MachineBlockFrequencyAnalysis>(MF); });
  return Changed ? getMachineFunctionPassPreservedAnalyses()
                       .preserveSet<CFGAnalyses>()
                 : PreservedAnalyses::all();
  ;
}
 
/// runOnMachineFunction - Loop over all of the basic blocks, inserting
/// NOOP instructions before early exits.
bool X86PadShortFunctionsImpl::runOnMachineFunction(
    MachineFunction &MF, llvm::function_ref<ProfileSummaryInfo *()> GetPSI,
    llvm::function_ref<MachineBlockFrequencyInfo *()> GetMBFI) {
  LLVM_DEBUG(dbgs() << "Start X86PadShortFunctionPass\n";);
 
  if (MF.getFunction().hasOptSize())
    return false;
 
  if (!MF.getSubtarget<X86Subtarget>().padShortFunctions())
    return false;
 
  TSM.init(&MF.getSubtarget());
 
  ProfileSummaryInfo *PSI = GetPSI();
  MachineBlockFrequencyInfo *MBFI = nullptr;
  if (PSI && PSI->hasProfileSummary())
    MBFI = GetMBFI();
 
  // Search through basic blocks and mark the ones that have early returns
  ReturnBBs.clear();
  VisitedBBs.clear();
  findReturns(&MF.front());
 
  bool MadeChange = false;
 
  // Pad the identified basic blocks with NOOPs
  for (const auto &ReturnBB : ReturnBBs) {
    MachineBasicBlock *MBB = ReturnBB.first;
    unsigned Cycles = ReturnBB.second;
 
    if (llvm::shouldOptimizeForSize(MBB, PSI, MBFI))
      continue;
 
    if (Cycles < Threshold) {
      // BB ends in a return. Skip over any DBG_VALUE instructions
      // trailing the terminator.
      assert(MBB->size() > 0 &&
             "Basic block should contain at least a RET but is empty");
      MachineBasicBlock::iterator ReturnLoc = --MBB->end();
 
      while (ReturnLoc->isDebugInstr())
        --ReturnLoc;
      assert(ReturnLoc->isReturn() && !ReturnLoc->isCall() &&
             "Basic block does not end with RET");
 
      addPadding(MBB, ReturnLoc, Threshold - Cycles);
      NumBBsPadded++;
      MadeChange = true;
    }
  }
  LLVM_DEBUG(dbgs() << "End X86PadShortFunctionPass\n";);
  return MadeChange;
}
 
/// findReturn - Starting at MBB, follow control flow and add all
/// basic blocks that contain a return to ReturnBBs.
void X86PadShortFunctionsImpl::findReturns(MachineBasicBlock *MBB,
                                           unsigned int Cycles) {
  // If this BB has a return, note how many cycles it takes to get there.
  bool hasReturn = cyclesUntilReturn(MBB, Cycles);
  if (Cycles >= Threshold)
    return;
 
  if (hasReturn) {
    unsigned int &NumCycles = ReturnBBs[MBB];
    NumCycles = std::max(NumCycles, Cycles);
    return;
  }
 
  // Follow branches in BB and look for returns
  for (MachineBasicBlock *Succ : MBB->successors())
    if (Succ != MBB)
      findReturns(Succ, Cycles);
}
 
/// cyclesUntilReturn - return true if the MBB has a return instruction,
/// and return false otherwise.
/// Cycles will be incremented by the number of cycles taken to reach the
/// return or the end of the BB, whichever occurs first.
bool X86PadShortFunctionsImpl::cyclesUntilReturn(MachineBasicBlock *MBB,
                                                 unsigned int &Cycles) {
  // Return cached result if BB was previously visited
  auto [It, Inserted] = VisitedBBs.try_emplace(MBB);
  if (!Inserted) {
    VisitedBBInfo BBInfo = It->second;
    Cycles += BBInfo.Cycles;
    return BBInfo.HasReturn;
  }
 
  unsigned int CyclesToEnd = 0;
 
  for (MachineInstr &MI : *MBB) {
    // Mark basic blocks with a return instruction. Calls to other
    // functions do not count because the called function will be padded,
    // if necessary.
    if (MI.isReturn() && !MI.isCall()) {
      It->second = VisitedBBInfo(true, CyclesToEnd);
      Cycles += CyclesToEnd;
      return true;
    }
 
    CyclesToEnd += TSM.computeInstrLatency(&MI);
  }
 
  It->second = VisitedBBInfo(false, CyclesToEnd);
  Cycles += CyclesToEnd;
  return false;
}
 
/// addPadding - Add the given number of NOOP instructions to the function
/// just prior to the return at MBBI
void X86PadShortFunctionsImpl::addPadding(MachineBasicBlock *MBB,
                                          MachineBasicBlock::iterator &MBBI,
                                          unsigned int NOOPsToAdd) {
  const DebugLoc &DL = MBBI->getDebugLoc();
  unsigned IssueWidth = TSM.getIssueWidth();
 
  for (unsigned i = 0, e = IssueWidth * NOOPsToAdd; i != e; ++i)
    BuildMI(*MBB, MBBI, DL, TSM.getInstrInfo()->get(X86::NOOP));
}