DwarfException.h revision a9cc7bfa480cba73c84b03353fd134735d8021d4 
1//===-- DwarfException.h - Dwarf Exception Framework -----------*- 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 dwarf exception info into asm files.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CODEGEN_ASMPRINTER_DWARFEXCEPTION_H
15#define LLVM_CODEGEN_ASMPRINTER_DWARFEXCEPTION_H
16
17#include "DIE.h"
18#include "DwarfPrinter.h"
19#include "llvm/CodeGen/AsmPrinter.h"
20#include "llvm/ADT/DenseMap.h"
21#include <string>
22
23namespace llvm {
24
25struct LandingPadInfo;
26class MachineModuleInfo;
27class MCAsmInfo;
28class MCExpr;
29class Timer;
30class raw_ostream;
31
32//===----------------------------------------------------------------------===//
33/// DwarfException - Emits Dwarf exception handling directives.
34///
35class VISIBILITY_HIDDEN DwarfException : public Dwarf {
36  struct FunctionEHFrameInfo {
37    std::string FnName;
38    unsigned Number;
39    unsigned PersonalityIndex;
40    bool hasCalls;
41    bool hasLandingPads;
42    std::vector<MachineMove> Moves;
43    const Function * function;
44
45    FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
46                        bool hC, bool hL,
47                        const std::vector<MachineMove> &M,
48                        const Function *f):
49      FnName(FN), Number(Num), PersonalityIndex(P),
50      hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
51  };
52
53  std::vector<FunctionEHFrameInfo> EHFrames;
54
55  /// UsesLSDA - Indicates whether an FDE that uses the CIE at the given index
56  /// uses an LSDA. If so, then we need to encode that information in the CIE's
57  /// augmentation.
58  DenseMap<unsigned, bool> UsesLSDA;
59
60  /// shouldEmitTable - Per-function flag to indicate if EH tables should
61  /// be emitted.
62  bool shouldEmitTable;
63
64  /// shouldEmitMoves - Per-function flag to indicate if frame moves info
65  /// should be emitted.
66  bool shouldEmitMoves;
67
68  /// shouldEmitTableModule - Per-module flag to indicate if EH tables
69  /// should be emitted.
70  bool shouldEmitTableModule;
71
72  /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
73  /// should be emitted.
74  bool shouldEmitMovesModule;
75
76  /// ExceptionTimer - Timer for the Dwarf exception writer.
77  Timer *ExceptionTimer;
78
79  /// SizeOfEncodedValue - Return the size of the encoding in bytes.
80  unsigned SizeOfEncodedValue(unsigned Encoding);
81
82  /// EmitCIE - Emit a Common Information Entry (CIE). This holds information
83  /// that is shared among many Frame Description Entries.  There is at least
84  /// one CIE in every non-empty .debug_frame section.
85  void EmitCIE(const Function *Personality, unsigned Index);
86
87  /// EmitFDE - Emit the Frame Description Entry (FDE) for the function.
88  void EmitFDE(const FunctionEHFrameInfo &EHFrameInfo);
89
90  /// EmitExceptionTable - Emit landing pads and actions.
91  ///
92  /// The general organization of the table is complex, but the basic concepts
93  /// are easy.  First there is a header which describes the location and
94  /// organization of the three components that follow.
95  ///  1. The landing pad site information describes the range of code covered
96  ///     by the try.  In our case it's an accumulation of the ranges covered
97  ///     by the invokes in the try.  There is also a reference to the landing
98  ///     pad that handles the exception once processed.  Finally an index into
99  ///     the actions table.
100  ///  2. The action table, in our case, is composed of pairs of type ids
101  ///     and next action offset.  Starting with the action index from the
102  ///     landing pad site, each type Id is checked for a match to the current
103  ///     exception.  If it matches then the exception and type id are passed
104  ///     on to the landing pad.  Otherwise the next action is looked up.  This
105  ///     chain is terminated with a next action of zero.  If no type id is
106  ///     found the the frame is unwound and handling continues.
107  ///  3. Type id table contains references to all the C++ typeinfo for all
108  ///     catches in the function.  This tables is reversed indexed base 1.
109
110  /// SharedTypeIds - How many leading type ids two landing pads have in common.
111  static unsigned SharedTypeIds(const LandingPadInfo *L,
112                                const LandingPadInfo *R);
113
114  /// PadLT - Order landing pads lexicographically by type id.
115  static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R);
116
117  struct KeyInfo {
118    static inline unsigned getEmptyKey() { return -1U; }
119    static inline unsigned getTombstoneKey() { return -2U; }
120    static unsigned getHashValue(const unsigned &Key) { return Key; }
121    static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
122    static bool isPod() { return true; }
123  };
124
125  /// PadRange - Structure holding a try-range and the associated landing pad.
126  struct PadRange {
127    // The index of the landing pad.
128    unsigned PadIndex;
129    // The index of the begin and end labels in the landing pad's label lists.
130    unsigned RangeIndex;
131  };
132
133  typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
134
135  /// ActionEntry - Structure describing an entry in the actions table.
136  struct ActionEntry {
137    int ValueForTypeID; // The value to write - may not be equal to the type id.
138    int NextAction;
139    struct ActionEntry *Previous;
140  };
141
142  /// CallSiteEntry - Structure describing an entry in the call-site table.
143  struct CallSiteEntry {
144    // The 'try-range' is BeginLabel .. EndLabel.
145    unsigned BeginLabel; // zero indicates the start of the function.
146    unsigned EndLabel;   // zero indicates the end of the function.
147
148    // The landing pad starts at PadLabel.
149    unsigned PadLabel;   // zero indicates that there is no landing pad.
150    unsigned Action;
151  };
152
153  /// ComputeActionsTable - Compute the actions table and gather the first
154  /// action index for each landing pad site.
155  unsigned ComputeActionsTable(const SmallVectorImpl<const LandingPadInfo*>&LPs,
156                               SmallVectorImpl<ActionEntry> &Actions,
157                               SmallVectorImpl<unsigned> &FirstActions);
158
159  /// CallToNoUnwindFunction - Return `true' if this is a call to a function
160  /// marked `nounwind'. Return `false' otherwise.
161  bool CallToNoUnwindFunction(const MachineInstr *MI);
162
163  /// ComputeCallSiteTable - Compute the call-site table.  The entry for an
164  /// invoke has a try-range containing the call, a non-zero landing pad and an
165  /// appropriate action.  The entry for an ordinary call has a try-range
166  /// containing the call and zero for the landing pad and the action.  Calls
167  /// marked 'nounwind' have no entry and must not be contained in the try-range
168  /// of any entry - they form gaps in the table.  Entries must be ordered by
169  /// try-range address.
170  void ComputeCallSiteTable(SmallVectorImpl<CallSiteEntry> &CallSites,
171                            const RangeMapType &PadMap,
172                            const SmallVectorImpl<const LandingPadInfo *> &LPs,
173                            const SmallVectorImpl<unsigned> &FirstActions);
174  void EmitExceptionTable();
175
176  /// CreateLabelDiff - Emit a label and subtract it from the expression we
177  /// already have.  This is equivalent to emitting "foo - .", but we have to
178  /// emit the label for "." directly.
179  const MCExpr *CreateLabelDiff(const MCExpr *ExprRef, const char *LabelName,
180                                unsigned Index);
181public:
182  //===--------------------------------------------------------------------===//
183  // Main entry points.
184  //
185  DwarfException(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T);
186  virtual ~DwarfException();
187
188  /// BeginModule - Emit all exception information that should come prior to the
189  /// content.
190  void BeginModule(Module *m, MachineModuleInfo *mmi) {
191    this->M = m;
192    this->MMI = mmi;
193  }
194
195  /// EndModule - Emit all exception information that should come after the
196  /// content.
197  void EndModule();
198
199  /// BeginFunction - Gather pre-function exception information.  Assumes being
200  /// emitted immediately after the function entry point.
201  void BeginFunction(MachineFunction *MF);
202
203  /// EndFunction - Gather and emit post-function exception information.
204  void EndFunction();
205};
206
207} // End of namespace llvm
208
209#endif
210