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