LLVM  16.0.0git
WebAssemblyExceptionInfo.h
Go to the documentation of this file.
1 //===-- WebAssemblyExceptionInfo.h - WebAssembly Exception Info -*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 ///
9 /// \file
10 /// \brief This file implements WebAssemblyException information analysis.
11 ///
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_LIB_TARGET_WEBASSEMBLY_WEBASSEMBLYEXCEPTIONINFO_H
15 #define LLVM_LIB_TARGET_WEBASSEMBLY_WEBASSEMBLYEXCEPTIONINFO_H
16 
17 #include "WebAssembly.h"
19 
20 namespace llvm {
21 
22 class MachineDominatorTree;
23 class MachineDominanceFrontier;
24 
25 // WebAssembly instructions for exception handling are structured as follows:
26 // try
27 // instructions*
28 // catch ----|
29 // instructions* | -> A WebAssemblyException consists of this region
30 // end ----|
31 //
32 // A WebAssemblyException object contains BBs that belong to a 'catch' part of
33 // the try-catch-end structure to be created later. 'try' and 'end' markers
34 // are not present at this stage and will be generated in CFGStackify pass.
35 // Because CFGSort requires all the BBs within a catch part to be sorted
36 // together as it does for loops, this pass calculates the nesting structure of
37 // catch part of exceptions in a function.
38 //
39 // An exception catch part is defined as a BB with catch instruction and all
40 // other BBs dominated by this BB.
42  MachineBasicBlock *EHPad = nullptr;
43 
44  WebAssemblyException *ParentException = nullptr;
45  std::vector<std::unique_ptr<WebAssemblyException>> SubExceptions;
46  std::vector<MachineBasicBlock *> Blocks;
48 
49 public:
50  WebAssemblyException(MachineBasicBlock *EHPad) : EHPad(EHPad) {}
52  const WebAssemblyException &operator=(const WebAssemblyException &) = delete;
53 
54  MachineBasicBlock *getEHPad() const { return EHPad; }
55  MachineBasicBlock *getHeader() const { return EHPad; }
56  WebAssemblyException *getParentException() const { return ParentException; }
57  void setParentException(WebAssemblyException *WE) { ParentException = WE; }
58 
59  bool contains(const WebAssemblyException *WE) const {
60  if (WE == this)
61  return true;
62  if (!WE)
63  return false;
64  return contains(WE->getParentException());
65  }
66  bool contains(const MachineBasicBlock *MBB) const {
67  return BlockSet.count(MBB);
68  }
69 
72  void addToBlocksVector(MachineBasicBlock *MBB) { Blocks.push_back(MBB); }
74  Blocks.push_back(MBB);
75  BlockSet.insert(MBB);
76  }
77  ArrayRef<MachineBasicBlock *> getBlocks() const { return Blocks; }
79  block_iterator block_begin() const { return getBlocks().begin(); }
80  block_iterator block_end() const { return getBlocks().end(); }
82  return make_range(block_begin(), block_end());
83  }
84  unsigned getNumBlocks() const { return Blocks.size(); }
85  std::vector<MachineBasicBlock *> &getBlocksVector() { return Blocks; }
87 
88  const std::vector<std::unique_ptr<WebAssemblyException>> &
89  getSubExceptions() const {
90  return SubExceptions;
91  }
92  std::vector<std::unique_ptr<WebAssemblyException>> &getSubExceptions() {
93  return SubExceptions;
94  }
95  void addSubException(std::unique_ptr<WebAssemblyException> E) {
96  SubExceptions.push_back(std::move(E));
97  }
98  using iterator = typename decltype(SubExceptions)::const_iterator;
99  iterator begin() const { return SubExceptions.begin(); }
100  iterator end() const { return SubExceptions.end(); }
101 
102  void reserveBlocks(unsigned Size) { Blocks.reserve(Size); }
103  void reverseBlock(unsigned From = 0) {
104  std::reverse(Blocks.begin() + From, Blocks.end());
105  }
106 
107  // Return the nesting level. An outermost one has depth 1.
108  unsigned getExceptionDepth() const {
109  unsigned D = 1;
110  for (const WebAssemblyException *CurException = ParentException;
111  CurException; CurException = CurException->ParentException)
112  ++D;
113  return D;
114  }
115 
116  void print(raw_ostream &OS, unsigned Depth = 0) const;
117  void dump() const;
118 };
119 
120 raw_ostream &operator<<(raw_ostream &OS, const WebAssemblyException &WE);
121 
123  // Mapping of basic blocks to the innermost exception they occur in
125  std::vector<std::unique_ptr<WebAssemblyException>> TopLevelExceptions;
126 
127  void discoverAndMapException(WebAssemblyException *WE,
128  const MachineDominatorTree &MDT,
129  const MachineDominanceFrontier &MDF);
130  WebAssemblyException *getOutermostException(MachineBasicBlock *MBB) const;
131 
132 public:
133  static char ID;
136  }
140  operator=(const WebAssemblyExceptionInfo &) = delete;
141 
142  bool runOnMachineFunction(MachineFunction &) override;
143  void releaseMemory() override;
145  const MachineDominanceFrontier &MDF);
146  void getAnalysisUsage(AnalysisUsage &AU) const override;
147 
148  bool empty() const { return TopLevelExceptions.empty(); }
149 
150  // Return the innermost exception that MBB lives in. If the block is not in an
151  // exception, null is returned.
153  return BBMap.lookup(MBB);
154  }
155 
157  WebAssemblyException *WE) {
158  if (!WE) {
159  BBMap.erase(MBB);
160  return;
161  }
162  BBMap[MBB] = WE;
163  }
164 
165  void addTopLevelException(std::unique_ptr<WebAssemblyException> WE) {
166  assert(!WE->getParentException() && "Not a top level exception!");
167  TopLevelExceptions.push_back(std::move(WE));
168  }
169 
170  void print(raw_ostream &OS, const Module *M = nullptr) const override;
171 };
172 
173 } // end namespace llvm
174 
175 #endif
llvm::WebAssemblyException::getExceptionDepth
unsigned getExceptionDepth() const
Definition: WebAssemblyExceptionInfo.h:108
const_iterator
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
WebAssembly.h
llvm::make_range
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
Definition: iterator_range.h:53
llvm::SmallPtrSetImpl::erase
bool erase(PtrType Ptr)
erase - If the set contains the specified pointer, remove it and return true, otherwise return false.
Definition: SmallPtrSet.h:379
llvm::WebAssemblyExceptionInfo::recalculate
void recalculate(MachineFunction &MF, MachineDominatorTree &MDT, const MachineDominanceFrontier &MDF)
Definition: WebAssemblyExceptionInfo.cpp:78
llvm::WebAssemblyException::print
void print(raw_ostream &OS, unsigned Depth=0) const
Definition: WebAssemblyExceptionInfo.cpp:336
llvm::WebAssemblyException::reverseBlock
void reverseBlock(unsigned From=0)
Definition: WebAssemblyExceptionInfo.h:103
llvm::WebAssemblyException::contains
bool contains(const MachineBasicBlock *MBB) const
Definition: WebAssemblyExceptionInfo.h:66
llvm::WebAssemblyExceptionInfo::operator=
WebAssemblyExceptionInfo & operator=(const WebAssemblyExceptionInfo &)=delete
llvm::WebAssemblyException::getSubExceptions
std::vector< std::unique_ptr< WebAssemblyException > > & getSubExceptions()
Definition: WebAssemblyExceptionInfo.h:92
llvm::WebAssemblyException::getParentException
WebAssemblyException * getParentException() const
Definition: WebAssemblyExceptionInfo.h:56
llvm::MachineFunctionPass
MachineFunctionPass - This class adapts the FunctionPass interface to allow convenient creation of pa...
Definition: MachineFunctionPass.h:30
llvm::Depth
@ Depth
Definition: SIMachineScheduler.h:36
llvm::WebAssemblyExceptionInfo::getAnalysisUsage
void getAnalysisUsage(AnalysisUsage &AU) const override
getAnalysisUsage - Subclasses that override getAnalysisUsage must call this.
Definition: WebAssemblyExceptionInfo.cpp:273
llvm::SmallPtrSet
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
Definition: SmallPtrSet.h:450
llvm::WebAssemblyExceptionInfo::WebAssemblyExceptionInfo
WebAssemblyExceptionInfo()
Definition: WebAssemblyExceptionInfo.h:134
llvm::WebAssemblyException
Definition: WebAssemblyExceptionInfo.h:41
llvm::ArrayRef::const_iterator
const_pointer const_iterator
Definition: ArrayRef.h:50
llvm::WebAssemblyException::addToBlocksSet
void addToBlocksSet(MachineBasicBlock *MBB)
Definition: WebAssemblyExceptionInfo.h:70
llvm::WebAssemblyException::getNumBlocks
unsigned getNumBlocks() const
Definition: WebAssemblyExceptionInfo.h:84
llvm::PassRegistry::getPassRegistry
static PassRegistry * getPassRegistry()
getPassRegistry - Access the global registry object, which is automatically initialized at applicatio...
Definition: PassRegistry.cpp:24
E
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
llvm::AnalysisUsage
Represent the analysis usage information of a pass.
Definition: PassAnalysisSupport.h:47
llvm::WebAssemblyExceptionInfo::ID
static char ID
Definition: WebAssemblyExceptionInfo.h:133
llvm::WebAssemblyExceptionInfo::~WebAssemblyExceptionInfo
~WebAssemblyExceptionInfo() override
Definition: WebAssemblyExceptionInfo.h:137
llvm::raw_ostream
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
llvm::operator<<
raw_ostream & operator<<(raw_ostream &OS, const APFixedPoint &FX)
Definition: APFixedPoint.h:230
llvm::initializeWebAssemblyExceptionInfoPass
void initializeWebAssemblyExceptionInfoPass(PassRegistry &)
llvm::CallingConv::ID
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition: CallingConv.h:24
llvm::MachineBasicBlock
Definition: MachineBasicBlock.h:94
llvm::WebAssemblyException::contains
bool contains(const WebAssemblyException *WE) const
Definition: WebAssemblyExceptionInfo.h:59
llvm::WebAssemblyException::getEHPad
MachineBasicBlock * getEHPad() const
Definition: WebAssemblyExceptionInfo.h:54
llvm::WebAssemblyException::getSubExceptions
const std::vector< std::unique_ptr< WebAssemblyException > > & getSubExceptions() const
Definition: WebAssemblyExceptionInfo.h:89
llvm::WebAssemblyException::addBlock
void addBlock(MachineBasicBlock *MBB)
Definition: WebAssemblyExceptionInfo.h:73
D
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
llvm::WebAssemblyException::removeFromBlocksSet
void removeFromBlocksSet(MachineBasicBlock *MBB)
Definition: WebAssemblyExceptionInfo.h:71
llvm::MachineDominanceFrontier
Definition: MachineDominanceFrontier.h:20
move
compiles ldr LCPI1_0 ldr ldr mov lsr tst moveq r1 ldr LCPI1_1 and r0 bx lr It would be better to do something like to fold the shift into the conditional move
Definition: README.txt:546
llvm::WebAssemblyException::block_end
block_iterator block_end() const
Definition: WebAssemblyExceptionInfo.h:80
llvm::DenseMap
Definition: DenseMap.h:714
llvm::WebAssemblyExceptionInfo
Definition: WebAssemblyExceptionInfo.h:122
llvm::WebAssemblyExceptionInfo::changeExceptionFor
void changeExceptionFor(const MachineBasicBlock *MBB, WebAssemblyException *WE)
Definition: WebAssemblyExceptionInfo.h:156
llvm::WebAssemblyException::getHeader
MachineBasicBlock * getHeader() const
Definition: WebAssemblyExceptionInfo.h:55
llvm::WebAssemblyException::WebAssemblyException
WebAssemblyException(MachineBasicBlock *EHPad)
Definition: WebAssemblyExceptionInfo.h:50
llvm::WebAssemblyException::block_iterator
typename ArrayRef< MachineBasicBlock * >::const_iterator block_iterator
Definition: WebAssemblyExceptionInfo.h:78
MachineFunctionPass.h
llvm::WebAssemblyExceptionInfo::runOnMachineFunction
bool runOnMachineFunction(MachineFunction &) override
runOnMachineFunction - This method must be overloaded to perform the desired machine code transformat...
Definition: WebAssemblyExceptionInfo.cpp:39
assert
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
llvm::WebAssemblyException::operator=
const WebAssemblyException & operator=(const WebAssemblyException &)=delete
llvm::WebAssemblyExceptionInfo::releaseMemory
void releaseMemory() override
releaseMemory() - This member can be implemented by a pass if it wants to be able to release its memo...
Definition: WebAssemblyExceptionInfo.cpp:268
llvm::Module
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
llvm::WebAssemblyExceptionInfo::addTopLevelException
void addTopLevelException(std::unique_ptr< WebAssemblyException > WE)
Definition: WebAssemblyExceptionInfo.h:165
llvm::SmallPtrSetImpl::count
size_type count(ConstPtrType Ptr) const
count - Return 1 if the specified pointer is in the set, 0 otherwise.
Definition: SmallPtrSet.h:383
llvm::MachineFunction
Definition: MachineFunction.h:257
llvm::WebAssemblyException::end
iterator end() const
Definition: WebAssemblyExceptionInfo.h:100
llvm::ArrayRef
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: APInt.h:32
llvm::WebAssemblyException::setParentException
void setParentException(WebAssemblyException *WE)
Definition: WebAssemblyExceptionInfo.h:57
llvm::WebAssemblyException::blocks
iterator_range< block_iterator > blocks() const
Definition: WebAssemblyExceptionInfo.h:81
llvm::WebAssemblyExceptionInfo::getExceptionFor
WebAssemblyException * getExceptionFor(const MachineBasicBlock *MBB) const
Definition: WebAssemblyExceptionInfo.h:152
MBB
MachineBasicBlock & MBB
Definition: AArch64SLSHardening.cpp:74
llvm::WebAssemblyException::dump
void dump() const
Definition: WebAssemblyExceptionInfo.cpp:359
llvm::WebAssemblyException::getBlocksVector
std::vector< MachineBasicBlock * > & getBlocksVector()
Definition: WebAssemblyExceptionInfo.h:85
llvm::WebAssemblyException::addSubException
void addSubException(std::unique_ptr< WebAssemblyException > E)
Definition: WebAssemblyExceptionInfo.h:95
llvm::WebAssemblyException::block_begin
block_iterator block_begin() const
Definition: WebAssemblyExceptionInfo.h:79
llvm::WebAssemblyException::begin
iterator begin() const
Definition: WebAssemblyExceptionInfo.h:99
llvm::iterator_range
A range adaptor for a pair of iterators.
Definition: iterator_range.h:30
llvm::reverse
auto reverse(ContainerTy &&C)
Definition: STLExtras.h:365
llvm::SmallPtrSetImpl
A templated base class for SmallPtrSet which provides the typesafe interface that is common across al...
Definition: SmallPtrSet.h:344
llvm::WebAssemblyException::reserveBlocks
void reserveBlocks(unsigned Size)
Definition: WebAssemblyExceptionInfo.h:102
From
BlockVerifier::State From
Definition: BlockVerifier.cpp:55
llvm::WebAssemblyException::addToBlocksVector
void addToBlocksVector(MachineBasicBlock *MBB)
Definition: WebAssemblyExceptionInfo.h:72
llvm::MachineDominatorTree
DominatorTree Class - Concrete subclass of DominatorTreeBase that is used to compute a normal dominat...
Definition: MachineDominators.h:51
llvm::WebAssemblyException::getBlocks
ArrayRef< MachineBasicBlock * > getBlocks() const
Definition: WebAssemblyExceptionInfo.h:77
llvm::WebAssemblyExceptionInfo::print
void print(raw_ostream &OS, const Module *M=nullptr) const override
print - Print out the internal state of the pass.
Definition: WebAssemblyExceptionInfo.cpp:367
llvm::WebAssemblyException::iterator
typename decltype(SubExceptions)::const_iterator iterator
Definition: WebAssemblyExceptionInfo.h:98
llvm::WebAssemblyException::getBlocksSet
SmallPtrSetImpl< MachineBasicBlock * > & getBlocksSet()
Definition: WebAssemblyExceptionInfo.h:86
llvm::WebAssemblyExceptionInfo::empty
bool empty() const
Definition: WebAssemblyExceptionInfo.h:148
llvm::SmallPtrSetImpl::insert
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
Definition: SmallPtrSet.h:365