lib/CodeGen/AsmPrinter/DwarfException.cpp

   1 //===-- 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 //
  10 // This file contains support for writing DWARF exception info into asm files.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "DwarfException.h"
  15 #include "llvm/Module.h"
  16 #include "llvm/CodeGen/MachineModuleInfo.h"
  17 #include "llvm/CodeGen/MachineFrameInfo.h"
  18 #include "llvm/CodeGen/MachineFunction.h"
  19 #include "llvm/CodeGen/MachineLocation.h"
  20 #include "llvm/MC/MCAsmInfo.h"
  21 #include "llvm/MC/MCContext.h"
  22 #include "llvm/MC/MCExpr.h"
  23 #include "llvm/MC/MCSection.h"
  24 #include "llvm/MC/MCStreamer.h"
  25 #include "llvm/MC/MCSymbol.h"
  26 #include "llvm/Target/Mangler.h"
  27 #include "llvm/Target/TargetData.h"
  28 #include "llvm/Target/TargetFrameInfo.h"
  29 #include "llvm/Target/TargetLoweringObjectFile.h"
  30 #include "llvm/Target/TargetMachine.h"
  31 #include "llvm/Target/TargetOptions.h"
  32 #include "llvm/Target/TargetRegisterInfo.h"
  33 #include "llvm/Support/Dwarf.h"
  34 #include "llvm/Support/FormattedStream.h"
  35 #include "llvm/Support/Timer.h"
  36 #include "llvm/ADT/SmallString.h"
  37 #include "llvm/ADT/StringExtras.h"
  38 #include "llvm/ADT/Twine.h"
  39 using namespace llvm;
  40
  41 DwarfException::DwarfException(AsmPrinter *A)
  42   : DwarfPrinter(A), shouldEmitTable(false), shouldEmitMoves(false),
  43     shouldEmitTableModule(false), shouldEmitMovesModule(false),
  44     ExceptionTimer(0) {
  45   if (TimePassesIsEnabled)
  46     ExceptionTimer = new Timer("DWARF Exception Writer");
  47 }
  48
  49 DwarfException::~DwarfException() {
  50   delete ExceptionTimer;
  51 }
  52
  53 /// 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.
  56 void DwarfException::EmitCIE(const Function *PersonalityFn, unsigned Index) {
  57   // Size and sign of stack growth.
  58   int stackGrowth =
  59     Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
  60     TargetFrameInfo::StackGrowsUp ?
  61     TD->getPointerSize() : -TD->getPointerSize();
  62
  63   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
  64
  65   // Begin eh frame section.
  66   Asm->OutStreamer.SwitchSection(TLOF.getEHFrameSection());
  67
  68   MCSymbol *EHFrameSym;
  69   if (TLOF.isFunctionEHFrameSymbolPrivate())
  70     EHFrameSym = Asm->GetTempSymbol("EH_frame", Index);
  71   else
  72     EHFrameSym = Asm->OutContext.GetOrCreateSymbol(Twine("EH_frame") +
  73                                                    Twine(Index));
  74   Asm->OutStreamer.EmitLabel(EHFrameSym);
  75
  76   Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_eh_frame", Index));
  77
  78   // Define base labels.
  79   Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("eh_frame_common", Index));
  80
  81   // Define the eh frame length.
  82   Asm->OutStreamer.AddComment("Length of Common Information Entry");
  83   Asm->EmitLabelDifference(Asm->GetTempSymbol("eh_frame_common_end", Index),
  84                            Asm->GetTempSymbol("eh_frame_common_begin", Index),
  85                            4);
  86
  87   // EH frame header.
  88   Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("eh_frame_common_begin",Index));
  89   Asm->OutStreamer.AddComment("CIE Identifier Tag");
  90   Asm->OutStreamer.EmitIntValue(0, 4/*size*/, 0/*addrspace*/);
  91   Asm->OutStreamer.AddComment("DW_CIE_VERSION");
  92   Asm->OutStreamer.EmitIntValue(dwarf::DW_CIE_VERSION, 1/*size*/, 0/*addr*/);
  93
  94   // The personality presence indicates that language specific information will
  95   // show up in the eh frame.  Find out how we are supposed to lower the
  96   // personality function reference:
  97
  98   unsigned LSDAEncoding = TLOF.getLSDAEncoding();
  99   unsigned FDEEncoding = TLOF.getFDEEncoding();
 100   unsigned PerEncoding = TLOF.getPersonalityEncoding();
 101
 102   char Augmentation[6] = { 0 };
 103   unsigned AugmentationSize = 0;
 104   char *APtr = Augmentation + 1;
 105
 106   if (PersonalityFn) {
 107     // There is a personality function.
 108     *APtr++ = 'P';
 109     AugmentationSize += 1 + SizeOfEncodedValue(PerEncoding);
 110   }
 111
 112   if (UsesLSDA[Index]) {
 113     // An LSDA pointer is in the FDE augmentation.
 114     *APtr++ = 'L';
 115     ++AugmentationSize;
 116   }
 117
 118   if (FDEEncoding != dwarf::DW_EH_PE_absptr) {
 119     // A non-default pointer encoding for the FDE.
 120     *APtr++ = 'R';
 121     ++AugmentationSize;
 122   }
 123
 124   if (APtr != Augmentation + 1)
 125     Augmentation[0] = 'z';
 126
 127   Asm->OutStreamer.AddComment("CIE Augmentation");
 128   Asm->OutStreamer.EmitBytes(StringRef(Augmentation, strlen(Augmentation)+1),0);
 129
 130   // Round out reader.
 131   Asm->EmitULEB128(1, "CIE Code Alignment Factor");
 132   Asm->EmitSLEB128(stackGrowth, "CIE Data Alignment Factor");
 133   Asm->OutStreamer.AddComment("CIE Return Address Column");
 134   Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
 135
 136   if (Augmentation[0]) {
 137     Asm->EmitULEB128(AugmentationSize, "Augmentation Size");
 138
 139     // If there is a personality, we need to indicate the function's location.
 140     if (PersonalityFn) {
 141       Asm->EmitEncodingByte(PerEncoding, "Personality");
 142       Asm->OutStreamer.AddComment("Personality");
 143       EmitReference(PersonalityFn, PerEncoding);
 144     }
 145     if (UsesLSDA[Index])
 146       Asm->EmitEncodingByte(LSDAEncoding, "LSDA");
 147     if (FDEEncoding != dwarf::DW_EH_PE_absptr)
 148       Asm->EmitEncodingByte(FDEEncoding, "FDE");
 149   }
 150
 151   // Indicate locations of general callee saved registers in frame.
 152   std::vector<MachineMove> Moves;
 153   RI->getInitialFrameState(Moves);
 154   EmitFrameMoves(0, Moves, true);
 155
 156   // On Darwin the linker honors the alignment of eh_frame, which means it must
 157   // be 8-byte on 64-bit targets to match what gcc does.  Otherwise you get
 158   // holes which confuse readers of eh_frame.
 159   Asm->EmitAlignment(TD->getPointerSize() == 4 ? 2 : 3, 0, 0, false);
 160   Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("eh_frame_common_end", Index));
 161 }
 162
 163 /// EmitFDE - Emit the Frame Description Entry (FDE) for the function.
 164 void DwarfException::EmitFDE(const FunctionEHFrameInfo &EHFrameInfo) {
 165   assert(!EHFrameInfo.function->hasAvailableExternallyLinkage() &&
 166          "Should not emit 'available externally' functions at all");
 167
 168   const Function *TheFunc = EHFrameInfo.function;
 169   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
 170
 171   unsigned LSDAEncoding = TLOF.getLSDAEncoding();
 172   unsigned FDEEncoding = TLOF.getFDEEncoding();
 173
 174   Asm->OutStreamer.SwitchSection(TLOF.getEHFrameSection());
 175
 176   // Externally visible entry into the functions eh frame info. If the
 177   // corresponding function is static, this should not be externally visible.
 178   if (!TheFunc->hasLocalLinkage() && TLOF.isFunctionEHSymbolGlobal())
 179     Asm->OutStreamer.EmitSymbolAttribute(EHFrameInfo.FunctionEHSym,MCSA_Global);
 180
 181   // If corresponding function is weak definition, this should be too.
 182   if (TheFunc->isWeakForLinker() && MAI->getWeakDefDirective())
 183     Asm->OutStreamer.EmitSymbolAttribute(EHFrameInfo.FunctionEHSym,
 184                                          MCSA_WeakDefinition);
 185
 186   // If corresponding function is hidden, this should be too.
 187   if (TheFunc->hasHiddenVisibility())
 188     if (MCSymbolAttr HiddenAttr = MAI->getHiddenVisibilityAttr())
 189       Asm->OutStreamer.EmitSymbolAttribute(EHFrameInfo.FunctionEHSym,
 190                                            HiddenAttr);
 191
 192   // If there are no calls then you can't unwind.  This may mean we can omit the
 193   // EH Frame, but some environments do not handle weak absolute symbols. If
 194   // UnwindTablesMandatory is set we cannot do this optimization; the unwind
 195   // info is to be available for non-EH uses.
 196   if (!EHFrameInfo.hasCalls && !UnwindTablesMandatory &&
 197       (!TheFunc->isWeakForLinker() ||
 198        !MAI->getWeakDefDirective() ||
 199        TLOF.getSupportsWeakOmittedEHFrame())) {
 200     Asm->OutStreamer.EmitAssignment(EHFrameInfo.FunctionEHSym,
 201                                     MCConstantExpr::Create(0, Asm->OutContext));
 202     // This name has no connection to the function, so it might get
 203     // dead-stripped when the function is not, erroneously.  Prohibit
 204     // dead-stripping unconditionally.
 205     if (MAI->hasNoDeadStrip())
 206       Asm->OutStreamer.EmitSymbolAttribute(EHFrameInfo.FunctionEHSym,
 207                                            MCSA_NoDeadStrip);
 208   } else {
 209     Asm->OutStreamer.EmitLabel(EHFrameInfo.FunctionEHSym);
 210
 211     // EH frame header.
 212     Asm->OutStreamer.AddComment("Length of Frame Information Entry");
 213     Asm->EmitLabelDifference(
 214                 Asm->GetTempSymbol("eh_frame_end", EHFrameInfo.Number),
 215                 Asm->GetTempSymbol("eh_frame_begin", EHFrameInfo.Number), 4);
 216
 217     Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("eh_frame_begin",
 218                                                   EHFrameInfo.Number));
 219
 220     Asm->OutStreamer.AddComment("FDE CIE offset");
 221     EmitSectionOffset(Asm->GetTempSymbol("eh_frame_begin", EHFrameInfo.Number),
 222                       Asm->GetTempSymbol("eh_frame_common",
 223                                          EHFrameInfo.PersonalityIndex),
 224                       true, true);
 225
 226     MCSymbol *EHFuncBeginSym =
 227       Asm->GetTempSymbol("eh_func_begin", EHFrameInfo.Number);
 228
 229     Asm->OutStreamer.AddComment("FDE initial location");
 230     EmitReference(EHFuncBeginSym, FDEEncoding);
 231
 232     Asm->OutStreamer.AddComment("FDE address range");
 233     Asm->EmitLabelDifference(Asm->GetTempSymbol("eh_func_end",
 234                                                 EHFrameInfo.Number),
 235                              EHFuncBeginSym, SizeOfEncodedValue(FDEEncoding));
 236
 237     // If there is a personality and landing pads then point to the language
 238     // specific data area in the exception table.
 239     if (MMI->getPersonalities()[0] != NULL) {
 240       unsigned Size = SizeOfEncodedValue(LSDAEncoding);
 241
 242       Asm->EmitULEB128(Size, "Augmentation size");
 243       Asm->OutStreamer.AddComment("Language Specific Data Area");
 244       if (EHFrameInfo.hasLandingPads)
 245         EmitReference(Asm->GetTempSymbol("exception", EHFrameInfo.Number),
 246                       LSDAEncoding);
 247       else
 248         Asm->OutStreamer.EmitIntValue(0, Size/*size*/, 0/*addrspace*/);
 249
 250     } else {
 251       Asm->EmitULEB128(0, "Augmentation size");
 252     }
 253
 254     // Indicate locations of function specific callee saved registers in frame.
 255     EmitFrameMoves(EHFuncBeginSym, EHFrameInfo.Moves, true);
 256
 257     // On Darwin the linker honors the alignment of eh_frame, which means it
 258     // must be 8-byte on 64-bit targets to match what gcc does.  Otherwise you
 259     // get holes which confuse readers of eh_frame.
 260     Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
 261                        0, 0, false);
 262     Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("eh_frame_end",
 263                                                   EHFrameInfo.Number));
 264
 265     // If the function is marked used, this table should be also.  We cannot
 266     // make the mark unconditional in this case, since retaining the table also
 267     // retains the function in this case, and there is code around that depends
 268     // on unused functions (calling undefined externals) being dead-stripped to
 269     // link correctly.  Yes, there really is.
 270     if (MMI->isUsedFunction(EHFrameInfo.function))
 271       if (MAI->hasNoDeadStrip())
 272         Asm->OutStreamer.EmitSymbolAttribute(EHFrameInfo.FunctionEHSym,
 273                                              MCSA_NoDeadStrip);
 274   }
 275   Asm->OutStreamer.AddBlankLine();
 276 }
 277
 278 /// SharedTypeIds - How many leading type ids two landing pads have in common.
 279 unsigned DwarfException::SharedTypeIds(const LandingPadInfo *L,
 280                                        const LandingPadInfo *R) {
 281   const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
 282   unsigned LSize = LIds.size(), RSize = RIds.size();
 283   unsigned MinSize = LSize < RSize ? LSize : RSize;
 284   unsigned Count = 0;
 285
 286   for (; Count != MinSize; ++Count)
 287     if (LIds[Count] != RIds[Count])
 288       return Count;
 289
 290   return Count;
 291 }
 292
 293 /// PadLT - Order landing pads lexicographically by type id.
 294 bool DwarfException::PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
 295   const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
 296   unsigned LSize = LIds.size(), RSize = RIds.size();
 297   unsigned MinSize = LSize < RSize ? LSize : RSize;
 298
 299   for (unsigned i = 0; i != MinSize; ++i)
 300     if (LIds[i] != RIds[i])
 301       return LIds[i] < RIds[i];
 302
 303   return LSize < RSize;
 304 }
 305
 306 /// ComputeActionsTable - Compute the actions table and gather the first action
 307 /// index for each landing pad site.
 308 unsigned DwarfException::
 309 ComputeActionsTable(const SmallVectorImpl<const LandingPadInfo*> &LandingPads,
 310                     SmallVectorImpl<ActionEntry> &Actions,
 311                     SmallVectorImpl<unsigned> &FirstActions) {
 312
 313   // The action table follows the call-site table in the LSDA. The individual
 314   // records are of two types:
 315   //
 316   //   * Catch clause
 317   //   * Exception specification
 318   //
 319   // The two record kinds have the same format, with only small differences.
 320   // They are distinguished by the "switch value" field: Catch clauses
 321   // (TypeInfos) have strictly positive switch values, and exception
 322   // specifications (FilterIds) have strictly negative switch values. Value 0
 323   // indicates a catch-all clause.
 324   //
 325   // Negative type IDs index into FilterIds. Positive type IDs index into
 326   // TypeInfos.  The value written for a positive type ID is just the type ID
 327   // itself.  For a negative type ID, however, the value written is the
 328   // (negative) byte offset of the corresponding FilterIds entry.  The byte
 329   // offset is usually equal to the type ID (because the FilterIds entries are
 330   // written using a variable width encoding, which outputs one byte per entry
 331   // as long as the value written is not too large) but can differ.  This kind
 332   // of complication does not occur for positive type IDs because type infos are
 333   // output using a fixed width encoding.  FilterOffsets[i] holds the byte
 334   // offset corresponding to FilterIds[i].
 335
 336   const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
 337   SmallVector<int, 16> FilterOffsets;
 338   FilterOffsets.reserve(FilterIds.size());
 339   int Offset = -1;
 340
 341   for (std::vector<unsigned>::const_iterator
 342          I = FilterIds.begin(), E = FilterIds.end(); I != E; ++I) {
 343     FilterOffsets.push_back(Offset);
 344     Offset -= MCAsmInfo::getULEB128Size(*I);
 345   }
 346
 347   FirstActions.reserve(LandingPads.size());
 348
 349   int FirstAction = 0;
 350   unsigned SizeActions = 0;
 351   const LandingPadInfo *PrevLPI = 0;
 352
 353   for (SmallVectorImpl<const LandingPadInfo *>::const_iterator
 354          I = LandingPads.begin(), E = LandingPads.end(); I != E; ++I) {
 355     const LandingPadInfo *LPI = *I;
 356     const std::vector<int> &TypeIds = LPI->TypeIds;
 357     unsigned NumShared = PrevLPI ? SharedTypeIds(LPI, PrevLPI) : 0;
 358     unsigned SizeSiteActions = 0;
 359
 360     if (NumShared < TypeIds.size()) {
 361       unsigned SizeAction = 0;
 362       unsigned PrevAction = (unsigned)-1;
 363
 364       if (NumShared) {
 365         unsigned SizePrevIds = PrevLPI->TypeIds.size();
 366         assert(Actions.size());
 367         PrevAction = Actions.size() - 1;
 368         SizeAction =
 369           MCAsmInfo::getSLEB128Size(Actions[PrevAction].NextAction) +
 370           MCAsmInfo::getSLEB128Size(Actions[PrevAction].ValueForTypeID);
 371
 372         for (unsigned j = NumShared; j != SizePrevIds; ++j) {
 373           assert(PrevAction != (unsigned)-1 && "PrevAction is invalid!");
 374           SizeAction -=
 375             MCAsmInfo::getSLEB128Size(Actions[PrevAction].ValueForTypeID);
 376           SizeAction += -Actions[PrevAction].NextAction;
 377           PrevAction = Actions[PrevAction].Previous;
 378         }
 379       }
 380
 381       // Compute the actions.
 382       for (unsigned J = NumShared, M = TypeIds.size(); J != M; ++J) {
 383         int TypeID = TypeIds[J];
 384         assert(-1 - TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
 385         int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
 386         unsigned SizeTypeID = MCAsmInfo::getSLEB128Size(ValueForTypeID);
 387
 388         int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
 389         SizeAction = SizeTypeID + MCAsmInfo::getSLEB128Size(NextAction);
 390         SizeSiteActions += SizeAction;
 391
 392         ActionEntry Action = { ValueForTypeID, NextAction, PrevAction };
 393         Actions.push_back(Action);
 394         PrevAction = Actions.size() - 1;
 395       }
 396
 397       // Record the first action of the landing pad site.
 398       FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
 399     } // else identical - re-use previous FirstAction
 400
 401     // Information used when created the call-site table. The action record
 402     // field of the call site record is the offset of the first associated
 403     // action record, relative to the start of the actions table. This value is
 404     // biased by 1 (1 indicating the start of the actions table), and 0
 405     // indicates that there are no actions.
 406     FirstActions.push_back(FirstAction);
 407
 408     // Compute this sites contribution to size.
 409     SizeActions += SizeSiteActions;
 410
 411     PrevLPI = LPI;
 412   }
 413
 414   return SizeActions;
 415 }
 416
 417 /// CallToNoUnwindFunction - Return `true' if this is a call to a function
 418 /// marked `nounwind'. Return `false' otherwise.
 419 bool DwarfException::CallToNoUnwindFunction(const MachineInstr *MI) {
 420   assert(MI->getDesc().isCall() && "This should be a call instruction!");
 421
 422   bool MarkedNoUnwind = false;
 423   bool SawFunc = false;
 424
 425   for (unsigned I = 0, E = MI->getNumOperands(); I != E; ++I) {
 426     const MachineOperand &MO = MI->getOperand(I);
 427
 428     if (!MO.isGlobal()) continue;
 429
 430     Function *F = dyn_cast<Function>(MO.getGlobal());
 431     if (F == 0) continue;
 432
 433     if (SawFunc) {
 434       // Be conservative. If we have more than one function operand for this
 435       // call, then we can't make the assumption that it's the callee and
 436       // not a parameter to the call.
 437       //
 438       // FIXME: Determine if there's a way to say that `F' is the callee or
 439       // parameter.
 440       MarkedNoUnwind = false;
 441       break;
 442     }
 443
 444     MarkedNoUnwind = F->doesNotThrow();
 445     SawFunc = true;
 446   }
 447
 448   return MarkedNoUnwind;
 449 }
 450
 451 /// ComputeCallSiteTable - Compute the call-site table.  The entry for an invoke
 452 /// has a try-range containing the call, a non-zero landing pad, and an
 453 /// appropriate action.  The entry for an ordinary call has a try-range
 454 /// containing the call and zero for the landing pad and the action.  Calls
 455 /// marked 'nounwind' have no entry and must not be contained in the try-range
 456 /// of any entry - they form gaps in the table.  Entries must be ordered by
 457 /// try-range address.
 458 void DwarfException::
 459 ComputeCallSiteTable(SmallVectorImpl<CallSiteEntry> &CallSites,
 460                      const RangeMapType &PadMap,
 461                      const SmallVectorImpl<const LandingPadInfo *> &LandingPads,
 462                      const SmallVectorImpl<unsigned> &FirstActions) {
 463   // The end label of the previous invoke or nounwind try-range.
 464   MCSymbol *LastLabel = 0;
 465
 466   // Whether there is a potentially throwing instruction (currently this means
 467   // an ordinary call) between the end of the previous try-range and now.
 468   bool SawPotentiallyThrowing = false;
 469
 470   // Whether the last CallSite entry was for an invoke.
 471   bool PreviousIsInvoke = false;
 472
 473   // Visit all instructions in order of address.
 474   for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
 475        I != E; ++I) {
 476     for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
 477          MI != E; ++MI) {
 478       if (!MI->isLabel()) {
 479         if (MI->getDesc().isCall())
 480           SawPotentiallyThrowing |= !CallToNoUnwindFunction(MI);
 481         continue;
 482       }
 483
 484       // End of the previous try-range?
 485       MCSymbol *BeginLabel = MI->getOperand(0).getMCSymbol();
 486       if (BeginLabel == LastLabel)
 487         SawPotentiallyThrowing = false;
 488
 489       // Beginning of a new try-range?
 490       RangeMapType::const_iterator L = PadMap.find(BeginLabel);
 491       if (L == PadMap.end())
 492         // Nope, it was just some random label.
 493         continue;
 494
 495       const PadRange &P = L->second;
 496       const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
 497       assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
 498              "Inconsistent landing pad map!");
 499
 500       // For Dwarf exception handling (SjLj handling doesn't use this). If some
 501       // instruction between the previous try-range and this one may throw,
 502       // create a call-site entry with no landing pad for the region between the
 503       // try-ranges.
 504       if (SawPotentiallyThrowing &&
 505           MAI->getExceptionHandlingType() == ExceptionHandling::Dwarf) {
 506         CallSiteEntry Site = { LastLabel, BeginLabel, 0, 0 };
 507         CallSites.push_back(Site);
 508         PreviousIsInvoke = false;
 509       }
 510
 511       LastLabel = LandingPad->EndLabels[P.RangeIndex];
 512       assert(BeginLabel && LastLabel && "Invalid landing pad!");
 513
 514       if (!LandingPad->LandingPadLabel) {
 515         // Create a gap.
 516         PreviousIsInvoke = false;
 517       } else {
 518         // This try-range is for an invoke.
 519         CallSiteEntry Site = {
 520           BeginLabel,
 521           LastLabel,
 522           LandingPad->LandingPadLabel,
 523           FirstActions[P.PadIndex]
 524         };
 525
 526         // Try to merge with the previous call-site. SJLJ doesn't do this
 527         if (PreviousIsInvoke &&
 528           MAI->getExceptionHandlingType() == ExceptionHandling::Dwarf) {
 529           CallSiteEntry &Prev = CallSites.back();
 530           if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
 531             // Extend the range of the previous entry.
 532             Prev.EndLabel = Site.EndLabel;
 533             continue;
 534           }
 535         }
 536
 537         // Otherwise, create a new call-site.
 538         if (MAI->getExceptionHandlingType() == ExceptionHandling::Dwarf)
 539           CallSites.push_back(Site);
 540         else {
 541           // SjLj EH must maintain the call sites in the order assigned
 542           // to them by the SjLjPrepare pass.
 543           unsigned SiteNo = MMI->getCallSiteBeginLabel(BeginLabel);
 544           if (CallSites.size() < SiteNo)
 545             CallSites.resize(SiteNo);
 546           CallSites[SiteNo - 1] = Site;
 547         }
 548         PreviousIsInvoke = true;
 549       }
 550     }
 551   }
 552
 553   // If some instruction between the previous try-range and the end of the
 554   // function may throw, create a call-site entry with no landing pad for the
 555   // region following the try-range.
 556   if (SawPotentiallyThrowing &&
 557       MAI->getExceptionHandlingType() == ExceptionHandling::Dwarf) {
 558     CallSiteEntry Site = { LastLabel, 0, 0, 0 };
 559     CallSites.push_back(Site);
 560   }
 561 }
 562
 563 /// EmitExceptionTable - Emit landing pads and actions.
 564 ///
 565 /// The general organization of the table is complex, but the basic concepts are
 566 /// easy.  First there is a header which describes the location and organization
 567 /// of the three components that follow.
 568 ///
 569 ///  1. The landing pad site information describes the range of code covered by
 570 ///     the try.  In our case it's an accumulation of the ranges covered by the
 571 ///     invokes in the try.  There is also a reference to the landing pad that
 572 ///     handles the exception once processed.  Finally an index into the actions
 573 ///     table.
 574 ///  2. The action table, in our case, is composed of pairs of type IDs and next
 575 ///     action offset.  Starting with the action index from the landing pad
 576 ///     site, each type ID is checked for a match to the current exception.  If
 577 ///     it matches then the exception and type id are passed on to the landing
 578 ///     pad.  Otherwise the next action is looked up.  This chain is terminated
 579 ///     with a next action of zero.  If no type id is found then the frame is
 580 ///     unwound and handling continues.
 581 ///  3. Type ID table contains references to all the C++ typeinfo for all
 582 ///     catches in the function.  This tables is reverse indexed base 1.
 583 void DwarfException::EmitExceptionTable() {
 584   const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
 585   const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
 586   const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
 587
 588   // Sort the landing pads in order of their type ids.  This is used to fold
 589   // duplicate actions.
 590   SmallVector<const LandingPadInfo *, 64> LandingPads;
 591   LandingPads.reserve(PadInfos.size());
 592
 593   for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
 594     LandingPads.push_back(&PadInfos[i]);
 595
 596   std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
 597
 598   // Compute the actions table and gather the first action index for each
 599   // landing pad site.
 600   SmallVector<ActionEntry, 32> Actions;
 601   SmallVector<unsigned, 64> FirstActions;
 602   unsigned SizeActions=ComputeActionsTable(LandingPads, Actions, FirstActions);
 603
 604   // Invokes and nounwind calls have entries in PadMap (due to being bracketed
 605   // by try-range labels when lowered).  Ordinary calls do not, so appropriate
 606   // try-ranges for them need be deduced when using DWARF exception handling.
 607   RangeMapType PadMap;
 608   for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
 609     const LandingPadInfo *LandingPad = LandingPads[i];
 610     for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
 611       MCSymbol *BeginLabel = LandingPad->BeginLabels[j];
 612       assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
 613       PadRange P = { i, j };
 614       PadMap[BeginLabel] = P;
 615     }
 616   }
 617
 618   // Compute the call-site table.
 619   SmallVector<CallSiteEntry, 64> CallSites;
 620   ComputeCallSiteTable(CallSites, PadMap, LandingPads, FirstActions);
 621
 622   // Final tallies.
 623
 624   // Call sites.
 625   bool IsSJLJ = MAI->getExceptionHandlingType() == ExceptionHandling::SjLj;
 626   bool HaveTTData = IsSJLJ ? (!TypeInfos.empty() || !FilterIds.empty()) : true;
 627
 628   unsigned CallSiteTableLength;
 629   if (IsSJLJ)
 630     CallSiteTableLength = 0;
 631   else {
 632     unsigned SiteStartSize  = 4; // dwarf::DW_EH_PE_udata4
 633     unsigned SiteLengthSize = 4; // dwarf::DW_EH_PE_udata4
 634     unsigned LandingPadSize = 4; // dwarf::DW_EH_PE_udata4
 635     CallSiteTableLength =
 636       CallSites.size() * (SiteStartSize + SiteLengthSize + LandingPadSize);
 637   }
 638
 639   for (unsigned i = 0, e = CallSites.size(); i < e; ++i) {
 640     CallSiteTableLength += MCAsmInfo::getULEB128Size(CallSites[i].Action);
 641     if (IsSJLJ)
 642       CallSiteTableLength += MCAsmInfo::getULEB128Size(i);
 643   }
 644
 645   // Type infos.
 646   const MCSection *LSDASection = Asm->getObjFileLowering().getLSDASection();
 647   unsigned TTypeEncoding;
 648   unsigned TypeFormatSize;
 649
 650   if (!HaveTTData) {
 651     // For SjLj exceptions, if there is no TypeInfo, then we just explicitly say
 652     // that we're omitting that bit.
 653     TTypeEncoding = dwarf::DW_EH_PE_omit;
 654     TypeFormatSize = TD->getPointerSize(); // dwarf::DW_EH_PE_absptr
 655   } else {
 656     // Okay, we have actual filters or typeinfos to emit.  As such, we need to
 657     // pick a type encoding for them.  We're about to emit a list of pointers to
 658     // typeinfo objects at the end of the LSDA.  However, unless we're in static
 659     // mode, this reference will require a relocation by the dynamic linker.
 660     //
 661     // Because of this, we have a couple of options:
 662     //
 663     //   1) If we are in -static mode, we can always use an absolute reference
 664     //      from the LSDA, because the static linker will resolve it.
 665     //
 666     //   2) Otherwise, if the LSDA section is writable, we can output the direct
 667     //      reference to the typeinfo and allow the dynamic linker to relocate
 668     //      it.  Since it is in a writable section, the dynamic linker won't
 669     //      have a problem.
 670     //
 671     //   3) Finally, if we're in PIC mode and the LDSA section isn't writable,
 672     //      we need to use some form of indirection.  For example, on Darwin,
 673     //      we can output a statically-relocatable reference to a dyld stub. The
 674     //      offset to the stub is constant, but the contents are in a section
 675     //      that is updated by the dynamic linker.  This is easy enough, but we
 676     //      need to tell the personality function of the unwinder to indirect
 677     //      through the dyld stub.
 678     //
 679     // FIXME: When (3) is actually implemented, we'll have to emit the stubs
 680     // somewhere.  This predicate should be moved to a shared location that is
 681     // in target-independent code.
 682     //
 683     TTypeEncoding = Asm->getObjFileLowering().getTTypeEncoding();
 684     TypeFormatSize = SizeOfEncodedValue(TTypeEncoding);
 685   }
 686
 687   // Begin the exception table.
 688   Asm->OutStreamer.SwitchSection(LSDASection);
 689   Asm->EmitAlignment(2, 0, 0, false);
 690
 691   // Emit the LSDA.
 692   MCSymbol *GCCETSym =
 693     Asm->OutContext.GetOrCreateSymbol(Twine("GCC_except_table")+
 694                                       Twine(SubprogramCount));
 695   Asm->OutStreamer.EmitLabel(GCCETSym);
 696   Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("exception", SubprogramCount));
 697
 698   if (IsSJLJ)
 699     Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("_LSDA_",
 700                                                   Asm->getFunctionNumber()));
 701
 702   // Emit the LSDA header.
 703   Asm->EmitEncodingByte(dwarf::DW_EH_PE_omit, "@LPStart");
 704   Asm->EmitEncodingByte(TTypeEncoding, "@TType");
 705
 706   // The type infos need to be aligned. GCC does this by inserting padding just
 707   // before the type infos. However, this changes the size of the exception
 708   // table, so you need to take this into account when you output the exception
 709   // table size. However, the size is output using a variable length encoding.
 710   // So by increasing the size by inserting padding, you may increase the number
 711   // of bytes used for writing the size. If it increases, say by one byte, then
 712   // you now need to output one less byte of padding to get the type infos
 713   // aligned. However this decreases the size of the exception table. This
 714   // changes the value you have to output for the exception table size. Due to
 715   // the variable length encoding, the number of bytes used for writing the
 716   // length may decrease. If so, you then have to increase the amount of
 717   // padding. And so on. If you look carefully at the GCC code you will see that
 718   // it indeed does this in a loop, going on and on until the values stabilize.
 719   // We chose another solution: don't output padding inside the table like GCC
 720   // does, instead output it before the table.
 721   unsigned SizeTypes = TypeInfos.size() * TypeFormatSize;
 722   unsigned CallSiteTableLengthSize =
 723     MCAsmInfo::getULEB128Size(CallSiteTableLength);
 724   unsigned TTypeBaseOffset =
 725     sizeof(int8_t) +                            // Call site format
 726     CallSiteTableLengthSize +                   // Call site table length size
 727     CallSiteTableLength +                       // Call site table length
 728     SizeActions +                               // Actions size
 729     SizeTypes;
 730   unsigned TTypeBaseOffsetSize = MCAsmInfo::getULEB128Size(TTypeBaseOffset);
 731   unsigned TotalSize =
 732     sizeof(int8_t) +                            // LPStart format
 733     sizeof(int8_t) +                            // TType format
 734     (HaveTTData ? TTypeBaseOffsetSize : 0) +    // TType base offset size
 735     TTypeBaseOffset;                            // TType base offset
 736   unsigned SizeAlign = (4 - TotalSize) & 3;
 737
 738   if (HaveTTData) {
 739     // Account for any extra padding that will be added to the call site table
 740     // length.
 741     Asm->EmitULEB128(TTypeBaseOffset, "@TType base offset", SizeAlign);
 742     SizeAlign = 0;
 743   }
 744
 745   // SjLj Exception handling
 746   if (IsSJLJ) {
 747     Asm->EmitEncodingByte(dwarf::DW_EH_PE_udata4, "Call site");
 748
 749     // Add extra padding if it wasn't added to the TType base offset.
 750     Asm->EmitULEB128(CallSiteTableLength, "Call site table length", SizeAlign);
 751
 752     // Emit the landing pad site information.
 753     unsigned idx = 0;
 754     for (SmallVectorImpl<CallSiteEntry>::const_iterator
 755          I = CallSites.begin(), E = CallSites.end(); I != E; ++I, ++idx) {
 756       const CallSiteEntry &S = *I;
 757
 758       // Offset of the landing pad, counted in 16-byte bundles relative to the
 759       // @LPStart address.
 760       Asm->EmitULEB128(idx, "Landing pad");
 761
 762       // Offset of the first associated action record, relative to the start of
 763       // the action table. This value is biased by 1 (1 indicates the start of
 764       // the action table), and 0 indicates that there are no actions.
 765       Asm->EmitULEB128(S.Action, "Action");
 766     }
 767   } else {
 768     // DWARF Exception handling
 769     assert(MAI->getExceptionHandlingType() == ExceptionHandling::Dwarf);
 770
 771     // The call-site table is a list of all call sites that may throw an
 772     // exception (including C++ 'throw' statements) in the procedure
 773     // fragment. It immediately follows the LSDA header. Each entry indicates,
 774     // for a given call, the first corresponding action record and corresponding
 775     // landing pad.
 776     //
 777     // The table begins with the number of bytes, stored as an LEB128
 778     // compressed, unsigned integer. The records immediately follow the record
 779     // count. They are sorted in increasing call-site address. Each record
 780     // indicates:
 781     //
 782     //   * The position of the call-site.
 783     //   * The position of the landing pad.
 784     //   * The first action record for that call site.
 785     //
 786     // A missing entry in the call-site table indicates that a call is not
 787     // supposed to throw.
 788
 789     // Emit the landing pad call site table.
 790     Asm->EmitEncodingByte(dwarf::DW_EH_PE_udata4, "Call site");
 791
 792     // Add extra padding if it wasn't added to the TType base offset.
 793     Asm->EmitULEB128(CallSiteTableLength, "Call site table length", SizeAlign);
 794
 795     for (SmallVectorImpl<CallSiteEntry>::const_iterator
 796          I = CallSites.begin(), E = CallSites.end(); I != E; ++I) {
 797       const CallSiteEntry &S = *I;
 798
 799       MCSymbol *EHFuncBeginSym =
 800         Asm->GetTempSymbol("eh_func_begin", SubprogramCount);
 801
 802       MCSymbol *BeginLabel = S.BeginLabel;
 803       if (BeginLabel == 0)
 804         BeginLabel = EHFuncBeginSym;
 805       MCSymbol *EndLabel = S.EndLabel;
 806       if (EndLabel == 0)
 807         EndLabel = Asm->GetTempSymbol("eh_func_end", SubprogramCount);
 808
 809       // Offset of the call site relative to the previous call site, counted in
 810       // number of 16-byte bundles. The first call site is counted relative to
 811       // the start of the procedure fragment.
 812       Asm->OutStreamer.AddComment("Region start");
 813       EmitSectionOffset(BeginLabel, EHFuncBeginSym, true, true);
 814
 815       Asm->OutStreamer.AddComment("Region length");
 816       Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
 817
 818
 819       // Offset of the landing pad, counted in 16-byte bundles relative to the
 820       // @LPStart address.
 821       Asm->OutStreamer.AddComment("Landing pad");
 822       if (!S.PadLabel)
 823         Asm->OutStreamer.EmitIntValue(0, 4/*size*/, 0/*addrspace*/);
 824       else
 825         EmitSectionOffset(S.PadLabel, EHFuncBeginSym, true, true);
 826
 827       // Offset of the first associated action record, relative to the start of
 828       // the action table. This value is biased by 1 (1 indicates the start of
 829       // the action table), and 0 indicates that there are no actions.
 830       Asm->EmitULEB128(S.Action, "Action");
 831     }
 832   }
 833
 834   // Emit the Action Table.
 835   if (Actions.size() != 0) {
 836     Asm->OutStreamer.AddComment("-- Action Record Table --");
 837     Asm->OutStreamer.AddBlankLine();
 838   }
 839
 840   for (SmallVectorImpl<ActionEntry>::const_iterator
 841          I = Actions.begin(), E = Actions.end(); I != E; ++I) {
 842     const ActionEntry &Action = *I;
 843     Asm->OutStreamer.AddComment("Action Record");
 844     Asm->OutStreamer.AddBlankLine();
 845
 846     // Type Filter
 847     //
 848     //   Used by the runtime to match the type of the thrown exception to the
 849     //   type of the catch clauses or the types in the exception specification.
 850     Asm->EmitSLEB128(Action.ValueForTypeID, "  TypeInfo index");
 851
 852     // Action Record
 853     //
 854     //   Self-relative signed displacement in bytes of the next action record,
 855     //   or 0 if there is no next action record.
 856     Asm->EmitSLEB128(Action.NextAction, "  Next action");
 857   }
 858
 859   // Emit the Catch TypeInfos.
 860   if (!TypeInfos.empty()) {
 861     Asm->OutStreamer.AddComment("-- Catch TypeInfos --");
 862     Asm->OutStreamer.AddBlankLine();
 863   }
 864   for (std::vector<GlobalVariable *>::const_reverse_iterator
 865          I = TypeInfos.rbegin(), E = TypeInfos.rend(); I != E; ++I) {
 866     const GlobalVariable *GV = *I;
 867
 868     Asm->OutStreamer.AddComment("TypeInfo");
 869     if (GV)
 870       EmitReference(GV, TTypeEncoding);
 871     else
 872       Asm->OutStreamer.EmitIntValue(0, SizeOfEncodedValue(TTypeEncoding), 0);
 873   }
 874
 875   // Emit the Exception Specifications.
 876   if (!FilterIds.empty()) {
 877     Asm->OutStreamer.AddComment("-- Filter IDs --");
 878     Asm->OutStreamer.AddBlankLine();
 879   }
 880   for (std::vector<unsigned>::const_iterator
 881          I = FilterIds.begin(), E = FilterIds.end(); I < E; ++I) {
 882     unsigned TypeID = *I;
 883     Asm->EmitULEB128(TypeID, TypeID != 0 ? "Exception specification" : 0);
 884   }
 885
 886   Asm->EmitAlignment(2, 0, 0, false);
 887 }
 888
 889 /// EndModule - Emit all exception information that should come after the
 890 /// content.
 891 void DwarfException::EndModule() {
 892   if (MAI->getExceptionHandlingType() != ExceptionHandling::Dwarf)
 893     return;
 894
 895   if (!shouldEmitMovesModule && !shouldEmitTableModule)
 896     return;
 897
 898   TimeRegion Timer(ExceptionTimer);
 899
 900   const std::vector<Function *> Personalities = MMI->getPersonalities();
 901
 902   for (unsigned I = 0, E = Personalities.size(); I < E; ++I)
 903     EmitCIE(Personalities[I], I);
 904
 905   for (std::vector<FunctionEHFrameInfo>::iterator
 906          I = EHFrames.begin(), E = EHFrames.end(); I != E; ++I)
 907     EmitFDE(*I);
 908 }
 909
 910 /// BeginFunction - Gather pre-function exception information. Assumes it's
 911 /// being emitted immediately after the function entry point.
 912 void DwarfException::BeginFunction(const MachineFunction *MF) {
 913   if (!MMI || !MAI->doesSupportExceptionHandling()) return;
 914
 915   TimeRegion Timer(ExceptionTimer);
 916   this->MF = MF;
 917   shouldEmitTable = shouldEmitMoves = false;
 918
 919   // If any landing pads survive, we need an EH table.
 920   shouldEmitTable = !MMI->getLandingPads().empty();
 921
 922   // See if we need frame move info.
 923   shouldEmitMoves = !MF->getFunction()->doesNotThrow() || UnwindTablesMandatory;
 924
 925   if (shouldEmitMoves || shouldEmitTable)
 926     // Assumes in correct section after the entry point.
 927     Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("eh_func_begin",
 928                                                   ++SubprogramCount));
 929
 930   shouldEmitTableModule |= shouldEmitTable;
 931   shouldEmitMovesModule |= shouldEmitMoves;
 932 }
 933
 934 /// EndFunction - Gather and emit post-function exception information.
 935 ///
 936 void DwarfException::EndFunction() {
 937   if (!shouldEmitMoves && !shouldEmitTable) return;
 938
 939   TimeRegion Timer(ExceptionTimer);
 940   Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("eh_func_end",SubprogramCount));
 941
 942   // Record if this personality index uses a landing pad.
 943   bool HasLandingPad = !MMI->getLandingPads().empty();
 944   UsesLSDA[MMI->getPersonalityIndex()] |= HasLandingPad;
 945
 946   // Map all labels and get rid of any dead landing pads.
 947   MMI->TidyLandingPads();
 948
 949   if (HasLandingPad)
 950     EmitExceptionTable();
 951
 952   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
 953   MCSymbol *FunctionEHSym =
 954     Asm->GetSymbolWithGlobalValueBase(MF->getFunction(), ".eh",
 955                                       TLOF.isFunctionEHFrameSymbolPrivate());
 956
 957   // Save EH frame information
 958   EHFrames.push_back(FunctionEHFrameInfo(FunctionEHSym, SubprogramCount,
 959                                          MMI->getPersonalityIndex(),
 960                                          MF->getFrameInfo()->hasCalls(),
 961                                          !MMI->getLandingPads().empty(),
 962                                          MMI->getFrameMoves(),
 963                                          MF->getFunction()));
 964 }