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