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