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