d4d4a04771
## Purpose This patch is one in a series of code-mods that annotate LLVM’s public interface for export. This patch annotates the `llvm/Analysis` library. These annotations currently have no meaningful impact on the LLVM build; however, they are a prerequisite to support an LLVM Windows DLL (shared library) build. ## Background This effort is tracked in #109483. Additional context is provided in [this discourse](https://discourse.llvm.org/t/psa-annotating-llvm-public-interface/85307), and documentation for `LLVM_ABI` and related annotations is found in the LLVM repo [here](https://github.com/llvm/llvm-project/blob/main/llvm/docs/InterfaceExportAnnotations.rst). The bulk of these changes were generated automatically using the [Interface Definition Scanner (IDS)](https://github.com/compnerd/ids) tool, followed formatting with `git clang-format`. The following manual adjustments were also applied after running IDS on Linux: - Add `#include "llvm/Support/Compiler.h"` to files where it was not auto-added by IDS due to no pre-existing block of include statements. - Add `LLVM_TEMPLATE_ABI` and `LLVM_EXPORT_TEMPLATE` to exported instantiated templates - Add `LLVM_ABI` to a subset of private class methods and fields that require export - Add `LLVM_ABI` to a small number of symbols that require export but are not declared in headers ## Validation Local builds and tests to validate cross-platform compatibility. This included llvm, clang, and lldb on the following configurations: - Windows with MSVC - Windows with Clang - Linux with GCC - Linux with Clang - Darwin with Clang
125 lines
4.0 KiB
C++
125 lines
4.0 KiB
C++
//===- DomTreeUpdater.cpp - DomTree/Post DomTree Updater --------*- 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 implements the DomTreeUpdater class, which provides a uniform way
|
|
// to update dominator tree related data structures.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/Analysis/DomTreeUpdater.h"
|
|
#include "llvm/Analysis/GenericDomTreeUpdaterImpl.h"
|
|
#include "llvm/Analysis/PostDominators.h"
|
|
#include "llvm/IR/Constants.h"
|
|
#include "llvm/IR/Instructions.h"
|
|
#include "llvm/Support/Compiler.h"
|
|
#include "llvm/Support/GenericDomTree.h"
|
|
#include <functional>
|
|
|
|
namespace llvm {
|
|
|
|
template class LLVM_EXPORT_TEMPLATE
|
|
GenericDomTreeUpdater<DomTreeUpdater, DominatorTree, PostDominatorTree>;
|
|
|
|
template LLVM_EXPORT_TEMPLATE void
|
|
GenericDomTreeUpdater<DomTreeUpdater, DominatorTree,
|
|
PostDominatorTree>::recalculate(Function &F);
|
|
|
|
template LLVM_EXPORT_TEMPLATE void
|
|
GenericDomTreeUpdater<DomTreeUpdater, DominatorTree, PostDominatorTree>::
|
|
applyUpdatesImpl</*IsForward=*/true>();
|
|
template LLVM_EXPORT_TEMPLATE void
|
|
GenericDomTreeUpdater<DomTreeUpdater, DominatorTree, PostDominatorTree>::
|
|
applyUpdatesImpl</*IsForward=*/false>();
|
|
|
|
bool DomTreeUpdater::forceFlushDeletedBB() {
|
|
if (DeletedBBs.empty())
|
|
return false;
|
|
|
|
for (auto *BB : DeletedBBs) {
|
|
// After calling deleteBB or callbackDeleteBB under Lazy UpdateStrategy,
|
|
// validateDeleteBB() removes all instructions of DelBB and adds an
|
|
// UnreachableInst as its terminator. So we check whether the BasicBlock to
|
|
// delete only has an UnreachableInst inside.
|
|
assert(BB->size() == 1 && isa<UnreachableInst>(BB->getTerminator()) &&
|
|
"DelBB has been modified while awaiting deletion.");
|
|
eraseDelBBNode(BB);
|
|
BB->eraseFromParent();
|
|
}
|
|
DeletedBBs.clear();
|
|
Callbacks.clear();
|
|
return true;
|
|
}
|
|
|
|
// The DT and PDT require the nodes related to updates
|
|
// are not deleted when update functions are called.
|
|
// So BasicBlock deletions must be pended when the
|
|
// UpdateStrategy is Lazy. When the UpdateStrategy is
|
|
// Eager, the BasicBlock will be deleted immediately.
|
|
void DomTreeUpdater::deleteBB(BasicBlock *DelBB) {
|
|
validateDeleteBB(DelBB);
|
|
if (Strategy == UpdateStrategy::Lazy) {
|
|
DeletedBBs.insert(DelBB);
|
|
return;
|
|
}
|
|
|
|
eraseDelBBNode(DelBB);
|
|
DelBB->eraseFromParent();
|
|
}
|
|
|
|
void DomTreeUpdater::callbackDeleteBB(
|
|
BasicBlock *DelBB, std::function<void(BasicBlock *)> Callback) {
|
|
validateDeleteBB(DelBB);
|
|
if (Strategy == UpdateStrategy::Lazy) {
|
|
Callbacks.push_back(CallBackOnDeletion(DelBB, Callback));
|
|
DeletedBBs.insert(DelBB);
|
|
return;
|
|
}
|
|
|
|
eraseDelBBNode(DelBB);
|
|
DelBB->removeFromParent();
|
|
Callback(DelBB);
|
|
delete DelBB;
|
|
}
|
|
|
|
void DomTreeUpdater::validateDeleteBB(BasicBlock *DelBB) {
|
|
assert(DelBB && "Invalid push_back of nullptr DelBB.");
|
|
assert(pred_empty(DelBB) && "DelBB has one or more predecessors.");
|
|
// DelBB is unreachable and all its instructions are dead.
|
|
while (!DelBB->empty()) {
|
|
Instruction &I = DelBB->back();
|
|
// Replace used instructions with an arbitrary value (poison).
|
|
if (!I.use_empty())
|
|
I.replaceAllUsesWith(PoisonValue::get(I.getType()));
|
|
DelBB->back().eraseFromParent();
|
|
}
|
|
// Make sure DelBB has a valid terminator instruction. As long as DelBB is a
|
|
// Child of Function F it must contain valid IR.
|
|
new UnreachableInst(DelBB->getContext(), DelBB);
|
|
}
|
|
|
|
LLVM_DUMP_METHOD
|
|
void DomTreeUpdater::dump() const {
|
|
Base::dump();
|
|
#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
|
|
raw_ostream &OS = dbgs();
|
|
OS << "Pending Callbacks:\n";
|
|
int Index = 0;
|
|
for (const auto &BB : Callbacks) {
|
|
OS << " " << Index << " : ";
|
|
++Index;
|
|
if (BB->hasName())
|
|
OS << BB->getName() << "(";
|
|
else
|
|
OS << "(no_name)(";
|
|
OS << BB << ")\n";
|
|
}
|
|
#endif
|
|
}
|
|
|
|
} // namespace llvm
|