lib/CodeGen/AsmPrinter/AsmPrinterDwarf.cpp

   1 //===-- AsmPrinterDwarf.cpp - AsmPrinter Dwarf Support --------------------===//
   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 implements the Dwarf emissions parts of AsmPrinter.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "asm-printer"
  15 #include "llvm/CodeGen/AsmPrinter.h"
  16 #include "llvm/ADT/SmallBitVector.h"
  17 #include "llvm/ADT/Twine.h"
  18 #include "llvm/IR/DataLayout.h"
  19 #include "llvm/MC/MCAsmInfo.h"
  20 #include "llvm/MC/MCSection.h"
  21 #include "llvm/MC/MCStreamer.h"
  22 #include "llvm/MC/MCSymbol.h"
  23 #include "llvm/MC/MachineLocation.h"
  24 #include "llvm/Support/Dwarf.h"
  25 #include "llvm/Support/ErrorHandling.h"
  26 #include "llvm/Target/TargetFrameLowering.h"
  27 #include "llvm/Target/TargetLoweringObjectFile.h"
  28 #include "llvm/Target/TargetMachine.h"
  29 #include "llvm/Target/TargetRegisterInfo.h"
  30 using namespace llvm;
  31
  32 //===----------------------------------------------------------------------===//
  33 // Dwarf Emission Helper Routines
  34 //===----------------------------------------------------------------------===//
  35
  36 /// EmitSLEB128 - emit the specified signed leb128 value.
  37 void AsmPrinter::EmitSLEB128(int64_t Value, const char *Desc) const {
  38   if (isVerbose() && Desc)
  39     OutStreamer.AddComment(Desc);
  40
  41   OutStreamer.EmitSLEB128IntValue(Value);
  42 }
  43
  44 /// EmitULEB128 - emit the specified signed leb128 value.
  45 void AsmPrinter::EmitULEB128(uint64_t Value, const char *Desc,
  46                              unsigned PadTo) const {
  47   if (isVerbose() && Desc)
  48     OutStreamer.AddComment(Desc);
  49
  50   OutStreamer.EmitULEB128IntValue(Value, PadTo);
  51 }
  52
  53 /// EmitCFAByte - Emit a .byte 42 directive for a DW_CFA_xxx value.
  54 void AsmPrinter::EmitCFAByte(unsigned Val) const {
  55   if (isVerbose()) {
  56     if (Val >= dwarf::DW_CFA_offset && Val < dwarf::DW_CFA_offset + 64)
  57       OutStreamer.AddComment("DW_CFA_offset + Reg (" +
  58                              Twine(Val - dwarf::DW_CFA_offset) + ")");
  59     else
  60       OutStreamer.AddComment(dwarf::CallFrameString(Val));
  61   }
  62   OutStreamer.EmitIntValue(Val, 1);
  63 }
  64
  65 static const char *DecodeDWARFEncoding(unsigned Encoding) {
  66   switch (Encoding) {
  67   case dwarf::DW_EH_PE_absptr:
  68     return "absptr";
  69   case dwarf::DW_EH_PE_omit:
  70     return "omit";
  71   case dwarf::DW_EH_PE_pcrel:
  72     return "pcrel";
  73   case dwarf::DW_EH_PE_udata4:
  74     return "udata4";
  75   case dwarf::DW_EH_PE_udata8:
  76     return "udata8";
  77   case dwarf::DW_EH_PE_sdata4:
  78     return "sdata4";
  79   case dwarf::DW_EH_PE_sdata8:
  80     return "sdata8";
  81   case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata4:
  82     return "pcrel udata4";
  83   case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4:
  84     return "pcrel sdata4";
  85   case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata8:
  86     return "pcrel udata8";
  87   case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata8:
  88     return "pcrel sdata8";
  89   case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata4
  90       :
  91     return "indirect pcrel udata4";
  92   case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4
  93       :
  94     return "indirect pcrel sdata4";
  95   case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata8
  96       :
  97     return "indirect pcrel udata8";
  98   case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata8
  99       :
 100     return "indirect pcrel sdata8";
 101   }
 102
 103   return "<unknown encoding>";
 104 }
 105
 106 /// EmitEncodingByte - Emit a .byte 42 directive that corresponds to an
 107 /// encoding.  If verbose assembly output is enabled, we output comments
 108 /// describing the encoding.  Desc is an optional string saying what the
 109 /// encoding is specifying (e.g. "LSDA").
 110 void AsmPrinter::EmitEncodingByte(unsigned Val, const char *Desc) const {
 111   if (isVerbose()) {
 112     if (Desc)
 113       OutStreamer.AddComment(Twine(Desc) + " Encoding = " +
 114                              Twine(DecodeDWARFEncoding(Val)));
 115     else
 116       OutStreamer.AddComment(Twine("Encoding = ") + DecodeDWARFEncoding(Val));
 117   }
 118
 119   OutStreamer.EmitIntValue(Val, 1);
 120 }
 121
 122 /// GetSizeOfEncodedValue - Return the size of the encoding in bytes.
 123 unsigned AsmPrinter::GetSizeOfEncodedValue(unsigned Encoding) const {
 124   if (Encoding == dwarf::DW_EH_PE_omit)
 125     return 0;
 126
 127   switch (Encoding & 0x07) {
 128   default:
 129     llvm_unreachable("Invalid encoded value.");
 130   case dwarf::DW_EH_PE_absptr:
 131     return TM.getDataLayout()->getPointerSize();
 132   case dwarf::DW_EH_PE_udata2:
 133     return 2;
 134   case dwarf::DW_EH_PE_udata4:
 135     return 4;
 136   case dwarf::DW_EH_PE_udata8:
 137     return 8;
 138   }
 139 }
 140
 141 void AsmPrinter::EmitTTypeReference(const GlobalValue *GV,
 142                                     unsigned Encoding) const {
 143   if (GV) {
 144     const TargetLoweringObjectFile &TLOF = getObjFileLowering();
 145
 146     const MCExpr *Exp =
 147         TLOF.getTTypeGlobalReference(GV, Encoding, *Mang, TM, MMI, OutStreamer);
 148     OutStreamer.EmitValue(Exp, GetSizeOfEncodedValue(Encoding));
 149   } else
 150     OutStreamer.EmitIntValue(0, GetSizeOfEncodedValue(Encoding));
 151 }
 152
 153 /// EmitSectionOffset - Emit the 4-byte offset of Label from the start of its
 154 /// section.  This can be done with a special directive if the target supports
 155 /// it (e.g. cygwin) or by emitting it as an offset from a label at the start
 156 /// of the section.
 157 ///
 158 /// SectionLabel is a temporary label emitted at the start of the section that
 159 /// Label lives in.
 160 void AsmPrinter::EmitSectionOffset(const MCSymbol *Label,
 161                                    const MCSymbol *SectionLabel) const {
 162   // On COFF targets, we have to emit the special .secrel32 directive.
 163   if (MAI->needsDwarfSectionOffsetDirective()) {
 164     OutStreamer.EmitCOFFSecRel32(Label);
 165     return;
 166   }
 167
 168   // Get the section that we're referring to, based on SectionLabel.
 169   const MCSection &Section = SectionLabel->getSection();
 170
 171   // If Label has already been emitted, verify that it is in the same section as
 172   // section label for sanity.
 173   assert((!Label->isInSection() || &Label->getSection() == &Section) &&
 174          "Section offset using wrong section base for label");
 175
 176   // If the section in question will end up with an address of 0 anyway, we can
 177   // just emit an absolute reference to save a relocation.
 178   if (Section.isBaseAddressKnownZero()) {
 179     OutStreamer.EmitSymbolValue(Label, 4);
 180     return;
 181   }
 182
 183   // Otherwise, emit it as a label difference from the start of the section.
 184   EmitLabelDifference(Label, SectionLabel, 4);
 185 }
 186
 187 /// Emit a dwarf register operation.
 188 static void emitDwarfRegOp(const AsmPrinter &AP, int Reg) {
 189   assert(Reg >= 0);
 190   if (Reg < 32) {
 191     AP.OutStreamer.AddComment(
 192         dwarf::OperationEncodingString(dwarf::DW_OP_reg0 + Reg));
 193     AP.EmitInt8(dwarf::DW_OP_reg0 + Reg);
 194   } else {
 195     AP.OutStreamer.AddComment("DW_OP_regx");
 196     AP.EmitInt8(dwarf::DW_OP_regx);
 197     AP.OutStreamer.AddComment(Twine(Reg));
 198     AP.EmitULEB128(Reg);
 199   }
 200 }
 201
 202 /// Emit an (double-)indirect dwarf register operation.
 203 static void emitDwarfRegOpIndirect(const AsmPrinter &AP, int Reg, int Offset,
 204                                    bool Deref) {
 205   assert(Reg >= 0);
 206   if (Reg < 32) {
 207     AP.OutStreamer.AddComment(
 208         dwarf::OperationEncodingString(dwarf::DW_OP_breg0 + Reg));
 209     AP.EmitInt8(dwarf::DW_OP_breg0 + Reg);
 210   } else {
 211     AP.OutStreamer.AddComment("DW_OP_bregx");
 212     AP.EmitInt8(dwarf::DW_OP_bregx);
 213     AP.OutStreamer.AddComment(Twine(Reg));
 214     AP.EmitULEB128(Reg);
 215   }
 216   AP.EmitSLEB128(Offset);
 217   if (Deref)
 218     AP.EmitInt8(dwarf::DW_OP_deref);
 219 }
 220
 221 /// Emit a dwarf register operation for describing
 222 /// - a small value occupying only part of a register or
 223 /// - a small register representing only part of a value.
 224 static void emitDwarfOpPiece(const AsmPrinter &AP, unsigned Size,
 225                              unsigned Offset) {
 226   assert(Size > 0);
 227   if (Offset > 0) {
 228     AP.OutStreamer.AddComment("DW_OP_bit_piece");
 229     AP.EmitInt8(dwarf::DW_OP_bit_piece);
 230     AP.OutStreamer.AddComment(Twine(Size));
 231     AP.EmitULEB128(Size);
 232     AP.OutStreamer.AddComment(Twine(Offset));
 233     AP.EmitULEB128(Offset);
 234   } else {
 235     AP.OutStreamer.AddComment("DW_OP_piece");
 236     AP.EmitInt8(dwarf::DW_OP_piece);
 237     unsigned ByteSize = Size / 8; // Assuming 8 bits per byte.
 238     AP.OutStreamer.AddComment(Twine(ByteSize));
 239     AP.EmitULEB128(ByteSize);
 240   }
 241 }
 242
 243 /// Some targets do not provide a DWARF register number for every
 244 /// register.  This function attempts to emit a dwarf register by
 245 /// emitting a piece of a super-register or by piecing together
 246 /// multiple subregisters that alias the register.
 247 static void EmitDwarfRegOpPiece(const AsmPrinter &AP,
 248                                 const MachineLocation &MLoc) {
 249   assert(!MLoc.isIndirect());
 250   const TargetRegisterInfo *TRI = AP.TM.getRegisterInfo();
 251   int Reg = TRI->getDwarfRegNum(MLoc.getReg(), false);
 252
 253   // Walk up the super-register chain until we find a valid number.
 254   // For example, EAX on x86_64 is a 32-bit piece of RAX with offset 0.
 255   for (MCSuperRegIterator SR(MLoc.getReg(), TRI); SR.isValid(); ++SR) {
 256     Reg = TRI->getDwarfRegNum(*SR, false);
 257     if (Reg >= 0) {
 258       unsigned Idx = TRI->getSubRegIndex(*SR, MLoc.getReg());
 259       unsigned Size = TRI->getSubRegIdxSize(Idx);
 260       unsigned Offset = TRI->getSubRegIdxOffset(Idx);
 261       AP.OutStreamer.AddComment("super-register");
 262       emitDwarfRegOp(AP, Reg);
 263       emitDwarfOpPiece(AP, Size, Offset);
 264       return;
 265     }
 266   }
 267
 268   // Otherwise, attempt to find a covering set of sub-register numbers.
 269   // For example, Q0 on ARM is a composition of D0+D1.
 270   //
 271   // Keep track of the current position so we can emit the more
 272   // efficient DW_OP_piece.
 273   unsigned CurPos = 0;
 274   // The size of the register in bits, assuming 8 bits per byte.
 275   unsigned RegSize = TRI->getMinimalPhysRegClass(MLoc.getReg())->getSize() * 8;
 276   // Keep track of the bits in the register we already emitted, so we
 277   // can avoid emitting redundant aliasing subregs.
 278   SmallBitVector Coverage(RegSize, false);
 279   for (MCSubRegIterator SR(MLoc.getReg(), TRI); SR.isValid(); ++SR) {
 280     unsigned Idx = TRI->getSubRegIndex(MLoc.getReg(), *SR);
 281     unsigned Size = TRI->getSubRegIdxSize(Idx);
 282     unsigned Offset = TRI->getSubRegIdxOffset(Idx);
 283     Reg = TRI->getDwarfRegNum(*SR, false);
 284
 285     // Intersection between the bits we already emitted and the bits
 286     // covered by this subregister.
 287     SmallBitVector Intersection(RegSize, false);
 288     Intersection.set(Offset, Offset + Size);
 289     Intersection ^= Coverage;
 290
 291     // If this sub-register has a DWARF number and we haven't covered
 292     // its range, emit a DWARF piece for it.
 293     if (Reg >= 0 && Intersection.any()) {
 294       AP.OutStreamer.AddComment("sub-register");
 295       emitDwarfRegOp(AP, Reg);
 296       emitDwarfOpPiece(AP, Size, Offset == CurPos ? 0 : Offset);
 297       CurPos = Offset + Size;
 298
 299       // Mark it as emitted.
 300       Coverage.set(Offset, Offset + Size);
 301     }
 302   }
 303
 304   if (CurPos == 0) {
 305     // FIXME: We have no reasonable way of handling errors in here.
 306     AP.OutStreamer.AddComment("nop (could not find a dwarf register number)");
 307     AP.EmitInt8(dwarf::DW_OP_nop);
 308   }
 309 }
 310
 311 /// EmitDwarfRegOp - Emit dwarf register operation.
 312 void AsmPrinter::EmitDwarfRegOp(const MachineLocation &MLoc,
 313                                 bool Indirect) const {
 314   const TargetRegisterInfo *TRI = TM.getRegisterInfo();
 315   int Reg = TRI->getDwarfRegNum(MLoc.getReg(), false);
 316   if (Reg < 0) {
 317     // We assume that pointers are always in an addressable register.
 318     if (Indirect || MLoc.isIndirect()) {
 319       // FIXME: We have no reasonable way of handling errors in here. The
 320       // caller might be in the middle of a dwarf expression. We should
 321       // probably assert that Reg >= 0 once debug info generation is more
 322       // mature.
 323       OutStreamer.AddComment(
 324           "nop (invalid dwarf register number for indirect loc)");
 325       EmitInt8(dwarf::DW_OP_nop);
 326       return;
 327     }
 328
 329     // Attempt to find a valid super- or sub-register.
 330     if (!Indirect && !MLoc.isIndirect())
 331       return EmitDwarfRegOpPiece(*this, MLoc);
 332   }
 333
 334   if (MLoc.isIndirect())
 335     emitDwarfRegOpIndirect(*this, Reg, MLoc.getOffset(), Indirect);
 336   else if (Indirect)
 337     emitDwarfRegOpIndirect(*this, Reg, 0, false);
 338   else
 339     emitDwarfRegOp(*this, Reg);
 340 }
 341
 342 //===----------------------------------------------------------------------===//
 343 // Dwarf Lowering Routines
 344 //===----------------------------------------------------------------------===//
 345
 346 void AsmPrinter::emitCFIInstruction(const MCCFIInstruction &Inst) const {
 347   switch (Inst.getOperation()) {
 348   default:
 349     llvm_unreachable("Unexpected instruction");
 350   case MCCFIInstruction::OpDefCfaOffset:
 351     OutStreamer.EmitCFIDefCfaOffset(Inst.getOffset());
 352     break;
 353   case MCCFIInstruction::OpDefCfa:
 354     OutStreamer.EmitCFIDefCfa(Inst.getRegister(), Inst.getOffset());
 355     break;
 356   case MCCFIInstruction::OpDefCfaRegister:
 357     OutStreamer.EmitCFIDefCfaRegister(Inst.getRegister());
 358     break;
 359   case MCCFIInstruction::OpOffset:
 360     OutStreamer.EmitCFIOffset(Inst.getRegister(), Inst.getOffset());
 361     break;
 362   case MCCFIInstruction::OpRegister:
 363     OutStreamer.EmitCFIRegister(Inst.getRegister(), Inst.getRegister2());
 364     break;
 365   case MCCFIInstruction::OpWindowSave:
 366     OutStreamer.EmitCFIWindowSave();
 367     break;
 368   }
 369 }