lib/CodeGen/AsmPrinter/DwarfExpression.cpp

   1 //===-- llvm/CodeGen/DwarfExpression.cpp - Dwarf Debug Framework ----------===//
   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 debug info into asm files.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "DwarfExpression.h"
  15
  16 #include "DwarfDebug.h"
  17 #include "llvm/ADT/SmallBitVector.h"
  18 #include "llvm/CodeGen/AsmPrinter.h"
  19 #include "llvm/Support/Dwarf.h"
  20 #include "llvm/Target/TargetMachine.h"
  21 #include "llvm/Target/TargetRegisterInfo.h"
  22 #include "llvm/Target/TargetSubtargetInfo.h"
  23
  24 using namespace llvm;
  25
  26 const TargetRegisterInfo *DwarfExpression::getTRI() const {
  27   return AP.TM.getSubtargetImpl()->getRegisterInfo();
  28 }
  29
  30 unsigned DwarfExpression::getDwarfVersion() const {
  31   return AP.getDwarfDebug()->getDwarfVersion();
  32 }
  33
  34 void DwarfExpression::AddReg(int DwarfReg, const char *Comment) {
  35   assert(DwarfReg >= 0 && "invalid negative dwarf register number");
  36   if (DwarfReg < 32) {
  37     EmitOp(dwarf::DW_OP_reg0 + DwarfReg, Comment);
  38   } else {
  39     EmitOp(dwarf::DW_OP_regx, Comment);
  40     EmitUnsigned(DwarfReg);
  41   }
  42 }
  43
  44 void DwarfExpression::AddRegIndirect(int DwarfReg, int Offset, bool Deref) {
  45   assert(DwarfReg >= 0 && "invalid negative dwarf register number");
  46   if (DwarfReg < 32) {
  47     EmitOp(dwarf::DW_OP_breg0 + DwarfReg);
  48   } else {
  49     EmitOp(dwarf::DW_OP_bregx);
  50     EmitUnsigned(DwarfReg);
  51   }
  52   EmitSigned(Offset);
  53   if (Deref)
  54     EmitOp(dwarf::DW_OP_deref);
  55 }
  56
  57 void DwarfExpression::AddOpPiece(unsigned SizeInBits, unsigned OffsetInBits) {
  58   assert(SizeInBits > 0 && "piece has size zero");
  59   const unsigned SizeOfByte = 8;
  60   if (OffsetInBits > 0 || SizeInBits % SizeOfByte) {
  61     EmitOp(dwarf::DW_OP_bit_piece);
  62     EmitUnsigned(SizeInBits);
  63     EmitUnsigned(OffsetInBits);
  64   } else {
  65     EmitOp(dwarf::DW_OP_piece);
  66     unsigned ByteSize = SizeInBits / SizeOfByte;
  67     EmitUnsigned(ByteSize);
  68   }
  69 }
  70
  71 void DwarfExpression::AddShr(unsigned ShiftBy) {
  72   EmitOp(dwarf::DW_OP_constu);
  73   EmitUnsigned(ShiftBy);
  74   EmitOp(dwarf::DW_OP_shr);
  75 }
  76
  77 bool DwarfExpression::AddMachineRegIndirect(unsigned MachineReg, int Offset) {
  78   int DwarfReg = getTRI()->getDwarfRegNum(MachineReg, false);
  79   if (DwarfReg < 0)
  80     return false;
  81
  82   if (isFrameRegister(MachineReg)) {
  83     // If variable offset is based in frame register then use fbreg.
  84     EmitOp(dwarf::DW_OP_fbreg);
  85     EmitSigned(Offset);
  86   } else {
  87     AddRegIndirect(DwarfReg, Offset);
  88   }
  89   return true;
  90 }
  91
  92 bool DwarfExpression::AddMachineRegPiece(unsigned MachineReg,
  93                                          unsigned PieceSizeInBits,
  94                                          unsigned PieceOffsetInBits) {
  95   const TargetRegisterInfo *TRI = getTRI();
  96   int Reg = TRI->getDwarfRegNum(MachineReg, false);
  97
  98   // If this is a valid register number, emit it.
  99   if (Reg >= 0) {
 100     AddReg(Reg);
 101     if (PieceSizeInBits)
 102       AddOpPiece(PieceSizeInBits, PieceOffsetInBits);
 103     return true;
 104   }
 105
 106   // Walk up the super-register chain until we find a valid number.
 107   // For example, EAX on x86_64 is a 32-bit piece of RAX with offset 0.
 108   for (MCSuperRegIterator SR(MachineReg, TRI); SR.isValid(); ++SR) {
 109     Reg = TRI->getDwarfRegNum(*SR, false);
 110     if (Reg >= 0) {
 111       unsigned Idx = TRI->getSubRegIndex(*SR, MachineReg);
 112       unsigned Size = TRI->getSubRegIdxSize(Idx);
 113       unsigned RegOffset = TRI->getSubRegIdxOffset(Idx);
 114       AddReg(Reg, "super-register");
 115       if (PieceOffsetInBits == RegOffset) {
 116         AddOpPiece(Size, RegOffset);
 117       } else {
 118         // If this is part of a variable in a sub-register at a
 119         // non-zero offset, we need to manually shift the value into
 120         // place, since the DW_OP_piece describes the part of the
 121         // variable, not the position of the subregister.
 122         if (RegOffset)
 123           AddShr(RegOffset);
 124         AddOpPiece(Size, PieceOffsetInBits);
 125       }
 126       return true;
 127     }
 128   }
 129
 130   // Otherwise, attempt to find a covering set of sub-register numbers.
 131   // For example, Q0 on ARM is a composition of D0+D1.
 132   //
 133   // Keep track of the current position so we can emit the more
 134   // efficient DW_OP_piece.
 135   unsigned CurPos = PieceOffsetInBits;
 136   // The size of the register in bits, assuming 8 bits per byte.
 137   unsigned RegSize = TRI->getMinimalPhysRegClass(MachineReg)->getSize() * 8;
 138   // Keep track of the bits in the register we already emitted, so we
 139   // can avoid emitting redundant aliasing subregs.
 140   SmallBitVector Coverage(RegSize, false);
 141   for (MCSubRegIterator SR(MachineReg, TRI); SR.isValid(); ++SR) {
 142     unsigned Idx = TRI->getSubRegIndex(MachineReg, *SR);
 143     unsigned Size = TRI->getSubRegIdxSize(Idx);
 144     unsigned Offset = TRI->getSubRegIdxOffset(Idx);
 145     Reg = TRI->getDwarfRegNum(*SR, false);
 146
 147     // Intersection between the bits we already emitted and the bits
 148     // covered by this subregister.
 149     SmallBitVector Intersection(RegSize, false);
 150     Intersection.set(Offset, Offset + Size);
 151     Intersection ^= Coverage;
 152
 153     // If this sub-register has a DWARF number and we haven't covered
 154     // its range, emit a DWARF piece for it.
 155     if (Reg >= 0 && Intersection.any()) {
 156       AddReg(Reg, "sub-register");
 157       AddOpPiece(Size, Offset == CurPos ? 0 : Offset);
 158       CurPos = Offset + Size;
 159
 160       // Mark it as emitted.
 161       Coverage.set(Offset, Offset + Size);
 162     }
 163   }
 164
 165   return CurPos > PieceOffsetInBits;
 166 }
 167
 168 void DwarfExpression::AddSignedConstant(int Value) {
 169   EmitOp(dwarf::DW_OP_consts);
 170   EmitSigned(Value);
 171   // The proper way to describe a constant value is
 172   // DW_OP_constu <const>, DW_OP_stack_value.
 173   // Unfortunately, DW_OP_stack_value was not available until DWARF-4,
 174   // so we will continue to generate DW_OP_constu <const> for DWARF-2
 175   // and DWARF-3. Technically, this is incorrect since DW_OP_const <const>
 176   // actually describes a value at a constant addess, not a constant value.
 177   // However, in the past there was no better way  to describe a constant
 178   // value, so the producers and consumers started to rely on heuristics
 179   // to disambiguate the value vs. location status of the expression.
 180   // See PR21176 for more details.
 181   if (getDwarfVersion() >= 4)
 182     EmitOp(dwarf::DW_OP_stack_value);
 183 }
 184
 185 void DwarfExpression::AddUnsignedConstant(unsigned Value) {
 186   EmitOp(dwarf::DW_OP_constu);
 187   EmitUnsigned(Value);
 188   // cf. comment in DwarfExpression::AddSignedConstant().
 189   if (getDwarfVersion() >= 4)
 190     EmitOp(dwarf::DW_OP_stack_value);
 191 }
 192
 193 static unsigned getOffsetOrZero(unsigned OffsetInBits,
 194                                 unsigned PieceOffsetInBits) {
 195   if (OffsetInBits == PieceOffsetInBits)
 196     return 0;
 197   assert(OffsetInBits >= PieceOffsetInBits && "overlapping pieces");
 198   return OffsetInBits;
 199 }
 200
 201 bool DwarfExpression::AddMachineRegExpression(DIExpression Expr,
 202                                               unsigned MachineReg,
 203                                               unsigned PieceOffsetInBits) {
 204   unsigned N = Expr.getNumElements();
 205   unsigned I = 0;
 206   bool ValidReg = false;
 207   // Pattern-match combinations for which more efficient representations exist
 208   // first.
 209   if (N >= 3 && Expr.getElement(0) == dwarf::DW_OP_piece) {
 210     unsigned SizeOfByte = 8;
 211     unsigned OffsetInBits = Expr.getElement(1) * SizeOfByte;
 212     unsigned SizeInBits = Expr.getElement(2) * SizeOfByte;
 213     ValidReg =
 214         AddMachineRegPiece(MachineReg, SizeInBits,
 215                            getOffsetOrZero(OffsetInBits, PieceOffsetInBits));
 216     I = 3;
 217   } else if (N >= 3 && Expr.getElement(0) == dwarf::DW_OP_plus &&
 218              Expr.getElement(2) == dwarf::DW_OP_deref) {
 219     // [DW_OP_reg,Offset,DW_OP_plus,DW_OP_deref] --> [DW_OP_breg,Offset].
 220     unsigned Offset = Expr.getElement(1);
 221     ValidReg = AddMachineRegIndirect(MachineReg, Offset);
 222     I = 3;
 223   } else if (N >= 1 && Expr.getElement(0) == dwarf::DW_OP_deref) {
 224     // [DW_OP_reg,DW_OP_deref] --> [DW_OP_breg].
 225     ValidReg = AddMachineRegIndirect(MachineReg);
 226     I = 1;
 227   } else
 228     ValidReg = AddMachineRegPiece(MachineReg);
 229
 230   if (!ValidReg)
 231     return false;
 232
 233   // Emit remaining elements of the expression.
 234   AddExpression(Expr, I);
 235   return true;
 236 }
 237
 238 void DwarfExpression::AddExpression(DIExpression Expr, unsigned I,
 239                                     unsigned PieceOffsetInBits) {
 240   unsigned N = Expr.getNumElements();
 241   for (; I < N; ++I) {
 242     switch (Expr.getElement(I)) {
 243     case dwarf::DW_OP_piece: {
 244       unsigned SizeOfByte = 8;
 245       unsigned OffsetInBits = Expr.getElement(++I) * SizeOfByte;
 246       unsigned SizeInBits = Expr.getElement(++I) * SizeOfByte;
 247       AddOpPiece(SizeInBits, getOffsetOrZero(OffsetInBits, PieceOffsetInBits));
 248       break;
 249     }
 250     case dwarf::DW_OP_plus:
 251       EmitOp(dwarf::DW_OP_plus_uconst);
 252       EmitUnsigned(Expr.getElement(++I));
 253       break;
 254     case dwarf::DW_OP_deref:
 255       EmitOp(dwarf::DW_OP_deref);
 256       break;
 257     default:
 258       llvm_unreachable("unhandled opcode found in DIExpression");
 259     }
 260   }
 261 }