lib/ExecutionEngine/JIT/JITDwarfEmitter.cpp

   1 //===----- JITDwarfEmitter.cpp - Write dwarf tables into memory -----------===//
   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 defines a JITDwarfEmitter object that is used by the JIT to
  11 // write dwarf tables to memory.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "JIT.h"
  16 #include "JITDwarfEmitter.h"
  17 #include "llvm/Function.h"
  18 #include "llvm/ADT/DenseMap.h"
  19 #include "llvm/CodeGen/JITCodeEmitter.h"
  20 #include "llvm/CodeGen/MachineFunction.h"
  21 #include "llvm/CodeGen/MachineLocation.h"
  22 #include "llvm/CodeGen/MachineModuleInfo.h"
  23 #include "llvm/ExecutionEngine/JITMemoryManager.h"
  24 #include "llvm/Support/ErrorHandling.h"
  25 #include "llvm/MC/MCAsmInfo.h"
  26 #include "llvm/Target/TargetData.h"
  27 #include "llvm/Target/TargetInstrInfo.h"
  28 #include "llvm/Target/TargetFrameInfo.h"
  29 #include "llvm/Target/TargetMachine.h"
  30 #include "llvm/Target/TargetRegisterInfo.h"
  31 using namespace llvm;
  32
  33 JITDwarfEmitter::JITDwarfEmitter(JIT& theJit) : MMI(0), Jit(theJit) {}
  34
  35
  36 unsigned char* JITDwarfEmitter::EmitDwarfTable(MachineFunction& F,
  37                                                JITCodeEmitter& jce,
  38                                                unsigned char* StartFunction,
  39                                                unsigned char* EndFunction,
  40                                                unsigned char* &EHFramePtr) {
  41   assert(MMI && "MachineModuleInfo not registered!");
  42
  43   const TargetMachine& TM = F.getTarget();
  44   TD = TM.getTargetData();
  45   stackGrowthDirection = TM.getFrameInfo()->getStackGrowthDirection();
  46   RI = TM.getRegisterInfo();
  47   JCE = &jce;
  48
  49   unsigned char* ExceptionTable = EmitExceptionTable(&F, StartFunction,
  50                                                      EndFunction);
  51
  52   unsigned char* Result = 0;
  53
  54   const std::vector<Function *> Personalities = MMI->getPersonalities();
  55   EHFramePtr = EmitCommonEHFrame(Personalities[MMI->getPersonalityIndex()]);
  56
  57   Result = EmitEHFrame(Personalities[MMI->getPersonalityIndex()], EHFramePtr,
  58                        StartFunction, EndFunction, ExceptionTable);
  59
  60   return Result;
  61 }
  62
  63
  64 void
  65 JITDwarfEmitter::EmitFrameMoves(intptr_t BaseLabelPtr,
  66                                 const std::vector<MachineMove> &Moves) const {
  67   unsigned PointerSize = TD->getPointerSize();
  68   int stackGrowth = stackGrowthDirection == TargetFrameInfo::StackGrowsUp ?
  69           PointerSize : -PointerSize;
  70   bool IsLocal = false;
  71   unsigned BaseLabelID = 0;
  72
  73   for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
  74     const MachineMove &Move = Moves[i];
  75     unsigned LabelID = Move.getLabelID();
  76
  77     if (LabelID) {
  78       LabelID = MMI->MappedLabel(LabelID);
  79
  80       // Throw out move if the label is invalid.
  81       if (!LabelID) continue;
  82     }
  83
  84     intptr_t LabelPtr = 0;
  85     if (LabelID) LabelPtr = JCE->getLabelAddress(LabelID);
  86
  87     const MachineLocation &Dst = Move.getDestination();
  88     const MachineLocation &Src = Move.getSource();
  89
  90     // Advance row if new location.
  91     if (BaseLabelPtr && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
  92       JCE->emitByte(dwarf::DW_CFA_advance_loc4);
  93       JCE->emitInt32(LabelPtr - BaseLabelPtr);
  94
  95       BaseLabelID = LabelID;
  96       BaseLabelPtr = LabelPtr;
  97       IsLocal = true;
  98     }
  99
 100     // If advancing cfa.
 101     if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
 102       if (!Src.isReg()) {
 103         if (Src.getReg() == MachineLocation::VirtualFP) {
 104           JCE->emitByte(dwarf::DW_CFA_def_cfa_offset);
 105         } else {
 106           JCE->emitByte(dwarf::DW_CFA_def_cfa);
 107           JCE->emitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), true));
 108         }
 109
 110         JCE->emitULEB128Bytes(-Src.getOffset());
 111       } else {
 112         llvm_unreachable("Machine move not supported yet.");
 113       }
 114     } else if (Src.isReg() &&
 115       Src.getReg() == MachineLocation::VirtualFP) {
 116       if (Dst.isReg()) {
 117         JCE->emitByte(dwarf::DW_CFA_def_cfa_register);
 118         JCE->emitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), true));
 119       } else {
 120         llvm_unreachable("Machine move not supported yet.");
 121       }
 122     } else {
 123       unsigned Reg = RI->getDwarfRegNum(Src.getReg(), true);
 124       int Offset = Dst.getOffset() / stackGrowth;
 125
 126       if (Offset < 0) {
 127         JCE->emitByte(dwarf::DW_CFA_offset_extended_sf);
 128         JCE->emitULEB128Bytes(Reg);
 129         JCE->emitSLEB128Bytes(Offset);
 130       } else if (Reg < 64) {
 131         JCE->emitByte(dwarf::DW_CFA_offset + Reg);
 132         JCE->emitULEB128Bytes(Offset);
 133       } else {
 134         JCE->emitByte(dwarf::DW_CFA_offset_extended);
 135         JCE->emitULEB128Bytes(Reg);
 136         JCE->emitULEB128Bytes(Offset);
 137       }
 138     }
 139   }
 140 }
 141
 142 /// SharedTypeIds - How many leading type ids two landing pads have in common.
 143 static unsigned SharedTypeIds(const LandingPadInfo *L,
 144                               const LandingPadInfo *R) {
 145   const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
 146   unsigned LSize = LIds.size(), RSize = RIds.size();
 147   unsigned MinSize = LSize < RSize ? LSize : RSize;
 148   unsigned Count = 0;
 149
 150   for (; Count != MinSize; ++Count)
 151     if (LIds[Count] != RIds[Count])
 152       return Count;
 153
 154   return Count;
 155 }
 156
 157
 158 /// PadLT - Order landing pads lexicographically by type id.
 159 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
 160   const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
 161   unsigned LSize = LIds.size(), RSize = RIds.size();
 162   unsigned MinSize = LSize < RSize ? LSize : RSize;
 163
 164   for (unsigned i = 0; i != MinSize; ++i)
 165     if (LIds[i] != RIds[i])
 166       return LIds[i] < RIds[i];
 167
 168   return LSize < RSize;
 169 }
 170
 171 namespace {
 172
 173 struct KeyInfo {
 174   static inline unsigned getEmptyKey() { return -1U; }
 175   static inline unsigned getTombstoneKey() { return -2U; }
 176   static unsigned getHashValue(const unsigned &Key) { return Key; }
 177   static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
 178 };
 179
 180 /// ActionEntry - Structure describing an entry in the actions table.
 181 struct ActionEntry {
 182   int ValueForTypeID; // The value to write - may not be equal to the type id.
 183   int NextAction;
 184   struct ActionEntry *Previous;
 185 };
 186
 187 /// PadRange - Structure holding a try-range and the associated landing pad.
 188 struct PadRange {
 189   // The index of the landing pad.
 190   unsigned PadIndex;
 191   // The index of the begin and end labels in the landing pad's label lists.
 192   unsigned RangeIndex;
 193 };
 194
 195 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
 196
 197 /// CallSiteEntry - Structure describing an entry in the call-site table.
 198 struct CallSiteEntry {
 199   unsigned BeginLabel; // zero indicates the start of the function.
 200   unsigned EndLabel;   // zero indicates the end of the function.
 201   unsigned PadLabel;   // zero indicates that there is no landing pad.
 202   unsigned Action;
 203 };
 204
 205 }
 206
 207 unsigned char* JITDwarfEmitter::EmitExceptionTable(MachineFunction* MF,
 208                                          unsigned char* StartFunction,
 209                                          unsigned char* EndFunction) const {
 210   assert(MMI && "MachineModuleInfo not registered!");
 211
 212   // Map all labels and get rid of any dead landing pads.
 213   MMI->TidyLandingPads();
 214
 215   const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
 216   const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
 217   const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
 218   if (PadInfos.empty()) return 0;
 219
 220   // Sort the landing pads in order of their type ids.  This is used to fold
 221   // duplicate actions.
 222   SmallVector<const LandingPadInfo *, 64> LandingPads;
 223   LandingPads.reserve(PadInfos.size());
 224   for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
 225     LandingPads.push_back(&PadInfos[i]);
 226   std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
 227
 228   // Negative type ids index into FilterIds, positive type ids index into
 229   // TypeInfos.  The value written for a positive type id is just the type
 230   // id itself.  For a negative type id, however, the value written is the
 231   // (negative) byte offset of the corresponding FilterIds entry.  The byte
 232   // offset is usually equal to the type id, because the FilterIds entries
 233   // are written using a variable width encoding which outputs one byte per
 234   // entry as long as the value written is not too large, but can differ.
 235   // This kind of complication does not occur for positive type ids because
 236   // type infos are output using a fixed width encoding.
 237   // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
 238   SmallVector<int, 16> FilterOffsets;
 239   FilterOffsets.reserve(FilterIds.size());
 240   int Offset = -1;
 241   for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
 242     E = FilterIds.end(); I != E; ++I) {
 243     FilterOffsets.push_back(Offset);
 244     Offset -= MCAsmInfo::getULEB128Size(*I);
 245   }
 246
 247   // Compute the actions table and gather the first action index for each
 248   // landing pad site.
 249   SmallVector<ActionEntry, 32> Actions;
 250   SmallVector<unsigned, 64> FirstActions;
 251   FirstActions.reserve(LandingPads.size());
 252
 253   int FirstAction = 0;
 254   unsigned SizeActions = 0;
 255   for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
 256     const LandingPadInfo *LP = LandingPads[i];
 257     const std::vector<int> &TypeIds = LP->TypeIds;
 258     const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
 259     unsigned SizeSiteActions = 0;
 260
 261     if (NumShared < TypeIds.size()) {
 262       unsigned SizeAction = 0;
 263       ActionEntry *PrevAction = 0;
 264
 265       if (NumShared) {
 266         const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
 267         assert(Actions.size());
 268         PrevAction = &Actions.back();
 269         SizeAction = MCAsmInfo::getSLEB128Size(PrevAction->NextAction) +
 270           MCAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
 271         for (unsigned j = NumShared; j != SizePrevIds; ++j) {
 272           SizeAction -= MCAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
 273           SizeAction += -PrevAction->NextAction;
 274           PrevAction = PrevAction->Previous;
 275         }
 276       }
 277
 278       // Compute the actions.
 279       for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
 280         int TypeID = TypeIds[I];
 281         assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
 282         int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
 283         unsigned SizeTypeID = MCAsmInfo::getSLEB128Size(ValueForTypeID);
 284
 285         int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
 286         SizeAction = SizeTypeID + MCAsmInfo::getSLEB128Size(NextAction);
 287         SizeSiteActions += SizeAction;
 288
 289         ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
 290         Actions.push_back(Action);
 291
 292         PrevAction = &Actions.back();
 293       }
 294
 295       // Record the first action of the landing pad site.
 296       FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
 297     } // else identical - re-use previous FirstAction
 298
 299     FirstActions.push_back(FirstAction);
 300
 301     // Compute this sites contribution to size.
 302     SizeActions += SizeSiteActions;
 303   }
 304
 305   // Compute the call-site table.  Entries must be ordered by address.
 306   SmallVector<CallSiteEntry, 64> CallSites;
 307
 308   RangeMapType PadMap;
 309   for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
 310     const LandingPadInfo *LandingPad = LandingPads[i];
 311     for (unsigned j=0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
 312       unsigned BeginLabel = LandingPad->BeginLabels[j];
 313       assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
 314       PadRange P = { i, j };
 315       PadMap[BeginLabel] = P;
 316     }
 317   }
 318
 319   bool MayThrow = false;
 320   unsigned LastLabel = 0;
 321   for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
 322         I != E; ++I) {
 323     for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
 324           MI != E; ++MI) {
 325       if (!MI->isLabel()) {
 326         MayThrow |= MI->getDesc().isCall();
 327         continue;
 328       }
 329
 330       unsigned BeginLabel = MI->getOperand(0).getImm();
 331       assert(BeginLabel && "Invalid label!");
 332
 333       if (BeginLabel == LastLabel)
 334         MayThrow = false;
 335
 336       RangeMapType::iterator L = PadMap.find(BeginLabel);
 337
 338       if (L == PadMap.end())
 339         continue;
 340
 341       PadRange P = L->second;
 342       const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
 343
 344       assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
 345               "Inconsistent landing pad map!");
 346
 347       // If some instruction between the previous try-range and this one may
 348       // throw, create a call-site entry with no landing pad for the region
 349       // between the try-ranges.
 350       if (MayThrow) {
 351         CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
 352         CallSites.push_back(Site);
 353       }
 354
 355       LastLabel = LandingPad->EndLabels[P.RangeIndex];
 356       CallSiteEntry Site = {BeginLabel, LastLabel,
 357         LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
 358
 359       assert(Site.BeginLabel && Site.EndLabel && Site.PadLabel &&
 360               "Invalid landing pad!");
 361
 362       // Try to merge with the previous call-site.
 363       if (CallSites.size()) {
 364         CallSiteEntry &Prev = CallSites.back();
 365         if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
 366           // Extend the range of the previous entry.
 367           Prev.EndLabel = Site.EndLabel;
 368           continue;
 369         }
 370       }
 371
 372       // Otherwise, create a new call-site.
 373       CallSites.push_back(Site);
 374     }
 375   }
 376   // If some instruction between the previous try-range and the end of the
 377   // function may throw, create a call-site entry with no landing pad for the
 378   // region following the try-range.
 379   if (MayThrow) {
 380     CallSiteEntry Site = {LastLabel, 0, 0, 0};
 381     CallSites.push_back(Site);
 382   }
 383
 384   // Final tallies.
 385   unsigned SizeSites = CallSites.size() * (sizeof(int32_t) + // Site start.
 386                                             sizeof(int32_t) + // Site length.
 387                                             sizeof(int32_t)); // Landing pad.
 388   for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
 389     SizeSites += MCAsmInfo::getULEB128Size(CallSites[i].Action);
 390
 391   unsigned SizeTypes = TypeInfos.size() * TD->getPointerSize();
 392
 393   unsigned TypeOffset = sizeof(int8_t) + // Call site format
 394                         // Call-site table length
 395                         MCAsmInfo::getULEB128Size(SizeSites) +
 396                         SizeSites + SizeActions + SizeTypes;
 397
 398   // Begin the exception table.
 399   JCE->emitAlignmentWithFill(4, 0);
 400   // Asm->EOL("Padding");
 401
 402   unsigned char* DwarfExceptionTable = (unsigned char*)JCE->getCurrentPCValue();
 403
 404   // Emit the header.
 405   JCE->emitByte(dwarf::DW_EH_PE_omit);
 406   // Asm->EOL("LPStart format (DW_EH_PE_omit)");
 407   JCE->emitByte(dwarf::DW_EH_PE_absptr);
 408   // Asm->EOL("TType format (DW_EH_PE_absptr)");
 409   JCE->emitULEB128Bytes(TypeOffset);
 410   // Asm->EOL("TType base offset");
 411   JCE->emitByte(dwarf::DW_EH_PE_udata4);
 412   // Asm->EOL("Call site format (DW_EH_PE_udata4)");
 413   JCE->emitULEB128Bytes(SizeSites);
 414   // Asm->EOL("Call-site table length");
 415
 416   // Emit the landing pad site information.
 417   for (unsigned i = 0; i < CallSites.size(); ++i) {
 418     CallSiteEntry &S = CallSites[i];
 419     intptr_t BeginLabelPtr = 0;
 420     intptr_t EndLabelPtr = 0;
 421
 422     if (!S.BeginLabel) {
 423       BeginLabelPtr = (intptr_t)StartFunction;
 424       JCE->emitInt32(0);
 425     } else {
 426       BeginLabelPtr = JCE->getLabelAddress(S.BeginLabel);
 427       JCE->emitInt32(BeginLabelPtr - (intptr_t)StartFunction);
 428     }
 429
 430     // Asm->EOL("Region start");
 431
 432     if (!S.EndLabel)
 433       EndLabelPtr = (intptr_t)EndFunction;
 434     else
 435       EndLabelPtr = JCE->getLabelAddress(S.EndLabel);
 436
 437     JCE->emitInt32(EndLabelPtr - BeginLabelPtr);
 438     //Asm->EOL("Region length");
 439
 440     if (!S.PadLabel) {
 441       JCE->emitInt32(0);
 442     } else {
 443       unsigned PadLabelPtr = JCE->getLabelAddress(S.PadLabel);
 444       JCE->emitInt32(PadLabelPtr - (intptr_t)StartFunction);
 445     }
 446     // Asm->EOL("Landing pad");
 447
 448     JCE->emitULEB128Bytes(S.Action);
 449     // Asm->EOL("Action");
 450   }
 451
 452   // Emit the actions.
 453   for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
 454     ActionEntry &Action = Actions[I];
 455
 456     JCE->emitSLEB128Bytes(Action.ValueForTypeID);
 457     //Asm->EOL("TypeInfo index");
 458     JCE->emitSLEB128Bytes(Action.NextAction);
 459     //Asm->EOL("Next action");
 460   }
 461
 462   // Emit the type ids.
 463   for (unsigned M = TypeInfos.size(); M; --M) {
 464     GlobalVariable *GV = TypeInfos[M - 1];
 465
 466     if (GV) {
 467       if (TD->getPointerSize() == sizeof(int32_t))
 468         JCE->emitInt32((intptr_t)Jit.getOrEmitGlobalVariable(GV));
 469       else
 470         JCE->emitInt64((intptr_t)Jit.getOrEmitGlobalVariable(GV));
 471     } else {
 472       if (TD->getPointerSize() == sizeof(int32_t))
 473         JCE->emitInt32(0);
 474       else
 475         JCE->emitInt64(0);
 476     }
 477     // Asm->EOL("TypeInfo");
 478   }
 479
 480   // Emit the filter typeids.
 481   for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
 482     unsigned TypeID = FilterIds[j];
 483     JCE->emitULEB128Bytes(TypeID);
 484     //Asm->EOL("Filter TypeInfo index");
 485   }
 486
 487   JCE->emitAlignmentWithFill(4, 0);
 488
 489   return DwarfExceptionTable;
 490 }
 491
 492 unsigned char*
 493 JITDwarfEmitter::EmitCommonEHFrame(const Function* Personality) const {
 494   unsigned PointerSize = TD->getPointerSize();
 495   int stackGrowth = stackGrowthDirection == TargetFrameInfo::StackGrowsUp ?
 496           PointerSize : -PointerSize;
 497
 498   unsigned char* StartCommonPtr = (unsigned char*)JCE->getCurrentPCValue();
 499   // EH Common Frame header
 500   JCE->allocateSpace(4, 0);
 501   unsigned char* FrameCommonBeginPtr = (unsigned char*)JCE->getCurrentPCValue();
 502   JCE->emitInt32((int)0);
 503   JCE->emitByte(dwarf::DW_CIE_VERSION);
 504   JCE->emitString(Personality ? "zPLR" : "zR");
 505   JCE->emitULEB128Bytes(1);
 506   JCE->emitSLEB128Bytes(stackGrowth);
 507   JCE->emitByte(RI->getDwarfRegNum(RI->getRARegister(), true));
 508
 509   if (Personality) {
 510     // Augmentation Size: 3 small ULEBs of one byte each, and the personality
 511     // function which size is PointerSize.
 512     JCE->emitULEB128Bytes(3 + PointerSize);
 513
 514     // We set the encoding of the personality as direct encoding because we use
 515     // the function pointer. The encoding is not relative because the current
 516     // PC value may be bigger than the personality function pointer.
 517     if (PointerSize == 4) {
 518       JCE->emitByte(dwarf::DW_EH_PE_sdata4);
 519       JCE->emitInt32(((intptr_t)Jit.getPointerToGlobal(Personality)));
 520     } else {
 521       JCE->emitByte(dwarf::DW_EH_PE_sdata8);
 522       JCE->emitInt64(((intptr_t)Jit.getPointerToGlobal(Personality)));
 523     }
 524
 525     JCE->emitULEB128Bytes(dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4);
 526     JCE->emitULEB128Bytes(dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4);
 527   } else {
 528     JCE->emitULEB128Bytes(1);
 529     JCE->emitULEB128Bytes(dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4);
 530   }
 531
 532   std::vector<MachineMove> Moves;
 533   RI->getInitialFrameState(Moves);
 534   EmitFrameMoves(0, Moves);
 535
 536   JCE->emitAlignmentWithFill(PointerSize, dwarf::DW_CFA_nop);
 537
 538   JCE->emitInt32At((uintptr_t*)StartCommonPtr,
 539                    (uintptr_t)((unsigned char*)JCE->getCurrentPCValue() -
 540                                FrameCommonBeginPtr));
 541
 542   return StartCommonPtr;
 543 }
 544
 545
 546 unsigned char*
 547 JITDwarfEmitter::EmitEHFrame(const Function* Personality,
 548                              unsigned char* StartCommonPtr,
 549                              unsigned char* StartFunction,
 550                              unsigned char* EndFunction,
 551                              unsigned char* ExceptionTable) const {
 552   unsigned PointerSize = TD->getPointerSize();
 553
 554   // EH frame header.
 555   unsigned char* StartEHPtr = (unsigned char*)JCE->getCurrentPCValue();
 556   JCE->allocateSpace(4, 0);
 557   unsigned char* FrameBeginPtr = (unsigned char*)JCE->getCurrentPCValue();
 558   // FDE CIE Offset
 559   JCE->emitInt32(FrameBeginPtr - StartCommonPtr);
 560   JCE->emitInt32(StartFunction - (unsigned char*)JCE->getCurrentPCValue());
 561   JCE->emitInt32(EndFunction - StartFunction);
 562
 563   // If there is a personality and landing pads then point to the language
 564   // specific data area in the exception table.
 565   if (Personality) {
 566     JCE->emitULEB128Bytes(PointerSize == 4 ? 4 : 8);
 567
 568     if (PointerSize == 4) {
 569       if (!MMI->getLandingPads().empty())
 570         JCE->emitInt32(ExceptionTable-(unsigned char*)JCE->getCurrentPCValue());
 571       else
 572         JCE->emitInt32((int)0);
 573     } else {
 574       if (!MMI->getLandingPads().empty())
 575         JCE->emitInt64(ExceptionTable-(unsigned char*)JCE->getCurrentPCValue());
 576       else
 577         JCE->emitInt64((int)0);
 578     }
 579   } else {
 580     JCE->emitULEB128Bytes(0);
 581   }
 582
 583   // Indicate locations of function specific  callee saved registers in
 584   // frame.
 585   EmitFrameMoves((intptr_t)StartFunction, MMI->getFrameMoves());
 586
 587   JCE->emitAlignmentWithFill(PointerSize, dwarf::DW_CFA_nop);
 588
 589   // Indicate the size of the table
 590   JCE->emitInt32At((uintptr_t*)StartEHPtr,
 591                    (uintptr_t)((unsigned char*)JCE->getCurrentPCValue() -
 592                                StartEHPtr));
 593
 594   // Double zeroes for the unwind runtime
 595   if (PointerSize == 8) {
 596     JCE->emitInt64(0);
 597     JCE->emitInt64(0);
 598   } else {
 599     JCE->emitInt32(0);
 600     JCE->emitInt32(0);
 601   }
 602
 603   return StartEHPtr;
 604 }
 605
 606 unsigned JITDwarfEmitter::GetDwarfTableSizeInBytes(MachineFunction& F,
 607                                          JITCodeEmitter& jce,
 608                                          unsigned char* StartFunction,
 609                                          unsigned char* EndFunction) {
 610   const TargetMachine& TM = F.getTarget();
 611   TD = TM.getTargetData();
 612   stackGrowthDirection = TM.getFrameInfo()->getStackGrowthDirection();
 613   RI = TM.getRegisterInfo();
 614   JCE = &jce;
 615   unsigned FinalSize = 0;
 616
 617   FinalSize += GetExceptionTableSizeInBytes(&F);
 618
 619   const std::vector<Function *> Personalities = MMI->getPersonalities();
 620   FinalSize +=
 621     GetCommonEHFrameSizeInBytes(Personalities[MMI->getPersonalityIndex()]);
 622
 623   FinalSize += GetEHFrameSizeInBytes(Personalities[MMI->getPersonalityIndex()],
 624                                      StartFunction);
 625
 626   return FinalSize;
 627 }
 628
 629 /// RoundUpToAlign - Add the specified alignment to FinalSize and returns
 630 /// the new value.
 631 static unsigned RoundUpToAlign(unsigned FinalSize, unsigned Alignment) {
 632   if (Alignment == 0) Alignment = 1;
 633   // Since we do not know where the buffer will be allocated, be pessimistic.
 634   return FinalSize + Alignment;
 635 }
 636
 637 unsigned
 638 JITDwarfEmitter::GetEHFrameSizeInBytes(const Function* Personality,
 639                                        unsigned char* StartFunction) const {
 640   unsigned PointerSize = TD->getPointerSize();
 641   unsigned FinalSize = 0;
 642   // EH frame header.
 643   FinalSize += PointerSize;
 644   // FDE CIE Offset
 645   FinalSize += 3 * PointerSize;
 646   // If there is a personality and landing pads then point to the language
 647   // specific data area in the exception table.
 648   if (Personality) {
 649     FinalSize += MCAsmInfo::getULEB128Size(4);
 650     FinalSize += PointerSize;
 651   } else {
 652     FinalSize += MCAsmInfo::getULEB128Size(0);
 653   }
 654
 655   // Indicate locations of function specific  callee saved registers in
 656   // frame.
 657   FinalSize += GetFrameMovesSizeInBytes((intptr_t)StartFunction,
 658                                         MMI->getFrameMoves());
 659
 660   FinalSize = RoundUpToAlign(FinalSize, 4);
 661
 662   // Double zeroes for the unwind runtime
 663   FinalSize += 2 * PointerSize;
 664
 665   return FinalSize;
 666 }
 667
 668 unsigned JITDwarfEmitter::GetCommonEHFrameSizeInBytes(const Function* Personality)
 669   const {
 670
 671   unsigned PointerSize = TD->getPointerSize();
 672   int stackGrowth = stackGrowthDirection == TargetFrameInfo::StackGrowsUp ?
 673           PointerSize : -PointerSize;
 674   unsigned FinalSize = 0;
 675   // EH Common Frame header
 676   FinalSize += PointerSize;
 677   FinalSize += 4;
 678   FinalSize += 1;
 679   FinalSize += Personality ? 5 : 3; // "zPLR" or "zR"
 680   FinalSize += MCAsmInfo::getULEB128Size(1);
 681   FinalSize += MCAsmInfo::getSLEB128Size(stackGrowth);
 682   FinalSize += 1;
 683
 684   if (Personality) {
 685     FinalSize += MCAsmInfo::getULEB128Size(7);
 686
 687     // Encoding
 688     FinalSize+= 1;
 689     //Personality
 690     FinalSize += PointerSize;
 691
 692     FinalSize += MCAsmInfo::getULEB128Size(dwarf::DW_EH_PE_pcrel);
 693     FinalSize += MCAsmInfo::getULEB128Size(dwarf::DW_EH_PE_pcrel);
 694
 695   } else {
 696     FinalSize += MCAsmInfo::getULEB128Size(1);
 697     FinalSize += MCAsmInfo::getULEB128Size(dwarf::DW_EH_PE_pcrel);
 698   }
 699
 700   std::vector<MachineMove> Moves;
 701   RI->getInitialFrameState(Moves);
 702   FinalSize += GetFrameMovesSizeInBytes(0, Moves);
 703   FinalSize = RoundUpToAlign(FinalSize, 4);
 704   return FinalSize;
 705 }
 706
 707 unsigned
 708 JITDwarfEmitter::GetFrameMovesSizeInBytes(intptr_t BaseLabelPtr,
 709                                   const std::vector<MachineMove> &Moves) const {
 710   unsigned PointerSize = TD->getPointerSize();
 711   int stackGrowth = stackGrowthDirection == TargetFrameInfo::StackGrowsUp ?
 712           PointerSize : -PointerSize;
 713   bool IsLocal = BaseLabelPtr;
 714   unsigned FinalSize = 0;
 715
 716   for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
 717     const MachineMove &Move = Moves[i];
 718     unsigned LabelID = Move.getLabelID();
 719
 720     if (LabelID) {
 721       LabelID = MMI->MappedLabel(LabelID);
 722
 723       // Throw out move if the label is invalid.
 724       if (!LabelID) continue;
 725     }
 726
 727     intptr_t LabelPtr = 0;
 728     if (LabelID) LabelPtr = JCE->getLabelAddress(LabelID);
 729
 730     const MachineLocation &Dst = Move.getDestination();
 731     const MachineLocation &Src = Move.getSource();
 732
 733     // Advance row if new location.
 734     if (BaseLabelPtr && LabelID && (BaseLabelPtr != LabelPtr || !IsLocal)) {
 735       FinalSize++;
 736       FinalSize += PointerSize;
 737       BaseLabelPtr = LabelPtr;
 738       IsLocal = true;
 739     }
 740
 741     // If advancing cfa.
 742     if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
 743       if (!Src.isReg()) {
 744         if (Src.getReg() == MachineLocation::VirtualFP) {
 745           ++FinalSize;
 746         } else {
 747           ++FinalSize;
 748           unsigned RegNum = RI->getDwarfRegNum(Src.getReg(), true);
 749           FinalSize += MCAsmInfo::getULEB128Size(RegNum);
 750         }
 751
 752         int Offset = -Src.getOffset();
 753
 754         FinalSize += MCAsmInfo::getULEB128Size(Offset);
 755       } else {
 756         llvm_unreachable("Machine move no supported yet.");
 757       }
 758     } else if (Src.isReg() &&
 759       Src.getReg() == MachineLocation::VirtualFP) {
 760       if (Dst.isReg()) {
 761         ++FinalSize;
 762         unsigned RegNum = RI->getDwarfRegNum(Dst.getReg(), true);
 763         FinalSize += MCAsmInfo::getULEB128Size(RegNum);
 764       } else {
 765         llvm_unreachable("Machine move no supported yet.");
 766       }
 767     } else {
 768       unsigned Reg = RI->getDwarfRegNum(Src.getReg(), true);
 769       int Offset = Dst.getOffset() / stackGrowth;
 770
 771       if (Offset < 0) {
 772         ++FinalSize;
 773         FinalSize += MCAsmInfo::getULEB128Size(Reg);
 774         FinalSize += MCAsmInfo::getSLEB128Size(Offset);
 775       } else if (Reg < 64) {
 776         ++FinalSize;
 777         FinalSize += MCAsmInfo::getULEB128Size(Offset);
 778       } else {
 779         ++FinalSize;
 780         FinalSize += MCAsmInfo::getULEB128Size(Reg);
 781         FinalSize += MCAsmInfo::getULEB128Size(Offset);
 782       }
 783     }
 784   }
 785   return FinalSize;
 786 }
 787
 788 unsigned
 789 JITDwarfEmitter::GetExceptionTableSizeInBytes(MachineFunction* MF) const {
 790   unsigned FinalSize = 0;
 791
 792   // Map all labels and get rid of any dead landing pads.
 793   MMI->TidyLandingPads();
 794
 795   const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
 796   const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
 797   const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
 798   if (PadInfos.empty()) return 0;
 799
 800   // Sort the landing pads in order of their type ids.  This is used to fold
 801   // duplicate actions.
 802   SmallVector<const LandingPadInfo *, 64> LandingPads;
 803   LandingPads.reserve(PadInfos.size());
 804   for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
 805     LandingPads.push_back(&PadInfos[i]);
 806   std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
 807
 808   // Negative type ids index into FilterIds, positive type ids index into
 809   // TypeInfos.  The value written for a positive type id is just the type
 810   // id itself.  For a negative type id, however, the value written is the
 811   // (negative) byte offset of the corresponding FilterIds entry.  The byte
 812   // offset is usually equal to the type id, because the FilterIds entries
 813   // are written using a variable width encoding which outputs one byte per
 814   // entry as long as the value written is not too large, but can differ.
 815   // This kind of complication does not occur for positive type ids because
 816   // type infos are output using a fixed width encoding.
 817   // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
 818   SmallVector<int, 16> FilterOffsets;
 819   FilterOffsets.reserve(FilterIds.size());
 820   int Offset = -1;
 821   for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
 822     E = FilterIds.end(); I != E; ++I) {
 823     FilterOffsets.push_back(Offset);
 824     Offset -= MCAsmInfo::getULEB128Size(*I);
 825   }
 826
 827   // Compute the actions table and gather the first action index for each
 828   // landing pad site.
 829   SmallVector<ActionEntry, 32> Actions;
 830   SmallVector<unsigned, 64> FirstActions;
 831   FirstActions.reserve(LandingPads.size());
 832
 833   int FirstAction = 0;
 834   unsigned SizeActions = 0;
 835   for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
 836     const LandingPadInfo *LP = LandingPads[i];
 837     const std::vector<int> &TypeIds = LP->TypeIds;
 838     const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
 839     unsigned SizeSiteActions = 0;
 840
 841     if (NumShared < TypeIds.size()) {
 842       unsigned SizeAction = 0;
 843       ActionEntry *PrevAction = 0;
 844
 845       if (NumShared) {
 846         const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
 847         assert(Actions.size());
 848         PrevAction = &Actions.back();
 849         SizeAction = MCAsmInfo::getSLEB128Size(PrevAction->NextAction) +
 850           MCAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
 851         for (unsigned j = NumShared; j != SizePrevIds; ++j) {
 852           SizeAction -= MCAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
 853           SizeAction += -PrevAction->NextAction;
 854           PrevAction = PrevAction->Previous;
 855         }
 856       }
 857
 858       // Compute the actions.
 859       for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
 860         int TypeID = TypeIds[I];
 861         assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
 862         int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
 863         unsigned SizeTypeID = MCAsmInfo::getSLEB128Size(ValueForTypeID);
 864
 865         int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
 866         SizeAction = SizeTypeID + MCAsmInfo::getSLEB128Size(NextAction);
 867         SizeSiteActions += SizeAction;
 868
 869         ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
 870         Actions.push_back(Action);
 871
 872         PrevAction = &Actions.back();
 873       }
 874
 875       // Record the first action of the landing pad site.
 876       FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
 877     } // else identical - re-use previous FirstAction
 878
 879     FirstActions.push_back(FirstAction);
 880
 881     // Compute this sites contribution to size.
 882     SizeActions += SizeSiteActions;
 883   }
 884
 885   // Compute the call-site table.  Entries must be ordered by address.
 886   SmallVector<CallSiteEntry, 64> CallSites;
 887
 888   RangeMapType PadMap;
 889   for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
 890     const LandingPadInfo *LandingPad = LandingPads[i];
 891     for (unsigned j=0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
 892       unsigned BeginLabel = LandingPad->BeginLabels[j];
 893       assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
 894       PadRange P = { i, j };
 895       PadMap[BeginLabel] = P;
 896     }
 897   }
 898
 899   bool MayThrow = false;
 900   unsigned LastLabel = 0;
 901   for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
 902         I != E; ++I) {
 903     for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
 904           MI != E; ++MI) {
 905       if (!MI->isLabel()) {
 906         MayThrow |= MI->getDesc().isCall();
 907         continue;
 908       }
 909
 910       unsigned BeginLabel = MI->getOperand(0).getImm();
 911       assert(BeginLabel && "Invalid label!");
 912
 913       if (BeginLabel == LastLabel)
 914         MayThrow = false;
 915
 916       RangeMapType::iterator L = PadMap.find(BeginLabel);
 917
 918       if (L == PadMap.end())
 919         continue;
 920
 921       PadRange P = L->second;
 922       const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
 923
 924       assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
 925               "Inconsistent landing pad map!");
 926
 927       // If some instruction between the previous try-range and this one may
 928       // throw, create a call-site entry with no landing pad for the region
 929       // between the try-ranges.
 930       if (MayThrow) {
 931         CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
 932         CallSites.push_back(Site);
 933       }
 934
 935       LastLabel = LandingPad->EndLabels[P.RangeIndex];
 936       CallSiteEntry Site = {BeginLabel, LastLabel,
 937         LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
 938
 939       assert(Site.BeginLabel && Site.EndLabel && Site.PadLabel &&
 940               "Invalid landing pad!");
 941
 942       // Try to merge with the previous call-site.
 943       if (CallSites.size()) {
 944         CallSiteEntry &Prev = CallSites.back();
 945         if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
 946           // Extend the range of the previous entry.
 947           Prev.EndLabel = Site.EndLabel;
 948           continue;
 949         }
 950       }
 951
 952       // Otherwise, create a new call-site.
 953       CallSites.push_back(Site);
 954     }
 955   }
 956   // If some instruction between the previous try-range and the end of the
 957   // function may throw, create a call-site entry with no landing pad for the
 958   // region following the try-range.
 959   if (MayThrow) {
 960     CallSiteEntry Site = {LastLabel, 0, 0, 0};
 961     CallSites.push_back(Site);
 962   }
 963
 964   // Final tallies.
 965   unsigned SizeSites = CallSites.size() * (sizeof(int32_t) + // Site start.
 966                                             sizeof(int32_t) + // Site length.
 967                                             sizeof(int32_t)); // Landing pad.
 968   for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
 969     SizeSites += MCAsmInfo::getULEB128Size(CallSites[i].Action);
 970
 971   unsigned SizeTypes = TypeInfos.size() * TD->getPointerSize();
 972
 973   unsigned TypeOffset = sizeof(int8_t) + // Call site format
 974                         // Call-site table length
 975                         MCAsmInfo::getULEB128Size(SizeSites) +
 976                         SizeSites + SizeActions + SizeTypes;
 977
 978   unsigned TotalSize = sizeof(int8_t) + // LPStart format
 979                        sizeof(int8_t) + // TType format
 980                        MCAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
 981                        TypeOffset;
 982
 983   unsigned SizeAlign = (4 - TotalSize) & 3;
 984
 985   // Begin the exception table.
 986   FinalSize = RoundUpToAlign(FinalSize, 4);
 987   for (unsigned i = 0; i != SizeAlign; ++i) {
 988     ++FinalSize;
 989   }
 990
 991   unsigned PointerSize = TD->getPointerSize();
 992
 993   // Emit the header.
 994   ++FinalSize;
 995   // Asm->EOL("LPStart format (DW_EH_PE_omit)");
 996   ++FinalSize;
 997   // Asm->EOL("TType format (DW_EH_PE_absptr)");
 998   ++FinalSize;
 999   // Asm->EOL("TType base offset");
1000   ++FinalSize;
1001   // Asm->EOL("Call site format (DW_EH_PE_udata4)");
1002   ++FinalSize;
1003   // Asm->EOL("Call-site table length");
1004
1005   // Emit the landing pad site information.
1006   for (unsigned i = 0; i < CallSites.size(); ++i) {
1007     CallSiteEntry &S = CallSites[i];
1008
1009     // Asm->EOL("Region start");
1010     FinalSize += PointerSize;
1011
1012     //Asm->EOL("Region length");
1013     FinalSize += PointerSize;
1014
1015     // Asm->EOL("Landing pad");
1016     FinalSize += PointerSize;
1017
1018     FinalSize += MCAsmInfo::getULEB128Size(S.Action);
1019     // Asm->EOL("Action");
1020   }
1021
1022   // Emit the actions.
1023   for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
1024     ActionEntry &Action = Actions[I];
1025
1026     //Asm->EOL("TypeInfo index");
1027     FinalSize += MCAsmInfo::getSLEB128Size(Action.ValueForTypeID);
1028     //Asm->EOL("Next action");
1029     FinalSize += MCAsmInfo::getSLEB128Size(Action.NextAction);
1030   }
1031
1032   // Emit the type ids.
1033   for (unsigned M = TypeInfos.size(); M; --M) {
1034     // Asm->EOL("TypeInfo");
1035     FinalSize += PointerSize;
1036   }
1037
1038   // Emit the filter typeids.
1039   for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
1040     unsigned TypeID = FilterIds[j];
1041     FinalSize += MCAsmInfo::getULEB128Size(TypeID);
1042     //Asm->EOL("Filter TypeInfo index");
1043   }
1044
1045   FinalSize = RoundUpToAlign(FinalSize, 4);
1046
1047   return FinalSize;
1048 }