[WinEH] Add CoreCLR EH table emission
[oota-llvm.git] / lib / CodeGen / AsmPrinter / WinException.h
1 //===-- WinException.h - Windows Exception Handling ----------*- C++ -*--===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains support for writing windows exception info into asm files.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_WIN64EXCEPTION_H
15 #define LLVM_LIB_CODEGEN_ASMPRINTER_WIN64EXCEPTION_H
16
17 #include "EHStreamer.h"
18
19 namespace llvm {
20 class Function;
21 class MachineFunction;
22 class MCExpr;
23 class Value;
24 struct WinEHFuncInfo;
25
26 class LLVM_LIBRARY_VISIBILITY WinException : public EHStreamer {
27   /// Per-function flag to indicate if personality info should be emitted.
28   bool shouldEmitPersonality = false;
29
30   /// Per-function flag to indicate if the LSDA should be emitted.
31   bool shouldEmitLSDA = false;
32
33   /// Per-function flag to indicate if frame moves info should be emitted.
34   bool shouldEmitMoves = false;
35
36   /// True if this is a 64-bit target and we should use image relative offsets.
37   bool useImageRel32 = false;
38
39   /// Pointer to the current funclet entry BB.
40   const MachineBasicBlock *CurrentFuncletEntry = nullptr;
41
42   void emitCSpecificHandlerTable(const MachineFunction *MF);
43
44   void emitSEHActionsForRange(WinEHFuncInfo &FuncInfo,
45                               const MCSymbol *BeginLabel,
46                               const MCSymbol *EndLabel, int State);
47
48   /// Emit the EH table data for 32-bit and 64-bit functions using
49   /// the __CxxFrameHandler3 personality.
50   void emitCXXFrameHandler3Table(const MachineFunction *MF);
51
52   /// Emit the EH table data for _except_handler3 and _except_handler4
53   /// personality functions. These are only used on 32-bit and do not use CFI
54   /// tables.
55   void emitExceptHandlerTable(const MachineFunction *MF);
56
57   void emitCLRExceptionTable(const MachineFunction *MF);
58
59   void computeIP2StateTable(
60       const MachineFunction *MF, WinEHFuncInfo &FuncInfo,
61       SmallVectorImpl<std::pair<const MCExpr *, int>> &IPToStateTable);
62
63   /// Emits the label used with llvm.x86.seh.recoverfp, which is used by
64   /// outlined funclets.
65   void emitEHRegistrationOffsetLabel(const WinEHFuncInfo &FuncInfo,
66                                      StringRef FLinkageName);
67
68   const MCExpr *create32bitRef(const MCSymbol *Value);
69   const MCExpr *create32bitRef(const Value *V);
70   const MCExpr *getLabelPlusOne(const MCSymbol *Label);
71   const MCExpr *getOffset(const MCSymbol *OffsetOf, const MCSymbol *OffsetFrom);
72   const MCExpr *getOffsetPlusOne(const MCSymbol *OffsetOf,
73                                  const MCSymbol *OffsetFrom);
74
75   /// Gets the offset that we should use in a table for a stack object with the
76   /// given index. For targets using CFI (Win64, etc), this is relative to the
77   /// established SP at the end of the prologue. For targets without CFI (Win32
78   /// only), it is relative to the frame pointer.
79   int getFrameIndexOffset(int FrameIndex);
80
81 public:
82   //===--------------------------------------------------------------------===//
83   // Main entry points.
84   //
85   WinException(AsmPrinter *A);
86   ~WinException() override;
87
88   /// Emit all exception information that should come after the content.
89   void endModule() override;
90
91   /// Gather pre-function exception information.  Assumes being emitted
92   /// immediately after the function entry point.
93   void beginFunction(const MachineFunction *MF) override;
94
95   /// Gather and emit post-function exception information.
96   void endFunction(const MachineFunction *) override;
97
98   /// \brief Emit target-specific EH funclet machinery.
99   void beginFunclet(const MachineBasicBlock &MBB, MCSymbol *Sym) override;
100   void endFunclet() override;
101 };
102 }
103
104 #endif
105