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 #include "ByteStreamer.h"
  15 #include "DwarfExpression.h"
  16 #include "llvm/CodeGen/AsmPrinter.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 #include "llvm/Target/TargetSubtargetInfo.h"
  31 using namespace llvm;
  32
  33 #define DEBUG_TYPE "asm-printer"
  34
  35 /// DwarfExpression implementation for .debug_loc entries.
  36 class DebugLocDwarfExpression : public DwarfExpression {
  37   ByteStreamer &BS;
  38 public:
  39   DebugLocDwarfExpression(TargetMachine &TM, ByteStreamer &BS)
  40     : DwarfExpression(TM), BS(BS) {}
  41
  42   void EmitOp(uint8_t Op, const char* Comment) override;
  43   void EmitSigned(int Value) override;
  44   void EmitUnsigned(unsigned Value) override;
  45 };
  46
  47 void DebugLocDwarfExpression::EmitOp(uint8_t Op, const char* Comment) {
  48   BS.EmitInt8(Op, Comment
  49     ? Twine(Comment)+Twine(" ")+Twine(dwarf::OperationEncodingString(Op))
  50     : dwarf::OperationEncodingString(Op));
  51 }
  52 void DebugLocDwarfExpression::EmitSigned(int Value) {
  53   BS.EmitSLEB128(Value, Twine(Value));
  54 }
  55 void DebugLocDwarfExpression::EmitUnsigned(unsigned Value) {
  56   BS.EmitULEB128(Value, Twine(Value));
  57 }
  58
  59
  60 //===----------------------------------------------------------------------===//
  61 // Dwarf Emission Helper Routines
  62 //===----------------------------------------------------------------------===//
  63
  64 /// EmitSLEB128 - emit the specified signed leb128 value.
  65 void AsmPrinter::EmitSLEB128(int64_t Value, const char *Desc) const {
  66   if (isVerbose() && Desc)
  67     OutStreamer.AddComment(Desc);
  68
  69   OutStreamer.EmitSLEB128IntValue(Value);
  70 }
  71
  72 /// EmitULEB128 - emit the specified signed leb128 value.
  73 void AsmPrinter::EmitULEB128(uint64_t Value, const char *Desc,
  74                              unsigned PadTo) const {
  75   if (isVerbose() && Desc)
  76     OutStreamer.AddComment(Desc);
  77
  78   OutStreamer.EmitULEB128IntValue(Value, PadTo);
  79 }
  80
  81 /// EmitCFAByte - Emit a .byte 42 directive for a DW_CFA_xxx value.
  82 void AsmPrinter::EmitCFAByte(unsigned Val) const {
  83   if (isVerbose()) {
  84     if (Val >= dwarf::DW_CFA_offset && Val < dwarf::DW_CFA_offset + 64)
  85       OutStreamer.AddComment("DW_CFA_offset + Reg (" +
  86                              Twine(Val - dwarf::DW_CFA_offset) + ")");
  87     else
  88       OutStreamer.AddComment(dwarf::CallFrameString(Val));
  89   }
  90   OutStreamer.EmitIntValue(Val, 1);
  91 }
  92
  93 static const char *DecodeDWARFEncoding(unsigned Encoding) {
  94   switch (Encoding) {
  95   case dwarf::DW_EH_PE_absptr:
  96     return "absptr";
  97   case dwarf::DW_EH_PE_omit:
  98     return "omit";
  99   case dwarf::DW_EH_PE_pcrel:
 100     return "pcrel";
 101   case dwarf::DW_EH_PE_udata4:
 102     return "udata4";
 103   case dwarf::DW_EH_PE_udata8:
 104     return "udata8";
 105   case dwarf::DW_EH_PE_sdata4:
 106     return "sdata4";
 107   case dwarf::DW_EH_PE_sdata8:
 108     return "sdata8";
 109   case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata4:
 110     return "pcrel udata4";
 111   case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4:
 112     return "pcrel sdata4";
 113   case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata8:
 114     return "pcrel udata8";
 115   case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata8:
 116     return "pcrel sdata8";
 117   case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata4
 118       :
 119     return "indirect pcrel udata4";
 120   case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4
 121       :
 122     return "indirect pcrel sdata4";
 123   case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata8
 124       :
 125     return "indirect pcrel udata8";
 126   case dwarf::DW_EH_PE_indirect | dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata8
 127       :
 128     return "indirect pcrel sdata8";
 129   }
 130
 131   return "<unknown encoding>";
 132 }
 133
 134 /// EmitEncodingByte - Emit a .byte 42 directive that corresponds to an
 135 /// encoding.  If verbose assembly output is enabled, we output comments
 136 /// describing the encoding.  Desc is an optional string saying what the
 137 /// encoding is specifying (e.g. "LSDA").
 138 void AsmPrinter::EmitEncodingByte(unsigned Val, const char *Desc) const {
 139   if (isVerbose()) {
 140     if (Desc)
 141       OutStreamer.AddComment(Twine(Desc) + " Encoding = " +
 142                              Twine(DecodeDWARFEncoding(Val)));
 143     else
 144       OutStreamer.AddComment(Twine("Encoding = ") + DecodeDWARFEncoding(Val));
 145   }
 146
 147   OutStreamer.EmitIntValue(Val, 1);
 148 }
 149
 150 /// GetSizeOfEncodedValue - Return the size of the encoding in bytes.
 151 unsigned AsmPrinter::GetSizeOfEncodedValue(unsigned Encoding) const {
 152   if (Encoding == dwarf::DW_EH_PE_omit)
 153     return 0;
 154
 155   switch (Encoding & 0x07) {
 156   default:
 157     llvm_unreachable("Invalid encoded value.");
 158   case dwarf::DW_EH_PE_absptr:
 159     return TM.getSubtargetImpl()->getDataLayout()->getPointerSize();
 160   case dwarf::DW_EH_PE_udata2:
 161     return 2;
 162   case dwarf::DW_EH_PE_udata4:
 163     return 4;
 164   case dwarf::DW_EH_PE_udata8:
 165     return 8;
 166   }
 167 }
 168
 169 void AsmPrinter::EmitTTypeReference(const GlobalValue *GV,
 170                                     unsigned Encoding) const {
 171   if (GV) {
 172     const TargetLoweringObjectFile &TLOF = getObjFileLowering();
 173
 174     const MCExpr *Exp =
 175         TLOF.getTTypeGlobalReference(GV, Encoding, *Mang, TM, MMI, OutStreamer);
 176     OutStreamer.EmitValue(Exp, GetSizeOfEncodedValue(Encoding));
 177   } else
 178     OutStreamer.EmitIntValue(0, GetSizeOfEncodedValue(Encoding));
 179 }
 180
 181 /// EmitSectionOffset - Emit the 4-byte offset of Label from the start of its
 182 /// section.  This can be done with a special directive if the target supports
 183 /// it (e.g. cygwin) or by emitting it as an offset from a label at the start
 184 /// of the section.
 185 ///
 186 /// SectionLabel is a temporary label emitted at the start of the section that
 187 /// Label lives in.
 188 void AsmPrinter::EmitSectionOffset(const MCSymbol *Label,
 189                                    const MCSymbol *SectionLabel) const {
 190   // On COFF targets, we have to emit the special .secrel32 directive.
 191   if (MAI->needsDwarfSectionOffsetDirective()) {
 192     OutStreamer.EmitCOFFSecRel32(Label);
 193     return;
 194   }
 195
 196   // Get the section that we're referring to, based on SectionLabel.
 197   const MCSection &Section = SectionLabel->getSection();
 198
 199   // If Label has already been emitted, verify that it is in the same section as
 200   // section label for sanity.
 201   assert((!Label->isInSection() || &Label->getSection() == &Section) &&
 202          "Section offset using wrong section base for label");
 203
 204   // If the section in question will end up with an address of 0 anyway, we can
 205   // just emit an absolute reference to save a relocation.
 206   if (Section.isBaseAddressKnownZero()) {
 207     OutStreamer.EmitSymbolValue(Label, 4);
 208     return;
 209   }
 210
 211   // Otherwise, emit it as a label difference from the start of the section.
 212   EmitLabelDifference(Label, SectionLabel, 4);
 213 }
 214
 215 // Some targets do not provide a DWARF register number for every
 216 // register.  This function attempts to emit a DWARF register by
 217 // emitting a piece of a super-register or by piecing together
 218 // multiple subregisters that alias the register.
 219 void AsmPrinter::EmitDwarfRegOpPiece(ByteStreamer &Streamer,
 220                                      const MachineLocation &MLoc,
 221                                      unsigned PieceSizeInBits,
 222                                      unsigned PieceOffsetInBits) const {
 223   assert(MLoc.isReg() && "MLoc must be a register");
 224   DebugLocDwarfExpression Expr(TM, Streamer);
 225   Expr.AddMachineRegPiece(MLoc.getReg(), PieceSizeInBits, PieceOffsetInBits);
 226 }
 227
 228 void AsmPrinter::EmitDwarfOpPiece(ByteStreamer &Streamer,
 229                                   unsigned PieceSizeInBits,
 230                                   unsigned PieceOffsetInBits) const {
 231   DebugLocDwarfExpression Expr(TM, Streamer);
 232   Expr.AddOpPiece(PieceSizeInBits, PieceOffsetInBits);
 233 }
 234
 235 /// EmitDwarfRegOp - Emit dwarf register operation.
 236 void AsmPrinter::EmitDwarfRegOp(ByteStreamer &Streamer,
 237                                 const MachineLocation &MLoc,
 238                                 bool Indirect) const {
 239   DebugLocDwarfExpression Expr(TM, Streamer);
 240   const TargetRegisterInfo *TRI = TM.getSubtargetImpl()->getRegisterInfo();
 241   int Reg = TRI->getDwarfRegNum(MLoc.getReg(), false);
 242   if (Reg < 0) {
 243     // We assume that pointers are always in an addressable register.
 244     if (Indirect || MLoc.isIndirect())
 245       // FIXME: We have no reasonable way of handling errors in here. The
 246       // caller might be in the middle of a dwarf expression. We should
 247       // probably assert that Reg >= 0 once debug info generation is more
 248       // mature.
 249     return Expr.EmitOp(dwarf::DW_OP_nop,
 250                        "nop (could not find a dwarf register number)");
 251
 252     // Attempt to find a valid super- or sub-register.
 253     return Expr.AddMachineRegPiece(MLoc.getReg());
 254   }
 255
 256   if (MLoc.isIndirect())
 257     Expr.AddRegIndirect(Reg, MLoc.getOffset(), Indirect);
 258   else if (Indirect)
 259     Expr.AddRegIndirect(Reg, 0, false);
 260   else
 261     Expr.AddReg(Reg);
 262 }
 263
 264 //===----------------------------------------------------------------------===//
 265 // Dwarf Lowering Routines
 266 //===----------------------------------------------------------------------===//
 267
 268 void AsmPrinter::emitCFIInstruction(const MCCFIInstruction &Inst) const {
 269   switch (Inst.getOperation()) {
 270   default:
 271     llvm_unreachable("Unexpected instruction");
 272   case MCCFIInstruction::OpDefCfaOffset:
 273     OutStreamer.EmitCFIDefCfaOffset(Inst.getOffset());
 274     break;
 275   case MCCFIInstruction::OpDefCfa:
 276     OutStreamer.EmitCFIDefCfa(Inst.getRegister(), Inst.getOffset());
 277     break;
 278   case MCCFIInstruction::OpDefCfaRegister:
 279     OutStreamer.EmitCFIDefCfaRegister(Inst.getRegister());
 280     break;
 281   case MCCFIInstruction::OpOffset:
 282     OutStreamer.EmitCFIOffset(Inst.getRegister(), Inst.getOffset());
 283     break;
 284   case MCCFIInstruction::OpRegister:
 285     OutStreamer.EmitCFIRegister(Inst.getRegister(), Inst.getRegister2());
 286     break;
 287   case MCCFIInstruction::OpWindowSave:
 288     OutStreamer.EmitCFIWindowSave();
 289     break;
 290   case MCCFIInstruction::OpSameValue:
 291     OutStreamer.EmitCFISameValue(Inst.getRegister());
 292     break;
 293   }
 294 }