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