blob: 8b616b012614d2d952e6ddae9bcf135025c747ee [file] [log] [blame]
Bill Wendlingeb907212009-05-15 01:12:28 +00001//===-- CodeGen/AsmPrinter/DwarfException.cpp - Dwarf Exception Impl ------===//
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//
Bill Wendling28275fd2009-09-10 06:50:01 +000010// This file contains support for writing DWARF exception info into asm files.
Bill Wendlingeb907212009-05-15 01:12:28 +000011//
12//===----------------------------------------------------------------------===//
13
14#include "DwarfException.h"
15#include "llvm/Module.h"
16#include "llvm/CodeGen/MachineModuleInfo.h"
17#include "llvm/CodeGen/MachineFrameInfo.h"
David Greenefc4da0c2009-08-19 21:55:33 +000018#include "llvm/CodeGen/MachineFunction.h"
Bill Wendlingeb907212009-05-15 01:12:28 +000019#include "llvm/CodeGen/MachineLocation.h"
Chris Lattner8c6ed052009-09-16 01:46:41 +000020#include "llvm/MC/MCAsmInfo.h"
21#include "llvm/MC/MCContext.h"
22#include "llvm/MC/MCExpr.h"
Bill Wendling43e484f2009-09-10 01:12:47 +000023#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000024#include "llvm/MC/MCStreamer.h"
Chris Lattner7a2ba942010-01-16 18:37:32 +000025#include "llvm/MC/MCSymbol.h"
Chris Lattner45111d12010-01-16 21:57:06 +000026#include "llvm/Target/Mangler.h"
Bill Wendlingeb907212009-05-15 01:12:28 +000027#include "llvm/Target/TargetData.h"
28#include "llvm/Target/TargetFrameInfo.h"
Chris Lattnerd5bbb072009-08-02 01:34:32 +000029#include "llvm/Target/TargetLoweringObjectFile.h"
Bill Wendlingeb907212009-05-15 01:12:28 +000030#include "llvm/Target/TargetOptions.h"
Chris Lattnerd5bbb072009-08-02 01:34:32 +000031#include "llvm/Target/TargetRegisterInfo.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000032#include "llvm/Support/Dwarf.h"
Chris Lattner0ad9c912010-01-22 22:09:00 +000033#include "llvm/Support/FormattedStream.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000034#include "llvm/Support/Timer.h"
Jim Grosbachc40d9f92009-09-01 18:49:12 +000035#include "llvm/ADT/SmallString.h"
Bill Wendlingeb907212009-05-15 01:12:28 +000036#include "llvm/ADT/StringExtras.h"
Bill Wendling1f8075d2010-02-09 22:49:16 +000037#include "llvm/ADT/Twine.h"
Bill Wendlingeb907212009-05-15 01:12:28 +000038using namespace llvm;
39
Bill Wendlingbc0d23a2009-05-15 01:18:50 +000040DwarfException::DwarfException(raw_ostream &OS, AsmPrinter *A,
Chris Lattneraf76e592009-08-22 20:48:53 +000041 const MCAsmInfo *T)
Chris Lattnerc3421bb2010-03-09 00:00:15 +000042 : DwarfPrinter(OS, A, T), shouldEmitTable(false),shouldEmitMoves(false),
Bill Wendlingbc0d23a2009-05-15 01:18:50 +000043 shouldEmitTableModule(false), shouldEmitMovesModule(false),
44 ExceptionTimer(0) {
Eric Christopherdbfcdb92009-08-28 22:33:43 +000045 if (TimePassesIsEnabled)
Chris Lattner0b86a6f2009-12-28 07:41:18 +000046 ExceptionTimer = new Timer("DWARF Exception Writer");
Bill Wendlingbc0d23a2009-05-15 01:18:50 +000047}
48
49DwarfException::~DwarfException() {
50 delete ExceptionTimer;
51}
52
Bill Wendling7ccda0f2009-08-25 08:08:33 +000053/// EmitCIE - Emit a Common Information Entry (CIE). This holds information that
54/// is shared among many Frame Description Entries. There is at least one CIE
55/// in every non-empty .debug_frame section.
Chris Lattner8c6ed052009-09-16 01:46:41 +000056void DwarfException::EmitCIE(const Function *PersonalityFn, unsigned Index) {
Bill Wendlingeb907212009-05-15 01:12:28 +000057 // Size and sign of stack growth.
58 int stackGrowth =
59 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
60 TargetFrameInfo::StackGrowsUp ?
61 TD->getPointerSize() : -TD->getPointerSize();
62
Chris Lattner8c6ed052009-09-16 01:46:41 +000063 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Anton Korobeynikov9184b252010-02-15 22:35:59 +000064
Bill Wendlingeb907212009-05-15 01:12:28 +000065 // Begin eh frame section.
Chris Lattner8c6ed052009-09-16 01:46:41 +000066 Asm->OutStreamer.SwitchSection(TLOF.getEHFrameSection());
Bill Wendlingeb907212009-05-15 01:12:28 +000067
Chris Lattner974c0fb2010-03-10 02:48:06 +000068 MCSymbol *EHFrameSym;
Chris Lattner09d53fe2010-03-10 07:20:42 +000069 if (TLOF.isFunctionEHFrameSymbolPrivate())
Chris Lattner974c0fb2010-03-10 02:48:06 +000070 EHFrameSym = getDWLabel("EH_frame", Index);
71 else
72 EHFrameSym = Asm->OutContext.GetOrCreateSymbol(Twine("EH_frame") +
73 Twine(Index));
74 Asm->OutStreamer.EmitLabel(EHFrameSym);
Chris Lattner8c6ed052009-09-16 01:46:41 +000075
Chris Lattnerf829eef2010-03-08 22:44:40 +000076 Asm->OutStreamer.EmitLabel(getDWLabel("section_eh_frame", Index));
Bill Wendlingeb907212009-05-15 01:12:28 +000077
78 // Define base labels.
Chris Lattnerf829eef2010-03-08 22:44:40 +000079 Asm->OutStreamer.EmitLabel(getDWLabel("eh_frame_common", Index));
Bill Wendlingeb907212009-05-15 01:12:28 +000080
81 // Define the eh frame length.
Chris Lattner233f52b2010-03-09 23:52:58 +000082 Asm->OutStreamer.AddComment("Length of Common Information Entry");
Chris Lattnereffa8682010-03-08 23:02:59 +000083 EmitDifference(getDWLabel("eh_frame_common_end", Index),
84 getDWLabel("eh_frame_common_begin", Index), true);
Bill Wendlingeb907212009-05-15 01:12:28 +000085
86 // EH frame header.
Chris Lattnerf829eef2010-03-08 22:44:40 +000087 Asm->OutStreamer.EmitLabel(getDWLabel("eh_frame_common_begin", Index));
Chris Lattner233f52b2010-03-09 23:52:58 +000088 Asm->OutStreamer.AddComment("CIE Identifier Tag");
Chris Lattnerbcb83e52010-01-20 07:41:15 +000089 Asm->OutStreamer.EmitIntValue(0, 4/*size*/, 0/*addrspace*/);
Chris Lattner233f52b2010-03-09 23:52:58 +000090 Asm->OutStreamer.AddComment("DW_CIE_VERSION");
Chris Lattner066c9ac2010-01-22 22:23:57 +000091 Asm->OutStreamer.EmitIntValue(dwarf::DW_CIE_VERSION, 1/*size*/, 0/*addr*/);
Bill Wendlingeb907212009-05-15 01:12:28 +000092
93 // The personality presence indicates that language specific information will
Chris Lattner8c6ed052009-09-16 01:46:41 +000094 // show up in the eh frame. Find out how we are supposed to lower the
95 // personality function reference:
Anton Korobeynikov9184b252010-02-15 22:35:59 +000096
97 unsigned LSDAEncoding = TLOF.getLSDAEncoding();
98 unsigned FDEEncoding = TLOF.getFDEEncoding();
99 unsigned PerEncoding = TLOF.getPersonalityEncoding();
Bill Wendling52783c62009-09-09 23:56:55 +0000100
Chris Lattner4cf202b2010-01-23 03:11:46 +0000101 char Augmentation[6] = { 0 };
Bill Wendling52783c62009-09-09 23:56:55 +0000102 unsigned AugmentationSize = 0;
103 char *APtr = Augmentation + 1;
104
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000105 if (PersonalityFn) {
Bill Wendling52783c62009-09-09 23:56:55 +0000106 // There is a personality function.
107 *APtr++ = 'P';
108 AugmentationSize += 1 + SizeOfEncodedValue(PerEncoding);
109 }
110
111 if (UsesLSDA[Index]) {
112 // An LSDA pointer is in the FDE augmentation.
113 *APtr++ = 'L';
114 ++AugmentationSize;
115 }
116
117 if (FDEEncoding != dwarf::DW_EH_PE_absptr) {
118 // A non-default pointer encoding for the FDE.
119 *APtr++ = 'R';
120 ++AugmentationSize;
121 }
122
123 if (APtr != Augmentation + 1)
124 Augmentation[0] = 'z';
125
Chris Lattner233f52b2010-03-09 23:52:58 +0000126 Asm->OutStreamer.AddComment("CIE Augmentation");
Chris Lattner4cf202b2010-01-23 03:11:46 +0000127 Asm->OutStreamer.EmitBytes(StringRef(Augmentation, strlen(Augmentation)+1),0);
Bill Wendlingeb907212009-05-15 01:12:28 +0000128
129 // Round out reader.
Chris Lattner894d75a2010-01-22 23:18:42 +0000130 EmitULEB128(1, "CIE Code Alignment Factor");
Chris Lattnerbb9078a2010-01-22 22:56:55 +0000131 EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
Chris Lattner233f52b2010-03-09 23:52:58 +0000132 Asm->OutStreamer.AddComment("CIE Return Address Column");
Bill Wendlingeb907212009-05-15 01:12:28 +0000133 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
Bill Wendlingeb907212009-05-15 01:12:28 +0000134
Anton Korobeynikovac8a3d02010-02-15 22:36:41 +0000135 if (Augmentation[0]) {
136 EmitULEB128(AugmentationSize, "Augmentation Size");
Bill Wendling52783c62009-09-09 23:56:55 +0000137
Anton Korobeynikovac8a3d02010-02-15 22:36:41 +0000138 // If there is a personality, we need to indicate the function's location.
139 if (PersonalityFn) {
140 EmitEncodingByte(PerEncoding, "Personality");
Chris Lattner233f52b2010-03-09 23:52:58 +0000141 Asm->OutStreamer.AddComment("Personality");
Anton Korobeynikovac8a3d02010-02-15 22:36:41 +0000142 EmitReference(PersonalityFn, PerEncoding);
Anton Korobeynikovac8a3d02010-02-15 22:36:41 +0000143 }
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000144 if (UsesLSDA[Index])
145 EmitEncodingByte(LSDAEncoding, "LSDA");
146 if (FDEEncoding != dwarf::DW_EH_PE_absptr)
147 EmitEncodingByte(FDEEncoding, "FDE");
Bill Wendlingeb907212009-05-15 01:12:28 +0000148 }
149
150 // Indicate locations of general callee saved registers in frame.
151 std::vector<MachineMove> Moves;
152 RI->getInitialFrameState(Moves);
Chris Lattner5e6cbe02010-03-13 08:05:25 +0000153 EmitFrameMoves(0, Moves, true);
Bill Wendlingeb907212009-05-15 01:12:28 +0000154
155 // On Darwin the linker honors the alignment of eh_frame, which means it must
156 // be 8-byte on 64-bit targets to match what gcc does. Otherwise you get
157 // holes which confuse readers of eh_frame.
Chris Lattner8c6ed052009-09-16 01:46:41 +0000158 Asm->EmitAlignment(TD->getPointerSize() == 4 ? 2 : 3, 0, 0, false);
Chris Lattnerf829eef2010-03-08 22:44:40 +0000159 Asm->OutStreamer.EmitLabel(getDWLabel("eh_frame_common_end", Index));
Bill Wendlingeb907212009-05-15 01:12:28 +0000160}
161
Bill Wendling7ccda0f2009-08-25 08:08:33 +0000162/// EmitFDE - Emit the Frame Description Entry (FDE) for the function.
163void DwarfException::EmitFDE(const FunctionEHFrameInfo &EHFrameInfo) {
Eric Christopherdbfcdb92009-08-28 22:33:43 +0000164 assert(!EHFrameInfo.function->hasAvailableExternallyLinkage() &&
Bill Wendlingeb907212009-05-15 01:12:28 +0000165 "Should not emit 'available externally' functions at all");
166
Chris Lattner3e0f60b2009-07-17 21:00:50 +0000167 const Function *TheFunc = EHFrameInfo.function;
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000168 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Eric Christopherdbfcdb92009-08-28 22:33:43 +0000169
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000170 unsigned LSDAEncoding = TLOF.getLSDAEncoding();
171 unsigned FDEEncoding = TLOF.getFDEEncoding();
172
173 Asm->OutStreamer.SwitchSection(TLOF.getEHFrameSection());
Eric Christopherdbfcdb92009-08-28 22:33:43 +0000174
Bill Wendlingeb907212009-05-15 01:12:28 +0000175 // Externally visible entry into the functions eh frame info. If the
176 // corresponding function is static, this should not be externally visible.
Chris Lattner09d53fe2010-03-10 07:20:42 +0000177 if (!TheFunc->hasLocalLinkage() && TLOF.isFunctionEHSymbolGlobal())
178 Asm->OutStreamer.EmitSymbolAttribute(EHFrameInfo.FunctionEHSym,MCSA_Global);
Bill Wendlingeb907212009-05-15 01:12:28 +0000179
180 // If corresponding function is weak definition, this should be too.
Chris Lattner10b318b2010-01-17 21:43:43 +0000181 if (TheFunc->isWeakForLinker() && MAI->getWeakDefDirective())
Chris Lattner974c0fb2010-03-10 02:48:06 +0000182 Asm->OutStreamer.EmitSymbolAttribute(EHFrameInfo.FunctionEHSym,
183 MCSA_WeakDefinition);
Bill Wendlingee161a62009-11-11 01:24:59 +0000184
185 // If corresponding function is hidden, this should be too.
186 if (TheFunc->hasHiddenVisibility())
Chris Lattner152a29b2010-01-23 06:53:23 +0000187 if (MCSymbolAttr HiddenAttr = MAI->getHiddenVisibilityAttr())
188 Asm->OutStreamer.EmitSymbolAttribute(EHFrameInfo.FunctionEHSym,
189 HiddenAttr);
Bill Wendlingeb907212009-05-15 01:12:28 +0000190
191 // If there are no calls then you can't unwind. This may mean we can omit the
192 // EH Frame, but some environments do not handle weak absolute symbols. If
193 // UnwindTablesMandatory is set we cannot do this optimization; the unwind
194 // info is to be available for non-EH uses.
Chris Lattner3e0f60b2009-07-17 21:00:50 +0000195 if (!EHFrameInfo.hasCalls && !UnwindTablesMandatory &&
196 (!TheFunc->isWeakForLinker() ||
Chris Lattner33adcfb2009-08-22 21:43:10 +0000197 !MAI->getWeakDefDirective() ||
Chris Lattner09d53fe2010-03-10 07:20:42 +0000198 TLOF.getSupportsWeakOmittedEHFrame())) {
Chris Lattner974c0fb2010-03-10 02:48:06 +0000199 Asm->OutStreamer.EmitAssignment(EHFrameInfo.FunctionEHSym,
200 MCConstantExpr::Create(0, Asm->OutContext));
Bill Wendlingeb907212009-05-15 01:12:28 +0000201 // This name has no connection to the function, so it might get
202 // dead-stripped when the function is not, erroneously. Prohibit
203 // dead-stripping unconditionally.
Chris Lattner3a9be0e2010-01-23 05:51:36 +0000204 if (MAI->hasNoDeadStrip())
205 Asm->OutStreamer.EmitSymbolAttribute(EHFrameInfo.FunctionEHSym,
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000206 MCSA_NoDeadStrip);
Bill Wendlingeb907212009-05-15 01:12:28 +0000207 } else {
Chris Lattner974c0fb2010-03-10 02:48:06 +0000208 Asm->OutStreamer.EmitLabel(EHFrameInfo.FunctionEHSym);
Bill Wendlingeb907212009-05-15 01:12:28 +0000209
210 // EH frame header.
Chris Lattner233f52b2010-03-09 23:52:58 +0000211 Asm->OutStreamer.AddComment("Length of Frame Information Entry");
Chris Lattnereffa8682010-03-08 23:02:59 +0000212 EmitDifference(getDWLabel("eh_frame_end", EHFrameInfo.Number),
213 getDWLabel("eh_frame_begin", EHFrameInfo.Number),
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000214 true);
Bill Wendlingeb907212009-05-15 01:12:28 +0000215
Chris Lattnerf829eef2010-03-08 22:44:40 +0000216 Asm->OutStreamer.EmitLabel(getDWLabel("eh_frame_begin",EHFrameInfo.Number));
Bill Wendlingeb907212009-05-15 01:12:28 +0000217
Chris Lattner233f52b2010-03-09 23:52:58 +0000218 Asm->OutStreamer.AddComment("FDE CIE offset");
Chris Lattnerb98b1bf2010-03-08 22:23:36 +0000219 EmitSectionOffset(getDWLabel("eh_frame_begin", EHFrameInfo.Number),
220 getDWLabel("eh_frame_common",
221 EHFrameInfo.PersonalityIndex),
Chris Lattner57578762010-03-08 23:23:25 +0000222 true, true);
Bill Wendlingeb907212009-05-15 01:12:28 +0000223
Chris Lattnerfb658072010-03-13 07:40:56 +0000224 MCSymbol *EHFuncBeginSym = getDWLabel("eh_func_begin", EHFrameInfo.Number);
Bill Wendlingeb907212009-05-15 01:12:28 +0000225
Chris Lattner233f52b2010-03-09 23:52:58 +0000226 Asm->OutStreamer.AddComment("FDE initial location");
Chris Lattnerfb658072010-03-13 07:40:56 +0000227 EmitReference(EHFuncBeginSym, FDEEncoding);
228
Chris Lattner233f52b2010-03-09 23:52:58 +0000229 Asm->OutStreamer.AddComment("FDE address range");
Chris Lattnerfb658072010-03-13 07:40:56 +0000230 EmitDifference(getDWLabel("eh_func_end", EHFrameInfo.Number),EHFuncBeginSym,
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000231 SizeOfEncodedValue(FDEEncoding) == 4);
Bill Wendlingeb907212009-05-15 01:12:28 +0000232
233 // If there is a personality and landing pads then point to the language
234 // specific data area in the exception table.
Eric Christopherd44fff72009-08-26 21:30:49 +0000235 if (MMI->getPersonalities()[0] != NULL) {
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000236 unsigned Size = SizeOfEncodedValue(LSDAEncoding);
Duncan Sandsc69d74a2009-08-31 16:45:16 +0000237
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000238 EmitULEB128(Size, "Augmentation size");
Chris Lattner233f52b2010-03-09 23:52:58 +0000239 Asm->OutStreamer.AddComment("Language Specific Data Area");
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000240 if (EHFrameInfo.hasLandingPads)
Chris Lattner326861c2010-03-08 22:50:36 +0000241 EmitReference(getDWLabel("exception", EHFrameInfo.Number),LSDAEncoding);
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000242 else
243 Asm->OutStreamer.EmitIntValue(0, Size/*size*/, 0/*addrspace*/);
Bill Wendlingd58e9cb2010-01-16 01:40:55 +0000244
Bill Wendlingeb907212009-05-15 01:12:28 +0000245 } else {
Chris Lattner894d75a2010-01-22 23:18:42 +0000246 EmitULEB128(0, "Augmentation size");
Bill Wendlingeb907212009-05-15 01:12:28 +0000247 }
248
249 // Indicate locations of function specific callee saved registers in frame.
Chris Lattner5e6cbe02010-03-13 08:05:25 +0000250 EmitFrameMoves(EHFuncBeginSym, EHFrameInfo.Moves, true);
Bill Wendlingeb907212009-05-15 01:12:28 +0000251
252 // On Darwin the linker honors the alignment of eh_frame, which means it
253 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise you
254 // get holes which confuse readers of eh_frame.
255 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
256 0, 0, false);
Chris Lattnerf829eef2010-03-08 22:44:40 +0000257 Asm->OutStreamer.EmitLabel(getDWLabel("eh_frame_end", EHFrameInfo.Number));
Bill Wendlingeb907212009-05-15 01:12:28 +0000258
259 // If the function is marked used, this table should be also. We cannot
260 // make the mark unconditional in this case, since retaining the table also
261 // retains the function in this case, and there is code around that depends
262 // on unused functions (calling undefined externals) being dead-stripped to
263 // link correctly. Yes, there really is.
Chris Lattner401e10c2009-07-20 06:14:25 +0000264 if (MMI->isUsedFunction(EHFrameInfo.function))
Chris Lattner3a9be0e2010-01-23 05:51:36 +0000265 if (MAI->hasNoDeadStrip())
266 Asm->OutStreamer.EmitSymbolAttribute(EHFrameInfo.FunctionEHSym,
Chris Lattnera5ad93a2010-01-23 06:39:22 +0000267 MCSA_NoDeadStrip);
Bill Wendlingeb907212009-05-15 01:12:28 +0000268 }
Chris Lattner188a87d2010-03-10 01:04:13 +0000269 Asm->OutStreamer.AddBlankLine();
Bill Wendlingeb907212009-05-15 01:12:28 +0000270}
271
Bill Wendlingeb907212009-05-15 01:12:28 +0000272/// SharedTypeIds - How many leading type ids two landing pads have in common.
273unsigned DwarfException::SharedTypeIds(const LandingPadInfo *L,
274 const LandingPadInfo *R) {
275 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
276 unsigned LSize = LIds.size(), RSize = RIds.size();
277 unsigned MinSize = LSize < RSize ? LSize : RSize;
278 unsigned Count = 0;
279
280 for (; Count != MinSize; ++Count)
281 if (LIds[Count] != RIds[Count])
282 return Count;
283
284 return Count;
285}
286
287/// PadLT - Order landing pads lexicographically by type id.
288bool DwarfException::PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
289 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
290 unsigned LSize = LIds.size(), RSize = RIds.size();
291 unsigned MinSize = LSize < RSize ? LSize : RSize;
292
293 for (unsigned i = 0; i != MinSize; ++i)
294 if (LIds[i] != RIds[i])
295 return LIds[i] < RIds[i];
296
297 return LSize < RSize;
298}
299
Bill Wendlingd4609622009-07-28 23:23:00 +0000300/// ComputeActionsTable - Compute the actions table and gather the first action
301/// index for each landing pad site.
Bill Wendlingade025c2009-07-29 00:31:35 +0000302unsigned DwarfException::
303ComputeActionsTable(const SmallVectorImpl<const LandingPadInfo*> &LandingPads,
304 SmallVectorImpl<ActionEntry> &Actions,
305 SmallVectorImpl<unsigned> &FirstActions) {
Bill Wendlinga583c552009-08-20 22:02:24 +0000306
307 // The action table follows the call-site table in the LSDA. The individual
308 // records are of two types:
309 //
310 // * Catch clause
311 // * Exception specification
312 //
313 // The two record kinds have the same format, with only small differences.
314 // They are distinguished by the "switch value" field: Catch clauses
315 // (TypeInfos) have strictly positive switch values, and exception
316 // specifications (FilterIds) have strictly negative switch values. Value 0
317 // indicates a catch-all clause.
318 //
Bill Wendling5e953dd2009-07-28 23:22:13 +0000319 // Negative type IDs index into FilterIds. Positive type IDs index into
320 // TypeInfos. The value written for a positive type ID is just the type ID
321 // itself. For a negative type ID, however, the value written is the
Bill Wendlingeb907212009-05-15 01:12:28 +0000322 // (negative) byte offset of the corresponding FilterIds entry. The byte
Bill Wendling5e953dd2009-07-28 23:22:13 +0000323 // offset is usually equal to the type ID (because the FilterIds entries are
324 // written using a variable width encoding, which outputs one byte per entry
325 // as long as the value written is not too large) but can differ. This kind
326 // of complication does not occur for positive type IDs because type infos are
Bill Wendlingeb907212009-05-15 01:12:28 +0000327 // output using a fixed width encoding. FilterOffsets[i] holds the byte
328 // offset corresponding to FilterIds[i].
Bill Wendling409914b2009-07-29 21:19:44 +0000329
330 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
Bill Wendlingeb907212009-05-15 01:12:28 +0000331 SmallVector<int, 16> FilterOffsets;
332 FilterOffsets.reserve(FilterIds.size());
333 int Offset = -1;
Bill Wendling409914b2009-07-29 21:19:44 +0000334
335 for (std::vector<unsigned>::const_iterator
336 I = FilterIds.begin(), E = FilterIds.end(); I != E; ++I) {
Bill Wendlingeb907212009-05-15 01:12:28 +0000337 FilterOffsets.push_back(Offset);
Chris Lattneraf76e592009-08-22 20:48:53 +0000338 Offset -= MCAsmInfo::getULEB128Size(*I);
Bill Wendlingeb907212009-05-15 01:12:28 +0000339 }
340
Bill Wendlingeb907212009-05-15 01:12:28 +0000341 FirstActions.reserve(LandingPads.size());
342
343 int FirstAction = 0;
344 unsigned SizeActions = 0;
Bill Wendling5e953dd2009-07-28 23:22:13 +0000345 const LandingPadInfo *PrevLPI = 0;
Bill Wendling409914b2009-07-29 21:19:44 +0000346
Bill Wendling5cff4872009-07-28 23:44:43 +0000347 for (SmallVectorImpl<const LandingPadInfo *>::const_iterator
Bill Wendling5e953dd2009-07-28 23:22:13 +0000348 I = LandingPads.begin(), E = LandingPads.end(); I != E; ++I) {
349 const LandingPadInfo *LPI = *I;
350 const std::vector<int> &TypeIds = LPI->TypeIds;
351 const unsigned NumShared = PrevLPI ? SharedTypeIds(LPI, PrevLPI) : 0;
Bill Wendlingeb907212009-05-15 01:12:28 +0000352 unsigned SizeSiteActions = 0;
353
354 if (NumShared < TypeIds.size()) {
355 unsigned SizeAction = 0;
Bill Wendling0a9abcb2010-02-10 21:41:57 +0000356 unsigned PrevAction = (unsigned)-1;
Bill Wendlingeb907212009-05-15 01:12:28 +0000357
358 if (NumShared) {
Bill Wendling5e953dd2009-07-28 23:22:13 +0000359 const unsigned SizePrevIds = PrevLPI->TypeIds.size();
Bill Wendlingeb907212009-05-15 01:12:28 +0000360 assert(Actions.size());
Bill Wendling0a9abcb2010-02-10 21:41:57 +0000361 PrevAction = Actions.size() - 1;
362 SizeAction =
363 MCAsmInfo::getSLEB128Size(Actions[PrevAction].NextAction) +
364 MCAsmInfo::getSLEB128Size(Actions[PrevAction].ValueForTypeID);
Bill Wendlingeb907212009-05-15 01:12:28 +0000365
366 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
Bill Wendling0a9abcb2010-02-10 21:41:57 +0000367 assert(PrevAction != (unsigned)-1 && "PrevAction is invalid!");
Bill Wendlingeb907212009-05-15 01:12:28 +0000368 SizeAction -=
Bill Wendling0a9abcb2010-02-10 21:41:57 +0000369 MCAsmInfo::getSLEB128Size(Actions[PrevAction].ValueForTypeID);
370 SizeAction += -Actions[PrevAction].NextAction;
371 PrevAction = Actions[PrevAction].Previous;
Bill Wendlingeb907212009-05-15 01:12:28 +0000372 }
373 }
374
375 // Compute the actions.
Bill Wendling5e953dd2009-07-28 23:22:13 +0000376 for (unsigned J = NumShared, M = TypeIds.size(); J != M; ++J) {
377 int TypeID = TypeIds[J];
378 assert(-1 - TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
Bill Wendlingeb907212009-05-15 01:12:28 +0000379 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
Chris Lattneraf76e592009-08-22 20:48:53 +0000380 unsigned SizeTypeID = MCAsmInfo::getSLEB128Size(ValueForTypeID);
Bill Wendlingeb907212009-05-15 01:12:28 +0000381
382 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
Chris Lattneraf76e592009-08-22 20:48:53 +0000383 SizeAction = SizeTypeID + MCAsmInfo::getSLEB128Size(NextAction);
Bill Wendlingeb907212009-05-15 01:12:28 +0000384 SizeSiteActions += SizeAction;
385
Bill Wendlinga583c552009-08-20 22:02:24 +0000386 ActionEntry Action = { ValueForTypeID, NextAction, PrevAction };
Bill Wendlingeb907212009-05-15 01:12:28 +0000387 Actions.push_back(Action);
Bill Wendling0a9abcb2010-02-10 21:41:57 +0000388 PrevAction = Actions.size() - 1;
Bill Wendlingeb907212009-05-15 01:12:28 +0000389 }
390
391 // Record the first action of the landing pad site.
392 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
393 } // else identical - re-use previous FirstAction
394
Bill Wendlinga583c552009-08-20 22:02:24 +0000395 // Information used when created the call-site table. The action record
396 // field of the call site record is the offset of the first associated
397 // action record, relative to the start of the actions table. This value is
Bill Wendling0a9abcb2010-02-10 21:41:57 +0000398 // biased by 1 (1 indicating the start of the actions table), and 0
Bill Wendlinga583c552009-08-20 22:02:24 +0000399 // indicates that there are no actions.
Bill Wendlingeb907212009-05-15 01:12:28 +0000400 FirstActions.push_back(FirstAction);
401
402 // Compute this sites contribution to size.
403 SizeActions += SizeSiteActions;
Bill Wendling5e953dd2009-07-28 23:22:13 +0000404
405 PrevLPI = LPI;
Bill Wendlingeb907212009-05-15 01:12:28 +0000406 }
407
Bill Wendling5e953dd2009-07-28 23:22:13 +0000408 return SizeActions;
409}
410
Bill Wendlinged060dc2009-11-12 21:59:20 +0000411/// CallToNoUnwindFunction - Return `true' if this is a call to a function
412/// marked `nounwind'. Return `false' otherwise.
413bool DwarfException::CallToNoUnwindFunction(const MachineInstr *MI) {
414 assert(MI->getDesc().isCall() && "This should be a call instruction!");
415
416 bool MarkedNoUnwind = false;
417 bool SawFunc = false;
418
419 for (unsigned I = 0, E = MI->getNumOperands(); I != E; ++I) {
420 const MachineOperand &MO = MI->getOperand(I);
421
Chris Lattnercfd31882010-03-31 06:09:04 +0000422 if (!MO.isGlobal()) continue;
423
424 Function *F = dyn_cast<Function>(MO.getGlobal());
425 if (F == 0) continue;
Bill Wendlingecc260e2009-11-12 23:13:08 +0000426
Chris Lattnercfd31882010-03-31 06:09:04 +0000427 if (SawFunc) {
428 // Be conservative. If we have more than one function operand for this
429 // call, then we can't make the assumption that it's the callee and
430 // not a parameter to the call.
431 //
432 // FIXME: Determine if there's a way to say that `F' is the callee or
433 // parameter.
434 MarkedNoUnwind = false;
435 break;
Bill Wendlinged060dc2009-11-12 21:59:20 +0000436 }
Chris Lattnercfd31882010-03-31 06:09:04 +0000437
438 MarkedNoUnwind = F->doesNotThrow();
439 SawFunc = true;
Bill Wendlinged060dc2009-11-12 21:59:20 +0000440 }
441
442 return MarkedNoUnwind;
443}
444
Bill Wendlingade025c2009-07-29 00:31:35 +0000445/// ComputeCallSiteTable - Compute the call-site table. The entry for an invoke
Bill Wendlinga583c552009-08-20 22:02:24 +0000446/// has a try-range containing the call, a non-zero landing pad, and an
Bill Wendlingade025c2009-07-29 00:31:35 +0000447/// appropriate action. The entry for an ordinary call has a try-range
448/// containing the call and zero for the landing pad and the action. Calls
449/// marked 'nounwind' have no entry and must not be contained in the try-range
450/// of any entry - they form gaps in the table. Entries must be ordered by
451/// try-range address.
452void DwarfException::
453ComputeCallSiteTable(SmallVectorImpl<CallSiteEntry> &CallSites,
454 const RangeMapType &PadMap,
455 const SmallVectorImpl<const LandingPadInfo *> &LandingPads,
456 const SmallVectorImpl<unsigned> &FirstActions) {
Bill Wendlingeb907212009-05-15 01:12:28 +0000457 // The end label of the previous invoke or nounwind try-range.
Chris Lattner16112732010-03-14 01:41:15 +0000458 MCSymbol *LastLabel = 0;
Bill Wendlingeb907212009-05-15 01:12:28 +0000459
460 // Whether there is a potentially throwing instruction (currently this means
461 // an ordinary call) between the end of the previous try-range and now.
462 bool SawPotentiallyThrowing = false;
463
Bill Wendling5cff4872009-07-28 23:44:43 +0000464 // Whether the last CallSite entry was for an invoke.
Bill Wendlingeb907212009-05-15 01:12:28 +0000465 bool PreviousIsInvoke = false;
466
467 // Visit all instructions in order of address.
468 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
469 I != E; ++I) {
470 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
471 MI != E; ++MI) {
472 if (!MI->isLabel()) {
Bill Wendlinged060dc2009-11-12 21:59:20 +0000473 if (MI->getDesc().isCall())
474 SawPotentiallyThrowing |= !CallToNoUnwindFunction(MI);
Bill Wendlingeb907212009-05-15 01:12:28 +0000475 continue;
476 }
477
Bill Wendlingeb907212009-05-15 01:12:28 +0000478 // End of the previous try-range?
Chris Lattner0397ada2010-03-14 08:17:53 +0000479 MCSymbol *BeginLabel = MI->getOperand(0).getMCSymbol();
Bill Wendlingeb907212009-05-15 01:12:28 +0000480 if (BeginLabel == LastLabel)
481 SawPotentiallyThrowing = false;
482
483 // Beginning of a new try-range?
Jeffrey Yasskin81cf4322009-11-10 01:02:17 +0000484 RangeMapType::const_iterator L = PadMap.find(BeginLabel);
Bill Wendlingeb907212009-05-15 01:12:28 +0000485 if (L == PadMap.end())
486 // Nope, it was just some random label.
487 continue;
488
Bill Wendlinga583c552009-08-20 22:02:24 +0000489 const PadRange &P = L->second;
Bill Wendlingeb907212009-05-15 01:12:28 +0000490 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
Bill Wendlingeb907212009-05-15 01:12:28 +0000491 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
492 "Inconsistent landing pad map!");
493
Bill Wendlinga583c552009-08-20 22:02:24 +0000494 // For Dwarf exception handling (SjLj handling doesn't use this). If some
495 // instruction between the previous try-range and this one may throw,
496 // create a call-site entry with no landing pad for the region between the
497 // try-ranges.
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000498 if (SawPotentiallyThrowing &&
Chris Lattner33adcfb2009-08-22 21:43:10 +0000499 MAI->getExceptionHandlingType() == ExceptionHandling::Dwarf) {
Bill Wendlinga583c552009-08-20 22:02:24 +0000500 CallSiteEntry Site = { LastLabel, BeginLabel, 0, 0 };
Bill Wendlingeb907212009-05-15 01:12:28 +0000501 CallSites.push_back(Site);
502 PreviousIsInvoke = false;
503 }
504
505 LastLabel = LandingPad->EndLabels[P.RangeIndex];
506 assert(BeginLabel && LastLabel && "Invalid landing pad!");
507
Chris Lattnercfd31882010-03-31 06:09:04 +0000508 if (!LandingPad->LandingPadLabel) {
509 // Create a gap.
510 PreviousIsInvoke = false;
511 } else {
Bill Wendlingeb907212009-05-15 01:12:28 +0000512 // This try-range is for an invoke.
Bill Wendlinga583c552009-08-20 22:02:24 +0000513 CallSiteEntry Site = {
514 BeginLabel,
515 LastLabel,
516 LandingPad->LandingPadLabel,
517 FirstActions[P.PadIndex]
518 };
Bill Wendlingeb907212009-05-15 01:12:28 +0000519
Jim Grosbach33668c02009-09-01 17:19:13 +0000520 // Try to merge with the previous call-site. SJLJ doesn't do this
521 if (PreviousIsInvoke &&
522 MAI->getExceptionHandlingType() == ExceptionHandling::Dwarf) {
Bill Wendlingeb907212009-05-15 01:12:28 +0000523 CallSiteEntry &Prev = CallSites.back();
524 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
525 // Extend the range of the previous entry.
526 Prev.EndLabel = Site.EndLabel;
527 continue;
528 }
529 }
530
531 // Otherwise, create a new call-site.
Jim Grosbachca752c92010-01-28 01:45:32 +0000532 if (MAI->getExceptionHandlingType() == ExceptionHandling::Dwarf)
533 CallSites.push_back(Site);
534 else {
535 // SjLj EH must maintain the call sites in the order assigned
536 // to them by the SjLjPrepare pass.
537 unsigned SiteNo = MMI->getCallSiteBeginLabel(BeginLabel);
538 if (CallSites.size() < SiteNo)
539 CallSites.resize(SiteNo);
540 CallSites[SiteNo - 1] = Site;
541 }
Bill Wendlingeb907212009-05-15 01:12:28 +0000542 PreviousIsInvoke = true;
Bill Wendlingeb907212009-05-15 01:12:28 +0000543 }
544 }
545 }
546
547 // If some instruction between the previous try-range and the end of the
548 // function may throw, create a call-site entry with no landing pad for the
549 // region following the try-range.
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000550 if (SawPotentiallyThrowing &&
Chris Lattner33adcfb2009-08-22 21:43:10 +0000551 MAI->getExceptionHandlingType() == ExceptionHandling::Dwarf) {
Bill Wendlinga583c552009-08-20 22:02:24 +0000552 CallSiteEntry Site = { LastLabel, 0, 0, 0 };
Bill Wendlingeb907212009-05-15 01:12:28 +0000553 CallSites.push_back(Site);
554 }
Bill Wendlingade025c2009-07-29 00:31:35 +0000555}
556
Bill Wendling0dafca92009-07-29 00:50:05 +0000557/// EmitExceptionTable - Emit landing pads and actions.
558///
559/// The general organization of the table is complex, but the basic concepts are
560/// easy. First there is a header which describes the location and organization
561/// of the three components that follow.
Eric Christopherdbfcdb92009-08-28 22:33:43 +0000562///
Bill Wendling0dafca92009-07-29 00:50:05 +0000563/// 1. The landing pad site information describes the range of code covered by
564/// the try. In our case it's an accumulation of the ranges covered by the
565/// invokes in the try. There is also a reference to the landing pad that
566/// handles the exception once processed. Finally an index into the actions
567/// table.
Bill Wendlinga583c552009-08-20 22:02:24 +0000568/// 2. The action table, in our case, is composed of pairs of type IDs and next
Bill Wendling0dafca92009-07-29 00:50:05 +0000569/// action offset. Starting with the action index from the landing pad
Bill Wendlinga583c552009-08-20 22:02:24 +0000570/// site, each type ID is checked for a match to the current exception. If
Bill Wendling0dafca92009-07-29 00:50:05 +0000571/// it matches then the exception and type id are passed on to the landing
572/// pad. Otherwise the next action is looked up. This chain is terminated
Bill Wendling28275fd2009-09-10 06:50:01 +0000573/// with a next action of zero. If no type id is found then the frame is
Bill Wendling0dafca92009-07-29 00:50:05 +0000574/// unwound and handling continues.
Bill Wendlinga583c552009-08-20 22:02:24 +0000575/// 3. Type ID table contains references to all the C++ typeinfo for all
Bill Wendling28275fd2009-09-10 06:50:01 +0000576/// catches in the function. This tables is reverse indexed base 1.
Bill Wendlingade025c2009-07-29 00:31:35 +0000577void DwarfException::EmitExceptionTable() {
578 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
579 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
580 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
Bill Wendlingade025c2009-07-29 00:31:35 +0000581
582 // Sort the landing pads in order of their type ids. This is used to fold
583 // duplicate actions.
584 SmallVector<const LandingPadInfo *, 64> LandingPads;
585 LandingPads.reserve(PadInfos.size());
586
587 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
588 LandingPads.push_back(&PadInfos[i]);
589
590 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
591
592 // Compute the actions table and gather the first action index for each
593 // landing pad site.
594 SmallVector<ActionEntry, 32> Actions;
595 SmallVector<unsigned, 64> FirstActions;
Bill Wendling0a9abcb2010-02-10 21:41:57 +0000596 unsigned SizeActions=ComputeActionsTable(LandingPads, Actions, FirstActions);
Bill Wendlingade025c2009-07-29 00:31:35 +0000597
598 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
599 // by try-range labels when lowered). Ordinary calls do not, so appropriate
Bill Wendling28275fd2009-09-10 06:50:01 +0000600 // try-ranges for them need be deduced when using DWARF exception handling.
Bill Wendlingade025c2009-07-29 00:31:35 +0000601 RangeMapType PadMap;
602 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
603 const LandingPadInfo *LandingPad = LandingPads[i];
604 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
Chris Lattner16112732010-03-14 01:41:15 +0000605 MCSymbol *BeginLabel = LandingPad->BeginLabels[j];
Bill Wendlingade025c2009-07-29 00:31:35 +0000606 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
607 PadRange P = { i, j };
608 PadMap[BeginLabel] = P;
609 }
610 }
611
612 // Compute the call-site table.
613 SmallVector<CallSiteEntry, 64> CallSites;
Jim Grosbach8b818d72009-08-17 16:41:22 +0000614 ComputeCallSiteTable(CallSites, PadMap, LandingPads, FirstActions);
Bill Wendlingeb907212009-05-15 01:12:28 +0000615
616 // Final tallies.
617
618 // Call sites.
Bill Wendling40121bc2009-09-10 00:13:16 +0000619 const unsigned SiteStartSize = SizeOfEncodedValue(dwarf::DW_EH_PE_udata4);
620 const unsigned SiteLengthSize = SizeOfEncodedValue(dwarf::DW_EH_PE_udata4);
621 const unsigned LandingPadSize = SizeOfEncodedValue(dwarf::DW_EH_PE_udata4);
Bill Wendlingd1a5b372009-09-10 00:17:04 +0000622 bool IsSJLJ = MAI->getExceptionHandlingType() == ExceptionHandling::SjLj;
Bill Wendlingd1a5b372009-09-10 00:17:04 +0000623 bool HaveTTData = IsSJLJ ? (!TypeInfos.empty() || !FilterIds.empty()) : true;
Bill Wendling3dc9b482010-02-24 23:34:35 +0000624 unsigned CallSiteTableLength;
Bill Wendlingd1a5b372009-09-10 00:17:04 +0000625
626 if (IsSJLJ)
Bill Wendling3dc9b482010-02-24 23:34:35 +0000627 CallSiteTableLength = 0;
Bill Wendlingd1a5b372009-09-10 00:17:04 +0000628 else
Bill Wendling3dc9b482010-02-24 23:34:35 +0000629 CallSiteTableLength = CallSites.size() *
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000630 (SiteStartSize + SiteLengthSize + LandingPadSize);
Bill Wendlingd1a5b372009-09-10 00:17:04 +0000631
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000632 for (unsigned i = 0, e = CallSites.size(); i < e; ++i) {
Bill Wendling3dc9b482010-02-24 23:34:35 +0000633 CallSiteTableLength += MCAsmInfo::getULEB128Size(CallSites[i].Action);
Bill Wendlingd1a5b372009-09-10 00:17:04 +0000634 if (IsSJLJ)
Bill Wendling3dc9b482010-02-24 23:34:35 +0000635 CallSiteTableLength += MCAsmInfo::getULEB128Size(i);
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000636 }
Bill Wendlingd1a5b372009-09-10 00:17:04 +0000637
Bill Wendlingeb907212009-05-15 01:12:28 +0000638 // Type infos.
Chris Lattnerd5bbb072009-08-02 01:34:32 +0000639 const MCSection *LSDASection = Asm->getObjFileLowering().getLSDASection();
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000640 unsigned TTypeEncoding;
Bill Wendlinga2f64492009-09-10 06:27:16 +0000641 unsigned TypeFormatSize;
Bill Wendlingeb907212009-05-15 01:12:28 +0000642
Bill Wendling43e484f2009-09-10 01:12:47 +0000643 if (!HaveTTData) {
Bill Wendling28275fd2009-09-10 06:50:01 +0000644 // For SjLj exceptions, if there is no TypeInfo, then we just explicitly say
645 // that we're omitting that bit.
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000646 TTypeEncoding = dwarf::DW_EH_PE_omit;
Bill Wendlinga2f64492009-09-10 06:27:16 +0000647 TypeFormatSize = SizeOfEncodedValue(dwarf::DW_EH_PE_absptr);
Chris Lattner81c9a062009-07-31 22:03:47 +0000648 } else {
Chris Lattnerad88bc42009-08-02 03:59:56 +0000649 // Okay, we have actual filters or typeinfos to emit. As such, we need to
650 // pick a type encoding for them. We're about to emit a list of pointers to
651 // typeinfo objects at the end of the LSDA. However, unless we're in static
652 // mode, this reference will require a relocation by the dynamic linker.
Chris Lattner46b754c2009-07-31 22:18:14 +0000653 //
Chris Lattnerad88bc42009-08-02 03:59:56 +0000654 // Because of this, we have a couple of options:
Bill Wendling28275fd2009-09-10 06:50:01 +0000655 //
Chris Lattnerad88bc42009-08-02 03:59:56 +0000656 // 1) If we are in -static mode, we can always use an absolute reference
657 // from the LSDA, because the static linker will resolve it.
Bill Wendling28275fd2009-09-10 06:50:01 +0000658 //
Chris Lattnerad88bc42009-08-02 03:59:56 +0000659 // 2) Otherwise, if the LSDA section is writable, we can output the direct
660 // reference to the typeinfo and allow the dynamic linker to relocate
661 // it. Since it is in a writable section, the dynamic linker won't
662 // have a problem.
Bill Wendling28275fd2009-09-10 06:50:01 +0000663 //
Chris Lattnerad88bc42009-08-02 03:59:56 +0000664 // 3) Finally, if we're in PIC mode and the LDSA section isn't writable,
665 // we need to use some form of indirection. For example, on Darwin,
666 // we can output a statically-relocatable reference to a dyld stub. The
667 // offset to the stub is constant, but the contents are in a section
668 // that is updated by the dynamic linker. This is easy enough, but we
669 // need to tell the personality function of the unwinder to indirect
670 // through the dyld stub.
671 //
Bill Wendling43e484f2009-09-10 01:12:47 +0000672 // FIXME: When (3) is actually implemented, we'll have to emit the stubs
Chris Lattnerad88bc42009-08-02 03:59:56 +0000673 // somewhere. This predicate should be moved to a shared location that is
674 // in target-independent code.
675 //
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000676 TTypeEncoding = Asm->getObjFileLowering().getTTypeEncoding();
677 TypeFormatSize = SizeOfEncodedValue(TTypeEncoding);
Bill Wendlingfe220282009-09-10 02:07:37 +0000678 }
Bill Wendling43e484f2009-09-10 01:12:47 +0000679
Bill Wendlingfe220282009-09-10 02:07:37 +0000680 // Begin the exception table.
681 Asm->OutStreamer.SwitchSection(LSDASection);
682 Asm->EmitAlignment(2, 0, 0, false);
Bill Wendling43e484f2009-09-10 01:12:47 +0000683
Bill Wendling3dc9b482010-02-24 23:34:35 +0000684 // Emit the LSDA.
Chris Lattner974c0fb2010-03-10 02:48:06 +0000685 MCSymbol *GCCETSym =
686 Asm->OutContext.GetOrCreateSymbol(Twine("GCC_except_table")+
687 Twine(SubprogramCount));
688 Asm->OutStreamer.EmitLabel(GCCETSym);
Chris Lattnerf829eef2010-03-08 22:44:40 +0000689 Asm->OutStreamer.EmitLabel(getDWLabel("exception", SubprogramCount));
Bill Wendlingfe220282009-09-10 02:07:37 +0000690
Chris Lattner974c0fb2010-03-10 02:48:06 +0000691 if (IsSJLJ)
692 Asm->OutStreamer.EmitLabel(getDWLabel("_LSDA_", Asm->getFunctionNumber()));
Bill Wendlingfe220282009-09-10 02:07:37 +0000693
Bill Wendling3dc9b482010-02-24 23:34:35 +0000694 // Emit the LSDA header.
Chris Lattnerf61ed8e2010-01-22 22:38:16 +0000695 EmitEncodingByte(dwarf::DW_EH_PE_omit, "@LPStart");
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000696 EmitEncodingByte(TTypeEncoding, "@TType");
Bill Wendlingfe220282009-09-10 02:07:37 +0000697
Bill Wendling3dc9b482010-02-24 23:34:35 +0000698 // The type infos need to be aligned. GCC does this by inserting padding just
699 // before the type infos. However, this changes the size of the exception
700 // table, so you need to take this into account when you output the exception
701 // table size. However, the size is output using a variable length encoding.
702 // So by increasing the size by inserting padding, you may increase the number
703 // of bytes used for writing the size. If it increases, say by one byte, then
704 // you now need to output one less byte of padding to get the type infos
705 // aligned. However this decreases the size of the exception table. This
706 // changes the value you have to output for the exception table size. Due to
707 // the variable length encoding, the number of bytes used for writing the
708 // length may decrease. If so, you then have to increase the amount of
709 // padding. And so on. If you look carefully at the GCC code you will see that
710 // it indeed does this in a loop, going on and on until the values stabilize.
711 // We chose another solution: don't output padding inside the table like GCC
712 // does, instead output it before the table.
713 unsigned SizeTypes = TypeInfos.size() * TypeFormatSize;
714 unsigned CallSiteTableLengthSize =
715 MCAsmInfo::getULEB128Size(CallSiteTableLength);
716 unsigned TTypeBaseOffset =
717 sizeof(int8_t) + // Call site format
718 CallSiteTableLengthSize + // Call site table length size
719 CallSiteTableLength + // Call site table length
720 SizeActions + // Actions size
721 SizeTypes;
722 unsigned TTypeBaseOffsetSize = MCAsmInfo::getULEB128Size(TTypeBaseOffset);
723 unsigned TotalSize =
724 sizeof(int8_t) + // LPStart format
725 sizeof(int8_t) + // TType format
726 (HaveTTData ? TTypeBaseOffsetSize : 0) + // TType base offset size
727 TTypeBaseOffset; // TType base offset
728 unsigned SizeAlign = (4 - TotalSize) & 3;
729
Bill Wendling86f0d332010-02-25 23:52:44 +0000730 if (HaveTTData) {
Bill Wendling6507eca2010-02-26 21:31:01 +0000731 // Account for any extra padding that will be added to the call site table
Bill Wendlingf7e90ae2010-02-25 21:19:47 +0000732 // length.
Bill Wendling1869ac82010-02-26 22:17:52 +0000733 EmitULEB128(TTypeBaseOffset, "@TType base offset", SizeAlign);
734 SizeAlign = 0;
Bill Wendling86f0d332010-02-25 23:52:44 +0000735 }
Bill Wendlingb0d9c3e2009-07-28 22:23:45 +0000736
Bill Wendling28275fd2009-09-10 06:50:01 +0000737 // SjLj Exception handling
Bill Wendlingd1a5b372009-09-10 00:17:04 +0000738 if (IsSJLJ) {
Chris Lattnerf61ed8e2010-01-22 22:38:16 +0000739 EmitEncodingByte(dwarf::DW_EH_PE_udata4, "Call site");
Bill Wendling1869ac82010-02-26 22:17:52 +0000740
741 // Add extra padding if it wasn't added to the TType base offset.
Bill Wendling3dc9b482010-02-24 23:34:35 +0000742 EmitULEB128(CallSiteTableLength, "Call site table length", SizeAlign);
Bill Wendlingeb907212009-05-15 01:12:28 +0000743
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000744 // Emit the landing pad site information.
Jim Grosbach8b818d72009-08-17 16:41:22 +0000745 unsigned idx = 0;
746 for (SmallVectorImpl<CallSiteEntry>::const_iterator
747 I = CallSites.begin(), E = CallSites.end(); I != E; ++I, ++idx) {
748 const CallSiteEntry &S = *I;
Bill Wendlinga583c552009-08-20 22:02:24 +0000749
750 // Offset of the landing pad, counted in 16-byte bundles relative to the
751 // @LPStart address.
Chris Lattner894d75a2010-01-22 23:18:42 +0000752 EmitULEB128(idx, "Landing pad");
Bill Wendlinga583c552009-08-20 22:02:24 +0000753
754 // Offset of the first associated action record, relative to the start of
755 // the action table. This value is biased by 1 (1 indicates the start of
756 // the action table), and 0 indicates that there are no actions.
Chris Lattner894d75a2010-01-22 23:18:42 +0000757 EmitULEB128(S.Action, "Action");
Bill Wendlingeb907212009-05-15 01:12:28 +0000758 }
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000759 } else {
760 // DWARF Exception handling
Chris Lattner33adcfb2009-08-22 21:43:10 +0000761 assert(MAI->getExceptionHandlingType() == ExceptionHandling::Dwarf);
Bill Wendlingeb907212009-05-15 01:12:28 +0000762
Bill Wendlinga583c552009-08-20 22:02:24 +0000763 // The call-site table is a list of all call sites that may throw an
764 // exception (including C++ 'throw' statements) in the procedure
765 // fragment. It immediately follows the LSDA header. Each entry indicates,
766 // for a given call, the first corresponding action record and corresponding
767 // landing pad.
768 //
769 // The table begins with the number of bytes, stored as an LEB128
770 // compressed, unsigned integer. The records immediately follow the record
771 // count. They are sorted in increasing call-site address. Each record
772 // indicates:
773 //
774 // * The position of the call-site.
775 // * The position of the landing pad.
776 // * The first action record for that call site.
777 //
778 // A missing entry in the call-site table indicates that a call is not
Bill Wendling28275fd2009-09-10 06:50:01 +0000779 // supposed to throw.
Bill Wendlinga583c552009-08-20 22:02:24 +0000780
781 // Emit the landing pad call site table.
Chris Lattnerf61ed8e2010-01-22 22:38:16 +0000782 EmitEncodingByte(dwarf::DW_EH_PE_udata4, "Call site");
Bill Wendling1869ac82010-02-26 22:17:52 +0000783
784 // Add extra padding if it wasn't added to the TType base offset.
Bill Wendling3dc9b482010-02-24 23:34:35 +0000785 EmitULEB128(CallSiteTableLength, "Call site table length", SizeAlign);
Bill Wendlingeb907212009-05-15 01:12:28 +0000786
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000787 for (SmallVectorImpl<CallSiteEntry>::const_iterator
788 I = CallSites.begin(), E = CallSites.end(); I != E; ++I) {
789 const CallSiteEntry &S = *I;
Chris Lattner16112732010-03-14 01:41:15 +0000790
791 MCSymbol *EHFuncBeginSym = getDWLabel("eh_func_begin", SubprogramCount);
792
793 MCSymbol *BeginLabel = S.BeginLabel;
794 if (BeginLabel == 0)
795 BeginLabel = EHFuncBeginSym;
796 MCSymbol *EndLabel = S.EndLabel;
797 if (EndLabel == 0)
798 EndLabel = getDWLabel("eh_func_end", SubprogramCount);
799
Bill Wendlinga583c552009-08-20 22:02:24 +0000800 // Offset of the call site relative to the previous call site, counted in
801 // number of 16-byte bundles. The first call site is counted relative to
802 // the start of the procedure fragment.
Chris Lattner233f52b2010-03-09 23:52:58 +0000803 Asm->OutStreamer.AddComment("Region start");
Chris Lattner21f9c8d2010-03-14 06:50:56 +0000804 EmitSectionOffset(BeginLabel, EHFuncBeginSym, true, true);
Chris Lattner16112732010-03-14 01:41:15 +0000805
Chris Lattner233f52b2010-03-09 23:52:58 +0000806 Asm->OutStreamer.AddComment("Region length");
Chris Lattner16112732010-03-14 01:41:15 +0000807 EmitDifference(EndLabel, BeginLabel, true);
Bill Wendlingeb907212009-05-15 01:12:28 +0000808
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000809
Bill Wendlinga583c552009-08-20 22:02:24 +0000810 // Offset of the landing pad, counted in 16-byte bundles relative to the
811 // @LPStart address.
Chris Lattner233f52b2010-03-09 23:52:58 +0000812 Asm->OutStreamer.AddComment("Landing pad");
Chris Lattner16112732010-03-14 01:41:15 +0000813 if (!S.PadLabel)
Chris Lattnerbcb83e52010-01-20 07:41:15 +0000814 Asm->OutStreamer.EmitIntValue(0, 4/*size*/, 0/*addrspace*/);
Chris Lattner16112732010-03-14 01:41:15 +0000815 else
816 EmitSectionOffset(S.PadLabel, EHFuncBeginSym, true, true);
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000817
Bill Wendlinga583c552009-08-20 22:02:24 +0000818 // Offset of the first associated action record, relative to the start of
819 // the action table. This value is biased by 1 (1 indicates the start of
820 // the action table), and 0 indicates that there are no actions.
Chris Lattner894d75a2010-01-22 23:18:42 +0000821 EmitULEB128(S.Action, "Action");
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000822 }
Bill Wendlingeb907212009-05-15 01:12:28 +0000823 }
824
Bill Wendlinga583c552009-08-20 22:02:24 +0000825 // Emit the Action Table.
Chris Lattner233f52b2010-03-09 23:52:58 +0000826 if (Actions.size() != 0) {
827 Asm->OutStreamer.AddComment("-- Action Record Table --");
828 Asm->OutStreamer.AddBlankLine();
829 }
830
Bill Wendling5cff4872009-07-28 23:44:43 +0000831 for (SmallVectorImpl<ActionEntry>::const_iterator
832 I = Actions.begin(), E = Actions.end(); I != E; ++I) {
833 const ActionEntry &Action = *I;
Chris Lattner233f52b2010-03-09 23:52:58 +0000834 Asm->OutStreamer.AddComment("Action Record");
835 Asm->OutStreamer.AddBlankLine();
Bill Wendlinga583c552009-08-20 22:02:24 +0000836
837 // Type Filter
838 //
839 // Used by the runtime to match the type of the thrown exception to the
840 // type of the catch clauses or the types in the exception specification.
Bill Wendling1f8075d2010-02-09 22:49:16 +0000841 EmitSLEB128(Action.ValueForTypeID, " TypeInfo index");
Bill Wendlinga583c552009-08-20 22:02:24 +0000842
843 // Action Record
844 //
845 // Self-relative signed displacement in bytes of the next action record,
846 // or 0 if there is no next action record.
Bill Wendling1f8075d2010-02-09 22:49:16 +0000847 EmitSLEB128(Action.NextAction, " Next action");
Bill Wendlingeb907212009-05-15 01:12:28 +0000848 }
849
Bill Wendling48dc29e2009-10-22 20:48:59 +0000850 // Emit the Catch TypeInfos.
Chris Lattner233f52b2010-03-09 23:52:58 +0000851 if (!TypeInfos.empty()) {
852 Asm->OutStreamer.AddComment("-- Catch TypeInfos --");
853 Asm->OutStreamer.AddBlankLine();
854 }
Bill Wendlingec044582009-11-18 23:18:46 +0000855 for (std::vector<GlobalVariable *>::const_reverse_iterator
Bill Wendling01c69372009-11-19 00:09:14 +0000856 I = TypeInfos.rbegin(), E = TypeInfos.rend(); I != E; ++I) {
Bill Wendlingfb7634f2009-11-19 19:21:09 +0000857 const GlobalVariable *GV = *I;
Bill Wendlingec044582009-11-18 23:18:46 +0000858
Chris Lattner90e4af72010-03-10 00:09:21 +0000859 Asm->OutStreamer.AddComment("TypeInfo");
860 if (GV)
Anton Korobeynikov9184b252010-02-15 22:35:59 +0000861 EmitReference(GV, TTypeEncoding);
Chris Lattner90e4af72010-03-10 00:09:21 +0000862 else
863 Asm->OutStreamer.EmitIntValue(0, SizeOfEncodedValue(TTypeEncoding), 0);
Bill Wendlingeb907212009-05-15 01:12:28 +0000864 }
865
Bill Wendling48dc29e2009-10-22 20:48:59 +0000866 // Emit the Exception Specifications.
Chris Lattner233f52b2010-03-09 23:52:58 +0000867 if (!FilterIds.empty()) {
868 Asm->OutStreamer.AddComment("-- Filter IDs --");
869 Asm->OutStreamer.AddBlankLine();
870 }
Bill Wendling5cff4872009-07-28 23:44:43 +0000871 for (std::vector<unsigned>::const_iterator
872 I = FilterIds.begin(), E = FilterIds.end(); I < E; ++I) {
873 unsigned TypeID = *I;
Chris Lattner894d75a2010-01-22 23:18:42 +0000874 EmitULEB128(TypeID, TypeID != 0 ? "Exception specification" : 0);
Bill Wendlingeb907212009-05-15 01:12:28 +0000875 }
876
877 Asm->EmitAlignment(2, 0, 0, false);
878}
879
Bill Wendlingeb907212009-05-15 01:12:28 +0000880/// EndModule - Emit all exception information that should come after the
881/// content.
882void DwarfException::EndModule() {
Chris Lattner33adcfb2009-08-22 21:43:10 +0000883 if (MAI->getExceptionHandlingType() != ExceptionHandling::Dwarf)
Jim Grosbach1b747ad2009-08-11 00:09:57 +0000884 return;
Bill Wendlingb4049fe2009-09-09 21:06:24 +0000885
Bill Wendling52783c62009-09-09 23:56:55 +0000886 if (!shouldEmitMovesModule && !shouldEmitTableModule)
887 return;
888
Chris Lattnerc3b228c2010-03-29 20:39:38 +0000889 TimeRegion Timer(ExceptionTimer);
Bill Wendlingeb907212009-05-15 01:12:28 +0000890
Bill Wendling52783c62009-09-09 23:56:55 +0000891 const std::vector<Function *> Personalities = MMI->getPersonalities();
Bill Wendlingb4049fe2009-09-09 21:06:24 +0000892
Bill Wendling28275fd2009-09-10 06:50:01 +0000893 for (unsigned I = 0, E = Personalities.size(); I < E; ++I)
894 EmitCIE(Personalities[I], I);
Bill Wendlingeb907212009-05-15 01:12:28 +0000895
Bill Wendling52783c62009-09-09 23:56:55 +0000896 for (std::vector<FunctionEHFrameInfo>::iterator
897 I = EHFrames.begin(), E = EHFrames.end(); I != E; ++I)
898 EmitFDE(*I);
Bill Wendlingeb907212009-05-15 01:12:28 +0000899}
900
Bill Wendling28275fd2009-09-10 06:50:01 +0000901/// BeginFunction - Gather pre-function exception information. Assumes it's
902/// being emitted immediately after the function entry point.
Chris Lattnereec791a2010-01-26 23:18:02 +0000903void DwarfException::BeginFunction(const MachineFunction *MF) {
Bill Wendling73c5a612009-09-10 18:28:06 +0000904 if (!MMI || !MAI->doesSupportExceptionHandling()) return;
905
Chris Lattnerc3b228c2010-03-29 20:39:38 +0000906 TimeRegion Timer(ExceptionTimer);
Bill Wendlingeb907212009-05-15 01:12:28 +0000907 this->MF = MF;
908 shouldEmitTable = shouldEmitMoves = false;
909
Bill Wendling73c5a612009-09-10 18:28:06 +0000910 // If any landing pads survive, we need an EH table.
Chris Lattner16112732010-03-14 01:41:15 +0000911 shouldEmitTable = !MMI->getLandingPads().empty();
Bill Wendlingeb907212009-05-15 01:12:28 +0000912
Bill Wendling73c5a612009-09-10 18:28:06 +0000913 // See if we need frame move info.
Chris Lattner16112732010-03-14 01:41:15 +0000914 shouldEmitMoves = !MF->getFunction()->doesNotThrow() || UnwindTablesMandatory;
Bill Wendlingeb907212009-05-15 01:12:28 +0000915
Bill Wendling73c5a612009-09-10 18:28:06 +0000916 if (shouldEmitMoves || shouldEmitTable)
917 // Assumes in correct section after the entry point.
Chris Lattnerf829eef2010-03-08 22:44:40 +0000918 Asm->OutStreamer.EmitLabel(getDWLabel("eh_func_begin", ++SubprogramCount));
Bill Wendlingeb907212009-05-15 01:12:28 +0000919
920 shouldEmitTableModule |= shouldEmitTable;
921 shouldEmitMovesModule |= shouldEmitMoves;
Bill Wendlingeb907212009-05-15 01:12:28 +0000922}
923
924/// EndFunction - Gather and emit post-function exception information.
925///
926void DwarfException::EndFunction() {
Bill Wendling7b09a6c2009-09-09 21:08:12 +0000927 if (!shouldEmitMoves && !shouldEmitTable) return;
928
Chris Lattnerc3b228c2010-03-29 20:39:38 +0000929 TimeRegion Timer(ExceptionTimer);
Chris Lattnerf829eef2010-03-08 22:44:40 +0000930 Asm->OutStreamer.EmitLabel(getDWLabel("eh_func_end", SubprogramCount));
Chris Lattner16112732010-03-14 01:41:15 +0000931
932 // Record if this personality index uses a landing pad.
933 bool HasLandingPad = !MMI->getLandingPads().empty();
934 UsesLSDA[MMI->getPersonalityIndex()] |= HasLandingPad;
935
936 // Map all labels and get rid of any dead landing pads.
937 MMI->TidyLandingPads();
938
939 if (HasLandingPad)
940 EmitExceptionTable();
Bill Wendlingeb907212009-05-15 01:12:28 +0000941
Chris Lattner09d53fe2010-03-10 07:20:42 +0000942 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Chris Lattner3a9be0e2010-01-23 05:51:36 +0000943 MCSymbol *FunctionEHSym =
Chris Lattner7a2ba942010-01-16 18:37:32 +0000944 Asm->GetSymbolWithGlobalValueBase(MF->getFunction(), ".eh",
Chris Lattner09d53fe2010-03-10 07:20:42 +0000945 TLOF.isFunctionEHFrameSymbolPrivate());
Chris Lattner25d812b2009-09-16 00:35:39 +0000946
Bill Wendling7b09a6c2009-09-09 21:08:12 +0000947 // Save EH frame information
Chris Lattner7a2ba942010-01-16 18:37:32 +0000948 EHFrames.push_back(FunctionEHFrameInfo(FunctionEHSym, SubprogramCount,
Bill Wendling7b09a6c2009-09-09 21:08:12 +0000949 MMI->getPersonalityIndex(),
950 MF->getFrameInfo()->hasCalls(),
951 !MMI->getLandingPads().empty(),
952 MMI->getFrameMoves(),
953 MF->getFunction()));
Bill Wendlingeb907212009-05-15 01:12:28 +0000954}