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