Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions llvm/include/llvm/CodeGen/MachineIDFSSAUpdater.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
//===- MachineIDFSSAUpdater.h - Unstructured SSA Update Tool ----*- C++ -*-===//
//
// 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 declares the MachineIDFSSAUpdater class.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_TRANSFORMS_UTILS_MACHINE_SSAUPDATER2_H
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SSAUPDATER2 -> IDFSSAUPDATER

#define LLVM_TRANSFORMS_UTILS_MACHINE_SSAUPDATER2_H

#include "llvm/CodeGen/MachineRegisterInfo.h"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only need to forward declare MachineRegisterInfo


namespace llvm {

class MachineDominatorTree;
class MachineInstrBuilder;
class MachineBasicBlock;

class MachineIDFSSAUpdater {
struct BBValueInfo {
Register LiveInValue;
Register LiveOutValue;
};

MachineDominatorTree &DT;
MachineRegisterInfo &MRI;
const TargetInstrInfo &TII;
MachineRegisterInfo::VRegAttrs RegAttrs;

SmallVector<std::pair<MachineBasicBlock *, Register>, 4> Defines;
SmallVector<MachineBasicBlock *, 4> UseBlocks;
DenseMap<MachineBasicBlock *, BBValueInfo> BBInfos;

MachineInstrBuilder createInst(unsigned Opc, MachineBasicBlock *BB,
MachineBasicBlock::iterator I);

// IsLiveOut indicates whether we are computing live-out values (true) or
// live-in values (false).
Register computeValue(MachineBasicBlock *BB, bool IsLiveOut);

public:
MachineIDFSSAUpdater(MachineDominatorTree &DT, MachineFunction &MF,
const MachineRegisterInfo::VRegAttrs &RegAttr)
: DT(DT), MRI(MF.getRegInfo()), TII(*MF.getSubtarget().getInstrInfo()),
RegAttrs(RegAttr) {}

MachineIDFSSAUpdater(MachineDominatorTree &DT, MachineFunction &MF,
Register Reg)
: MachineIDFSSAUpdater(DT, MF, MF.getRegInfo().getVRegAttrs(Reg)) {}

/// Indicate that a rewritten value is available in the specified block
/// with the specified value. Must be called before invoking Calculate().
void addAvailableValue(MachineBasicBlock *BB, Register V) {
Defines.emplace_back(BB, V);
}

/// Record a basic block that uses the value. This method should be called for
/// every basic block where the value will be used. Must be called before
/// invoking Calculate().
void addUseBlock(MachineBasicBlock *BB) { UseBlocks.push_back(BB); }

/// Calculate and insert necessary PHI nodes for SSA form.
/// Must be called after registering all definitions and uses.
void calculate();

/// See SSAUpdater::GetValueInMiddleOfBlock description.
Register getValueInMiddleOfBlock(MachineBasicBlock *BB);
};

} // end namespace llvm

#endif // LLVM_TRANSFORMS_UTILS_MACHINE_SSAUPDATER2_H
1 change: 1 addition & 0 deletions llvm/lib/CodeGen/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ add_llvm_component_library(LLVMCodeGen
MachineFunctionPass.cpp
MachineFunctionPrinterPass.cpp
MachineFunctionSplitter.cpp
MachineIDFSSAUpdater.cpp
MachineInstrBundle.cpp
MachineInstr.cpp
MachineLateInstrsCleanup.cpp
Expand Down
181 changes: 181 additions & 0 deletions llvm/lib/CodeGen/MachineIDFSSAUpdater.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
//===- MachineIDFSSAUpdater.cpp - Unstructured SSA Update Tool ------------===//
//
// 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 implements the MachineIDFSSAUpdater class.
//
//===----------------------------------------------------------------------===//

#include "llvm/CodeGen/MachineIDFSSAUpdater.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/Analysis/IteratedDominanceFrontier.h"
#include "llvm/CodeGen/MachineBasicBlock.h"
#include "llvm/CodeGen/MachineDominators.h"
#include "llvm/CodeGen/MachineFunction.h"
#include "llvm/CodeGen/MachineInstr.h"
#include "llvm/CodeGen/MachineInstrBuilder.h"
#include "llvm/CodeGen/MachineOperand.h"
#include "llvm/CodeGen/MachineRegisterInfo.h"
#include "llvm/CodeGen/TargetInstrInfo.h"
#include "llvm/CodeGen/TargetOpcodes.h"
#include "llvm/IR/DebugLoc.h"
#include "llvm/Support/Debug.h"

namespace llvm {

template <bool IsPostDom>
class MachineIDFCalculator final
: public IDFCalculatorBase<MachineBasicBlock, IsPostDom> {
public:
using IDFCalculatorBase =
typename llvm::IDFCalculatorBase<MachineBasicBlock, IsPostDom>;
using ChildrenGetterTy = typename IDFCalculatorBase::ChildrenGetterTy;

MachineIDFCalculator(DominatorTreeBase<MachineBasicBlock, IsPostDom> &DT)
: IDFCalculatorBase(DT) {}
};

using MachineForwardIDFCalculator = MachineIDFCalculator<false>;
using MachineReverseIDFCalculator = MachineIDFCalculator<true>;

} // namespace llvm

using namespace llvm;

/// Given sets of UsingBlocks and DefBlocks, compute the set of LiveInBlocks.
/// This is basically a subgraph limited by DefBlocks and UsingBlocks.
static void
computeLiveInBlocks(const SmallPtrSetImpl<MachineBasicBlock *> &UsingBlocks,
const SmallPtrSetImpl<MachineBasicBlock *> &DefBlocks,
SmallPtrSetImpl<MachineBasicBlock *> &LiveInBlocks) {
// To determine liveness, we must iterate through the predecessors of blocks
// where the def is live. Blocks are added to the worklist if we need to
// check their predecessors. Start with all the using blocks.
SmallVector<MachineBasicBlock *, 64> LiveInBlockWorklist(UsingBlocks.begin(),
UsingBlocks.end());

// Now that we have a set of blocks where the phi is live-in, recursively add
// their predecessors until we find the full region the value is live.
while (!LiveInBlockWorklist.empty()) {
MachineBasicBlock *BB = LiveInBlockWorklist.pop_back_val();

// The block really is live in here, insert it into the set. If already in
// the set, then it has already been processed.
if (!LiveInBlocks.insert(BB).second)
continue;

// Since the value is live into BB, it is either defined in a predecessor or
// live into it to. Add the preds to the worklist unless they are a
// defining block.
for (MachineBasicBlock *P : BB->predecessors()) {
// The value is not live into a predecessor if it defines the value.
if (DefBlocks.count(P))
continue;

// Otherwise it is, add to the worklist.
LiveInBlockWorklist.push_back(P);
}
}
}

MachineInstrBuilder
MachineIDFSSAUpdater::createInst(unsigned Opc, MachineBasicBlock *BB,
MachineBasicBlock::iterator I) {
return BuildMI(*BB, I, DebugLoc(), TII.get(Opc),
MRI.createVirtualRegister(RegAttrs));
}

// IsLiveOut indicates whether we are computing live-out values (true) or
// live-in values (false).
Register MachineIDFSSAUpdater::computeValue(MachineBasicBlock *BB,
bool IsLiveOut) {
BBValueInfo *BBInfo = &BBInfos[BB];

if (IsLiveOut && BBInfo->LiveOutValue)
return BBInfo->LiveOutValue;

if (BBInfo->LiveInValue)
return BBInfo->LiveInValue;

SmallVector<BBValueInfo *, 4> DomPath = {BBInfo};
MachineBasicBlock *DomBB = BB, *TopDomBB = BB;
Register V;

while (DT.isReachableFromEntry(DomBB) && !DomBB->pred_empty() &&
(DomBB = DT.getNode(DomBB)->getIDom()->getBlock())) {
BBInfo = &BBInfos[DomBB];
if (BBInfo->LiveOutValue) {
V = BBInfo->LiveOutValue;
break;
}
if (BBInfo->LiveInValue) {
V = BBInfo->LiveInValue;
break;
}
TopDomBB = DomBB;
DomPath.emplace_back(BBInfo);
}

if (!V) {
V = createInst(TargetOpcode::IMPLICIT_DEF, TopDomBB,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should use G_IMPLICIT_DEF if this is used with generic vregs, I thought the old code already supported this

Copy link
Contributor Author

@vpykhtin vpykhtin Oct 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that it's a generic class and can potentially be used with generic registers it's probably a good idea to make some config flag for it.

I haven't found traces of G_IMPLICIT_DEF support for the MachineSSAUpdater class.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added parameter to the constructor to select appropriate opcode. Thought about doing this CRTP but it seems an overkill.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gentle ping.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

global-isel only needs to create new registers using VRegAttrs. But it was not for generic vregs support. What globalisel actually needed was 'register class + LLT' because of uniformity anaysis. Did not try this patch with G_IMPLICIT_DEF but it would probably crash something if it had register class and LLT.

TopDomBB->getFirstNonPHI())
.getReg(0);
}

for (BBValueInfo *BBInfo : DomPath) {
// Loop above can insert new entries into the BBInfos map: assume the
// map shouldn't grow as the caller should have been allocated enough
// buckets, see [1].
BBInfo->LiveInValue = V;
}

return V;
}

/// Perform all the necessary updates, including new PHI-nodes insertion and the
/// requested uses update.
void MachineIDFSSAUpdater::calculate() {
MachineForwardIDFCalculator IDF(DT);

SmallPtrSet<MachineBasicBlock *, 2> DefBlocks;
for (auto [BB, V] : Defines)
DefBlocks.insert(BB);
IDF.setDefiningBlocks(DefBlocks);

SmallPtrSet<MachineBasicBlock *, 2> UsingBlocks(UseBlocks.begin(),
UseBlocks.end());
SmallVector<MachineBasicBlock *, 4> IDFBlocks;
SmallPtrSet<MachineBasicBlock *, 4> LiveInBlocks;
computeLiveInBlocks(UsingBlocks, DefBlocks, LiveInBlocks);
IDF.setLiveInBlocks(LiveInBlocks);
IDF.calculate(IDFBlocks);

// Reserve sufficient buckets to prevent map growth. [1]
BBInfos.reserve(LiveInBlocks.size() + DefBlocks.size());

for (auto [BB, V] : Defines)
BBInfos[BB].LiveOutValue = V;

for (auto *FrontierBB : IDFBlocks) {
Register NewVR =
createInst(TargetOpcode::PHI, FrontierBB, FrontierBB->begin())
.getReg(0);
BBInfos[FrontierBB].LiveInValue = NewVR;
}

for (auto *BB : IDFBlocks) {
auto *PHI = &BB->front();
assert(PHI->isPHI());
MachineInstrBuilder MIB(*BB->getParent(), PHI);
for (MachineBasicBlock *Pred : BB->predecessors())
MIB.addReg(computeValue(Pred, /*IsLiveOut=*/true)).addMBB(Pred);
}
}

Register MachineIDFSSAUpdater::getValueInMiddleOfBlock(MachineBasicBlock *BB) {
return computeValue(BB, /*IsLiveOut=*/false);
}
Loading