lib/CodeGen/AsmPrinter/DwarfExpression.cpp

   1 //===- llvm/CodeGen/DwarfExpression.cpp - Dwarf Debug Framework -----------===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // This file contains support for writing dwarf debug info into asm files.
  10 //
  11 //===----------------------------------------------------------------------===//
  12
  13 #include "DwarfExpression.h"
  14 #include "DwarfCompileUnit.h"
  15 #include "llvm/ADT/APInt.h"
  16 #include "llvm/ADT/SmallBitVector.h"
  17 #include "llvm/BinaryFormat/Dwarf.h"
  18 #include "llvm/CodeGen/Register.h"
  19 #include "llvm/CodeGen/TargetRegisterInfo.h"
  20 #include "llvm/IR/DebugInfoMetadata.h"
  21 #include "llvm/Support/ErrorHandling.h"
  22 #include <algorithm>
  23 #include <cassert>
  24 #include <cstdint>
  25
  26 using namespace llvm;
  27
  28 void DwarfExpression::emitConstu(uint64_t Value) {
  29   if (Value < 32)
  30     emitOp(dwarf::DW_OP_lit0 + Value);
  31   else if (Value == std::numeric_limits<uint64_t>::max()) {
  32     // Only do this for 64-bit values as the DWARF expression stack uses
  33     // target-address-size values.
  34     emitOp(dwarf::DW_OP_lit0);
  35     emitOp(dwarf::DW_OP_not);
  36   } else {
  37     emitOp(dwarf::DW_OP_constu);
  38     emitUnsigned(Value);
  39   }
  40 }
  41
  42 void DwarfExpression::addReg(int DwarfReg, const char *Comment) {
  43  assert(DwarfReg >= 0 && "invalid negative dwarf register number");
  44  assert((isUnknownLocation() || isRegisterLocation()) &&
  45         "location description already locked down");
  46  LocationKind = Register;
  47  if (DwarfReg < 32) {
  48    emitOp(dwarf::DW_OP_reg0 + DwarfReg, Comment);
  49   } else {
  50     emitOp(dwarf::DW_OP_regx, Comment);
  51     emitUnsigned(DwarfReg);
  52   }
  53 }
  54
  55 void DwarfExpression::addBReg(int DwarfReg, int Offset) {
  56   assert(DwarfReg >= 0 && "invalid negative dwarf register number");
  57   assert(!isRegisterLocation() && "location description already locked down");
  58   if (DwarfReg < 32) {
  59     emitOp(dwarf::DW_OP_breg0 + DwarfReg);
  60   } else {
  61     emitOp(dwarf::DW_OP_bregx);
  62     emitUnsigned(DwarfReg);
  63   }
  64   emitSigned(Offset);
  65 }
  66
  67 void DwarfExpression::addFBReg(int Offset) {
  68   emitOp(dwarf::DW_OP_fbreg);
  69   emitSigned(Offset);
  70 }
  71
  72 void DwarfExpression::addOpPiece(unsigned SizeInBits, unsigned OffsetInBits) {
  73   if (!SizeInBits)
  74     return;
  75
  76   const unsigned SizeOfByte = 8;
  77   if (OffsetInBits > 0 || SizeInBits % SizeOfByte) {
  78     emitOp(dwarf::DW_OP_bit_piece);
  79     emitUnsigned(SizeInBits);
  80     emitUnsigned(OffsetInBits);
  81   } else {
  82     emitOp(dwarf::DW_OP_piece);
  83     unsigned ByteSize = SizeInBits / SizeOfByte;
  84     emitUnsigned(ByteSize);
  85   }
  86   this->OffsetInBits += SizeInBits;
  87 }
  88
  89 void DwarfExpression::addShr(unsigned ShiftBy) {
  90   emitConstu(ShiftBy);
  91   emitOp(dwarf::DW_OP_shr);
  92 }
  93
  94 void DwarfExpression::addAnd(unsigned Mask) {
  95   emitConstu(Mask);
  96   emitOp(dwarf::DW_OP_and);
  97 }
  98
  99 bool DwarfExpression::addMachineReg(const TargetRegisterInfo &TRI,
 100                                     unsigned MachineReg, unsigned MaxSize) {
 101   if (!llvm::Register::isPhysicalRegister(MachineReg)) {
 102     if (isFrameRegister(TRI, MachineReg)) {
 103       DwarfRegs.push_back({-1, 0, nullptr});
 104       return true;
 105     }
 106     return false;
 107   }
 108
 109   int Reg = TRI.getDwarfRegNum(MachineReg, false);
 110
 111   // If this is a valid register number, emit it.
 112   if (Reg >= 0) {
 113     DwarfRegs.push_back({Reg, 0, nullptr});
 114     return true;
 115   }
 116
 117   // Walk up the super-register chain until we find a valid number.
 118   // For example, EAX on x86_64 is a 32-bit fragment of RAX with offset 0.
 119   for (MCSuperRegIterator SR(MachineReg, &TRI); SR.isValid(); ++SR) {
 120     Reg = TRI.getDwarfRegNum(*SR, false);
 121     if (Reg >= 0) {
 122       unsigned Idx = TRI.getSubRegIndex(*SR, MachineReg);
 123       unsigned Size = TRI.getSubRegIdxSize(Idx);
 124       unsigned RegOffset = TRI.getSubRegIdxOffset(Idx);
 125       DwarfRegs.push_back({Reg, 0, "super-register"});
 126       // Use a DW_OP_bit_piece to describe the sub-register.
 127       setSubRegisterPiece(Size, RegOffset);
 128       return true;
 129     }
 130   }
 131
 132   // Otherwise, attempt to find a covering set of sub-register numbers.
 133   // For example, Q0 on ARM is a composition of D0+D1.
 134   unsigned CurPos = 0;
 135   // The size of the register in bits.
 136   const TargetRegisterClass *RC = TRI.getMinimalPhysRegClass(MachineReg);
 137   unsigned RegSize = TRI.getRegSizeInBits(*RC);
 138   // Keep track of the bits in the register we already emitted, so we
 139   // can avoid emitting redundant aliasing subregs. Because this is
 140   // just doing a greedy scan of all subregisters, it is possible that
 141   // this doesn't find a combination of subregisters that fully cover
 142   // the register (even though one may exist).
 143   SmallBitVector Coverage(RegSize, false);
 144   for (MCSubRegIterator SR(MachineReg, &TRI); SR.isValid(); ++SR) {
 145     unsigned Idx = TRI.getSubRegIndex(MachineReg, *SR);
 146     unsigned Size = TRI.getSubRegIdxSize(Idx);
 147     unsigned Offset = TRI.getSubRegIdxOffset(Idx);
 148     Reg = TRI.getDwarfRegNum(*SR, false);
 149     if (Reg < 0)
 150       continue;
 151
 152     // Intersection between the bits we already emitted and the bits
 153     // covered by this subregister.
 154     SmallBitVector CurSubReg(RegSize, false);
 155     CurSubReg.set(Offset, Offset + Size);
 156
 157     // If this sub-register has a DWARF number and we haven't covered
 158     // its range, emit a DWARF piece for it.
 159     if (CurSubReg.test(Coverage)) {
 160       // Emit a piece for any gap in the coverage.
 161       if (Offset > CurPos)
 162         DwarfRegs.push_back({-1, Offset - CurPos, "no DWARF register encoding"});
 163       DwarfRegs.push_back(
 164           {Reg, std::min<unsigned>(Size, MaxSize - Offset), "sub-register"});
 165       if (Offset >= MaxSize)
 166         break;
 167
 168       // Mark it as emitted.
 169       Coverage.set(Offset, Offset + Size);
 170       CurPos = Offset + Size;
 171     }
 172   }
 173   // Failed to find any DWARF encoding.
 174   if (CurPos == 0)
 175     return false;
 176   // Found a partial or complete DWARF encoding.
 177   if (CurPos < RegSize)
 178     DwarfRegs.push_back({-1, RegSize - CurPos, "no DWARF register encoding"});
 179   return true;
 180 }
 181
 182 void DwarfExpression::addStackValue() {
 183   if (DwarfVersion >= 4)
 184     emitOp(dwarf::DW_OP_stack_value);
 185 }
 186
 187 void DwarfExpression::addSignedConstant(int64_t Value) {
 188   assert(isImplicitLocation() || isUnknownLocation());
 189   LocationKind = Implicit;
 190   emitOp(dwarf::DW_OP_consts);
 191   emitSigned(Value);
 192 }
 193
 194 void DwarfExpression::addUnsignedConstant(uint64_t Value) {
 195   assert(isImplicitLocation() || isUnknownLocation());
 196   LocationKind = Implicit;
 197   emitConstu(Value);
 198 }
 199
 200 void DwarfExpression::addUnsignedConstant(const APInt &Value) {
 201   assert(isImplicitLocation() || isUnknownLocation());
 202   LocationKind = Implicit;
 203
 204   unsigned Size = Value.getBitWidth();
 205   const uint64_t *Data = Value.getRawData();
 206
 207   // Chop it up into 64-bit pieces, because that's the maximum that
 208   // addUnsignedConstant takes.
 209   unsigned Offset = 0;
 210   while (Offset < Size) {
 211     addUnsignedConstant(*Data++);
 212     if (Offset == 0 && Size <= 64)
 213       break;
 214     addStackValue();
 215     addOpPiece(std::min(Size - Offset, 64u), Offset);
 216     Offset += 64;
 217   }
 218 }
 219
 220 bool DwarfExpression::addMachineRegExpression(const TargetRegisterInfo &TRI,
 221                                               DIExpressionCursor &ExprCursor,
 222                                               unsigned MachineReg,
 223                                               unsigned FragmentOffsetInBits) {
 224   auto Fragment = ExprCursor.getFragmentInfo();
 225   if (!addMachineReg(TRI, MachineReg, Fragment ? Fragment->SizeInBits : ~1U)) {
 226     LocationKind = Unknown;
 227     return false;
 228   }
 229
 230   bool HasComplexExpression = false;
 231   auto Op = ExprCursor.peek();
 232   if (Op && Op->getOp() != dwarf::DW_OP_LLVM_fragment)
 233     HasComplexExpression = true;
 234
 235   // If the register can only be described by a complex expression (i.e.,
 236   // multiple subregisters) it doesn't safely compose with another complex
 237   // expression. For example, it is not possible to apply a DW_OP_deref
 238   // operation to multiple DW_OP_pieces.
 239   if (HasComplexExpression && DwarfRegs.size() > 1) {
 240     DwarfRegs.clear();
 241     LocationKind = Unknown;
 242     return false;
 243   }
 244
 245   // Handle simple register locations. If we are supposed to emit
 246   // a call site parameter expression and if that expression is just a register
 247   // location, emit it with addBReg and offset 0, because we should emit a DWARF
 248   // expression representing a value, rather than a location.
 249   if (!isMemoryLocation() && !HasComplexExpression && (!isParameterValue() ||
 250                                                        isEntryValue())) {
 251     for (auto &Reg : DwarfRegs) {
 252       if (Reg.DwarfRegNo >= 0)
 253         addReg(Reg.DwarfRegNo, Reg.Comment);
 254       addOpPiece(Reg.Size);
 255     }
 256
 257     if (isEntryValue() && !isParameterValue() && DwarfVersion >= 4)
 258       emitOp(dwarf::DW_OP_stack_value);
 259
 260     DwarfRegs.clear();
 261     return true;
 262   }
 263
 264   // Don't emit locations that cannot be expressed without DW_OP_stack_value.
 265   if (DwarfVersion < 4)
 266     if (any_of(ExprCursor, [](DIExpression::ExprOperand Op) -> bool {
 267           return Op.getOp() == dwarf::DW_OP_stack_value;
 268         })) {
 269       DwarfRegs.clear();
 270       LocationKind = Unknown;
 271       return false;
 272     }
 273
 274   assert(DwarfRegs.size() == 1);
 275   auto Reg = DwarfRegs[0];
 276   bool FBReg = isFrameRegister(TRI, MachineReg);
 277   int SignedOffset = 0;
 278   assert(Reg.Size == 0 && "subregister has same size as superregister");
 279
 280   // Pattern-match combinations for which more efficient representations exist.
 281   // [Reg, DW_OP_plus_uconst, Offset] --> [DW_OP_breg, Offset].
 282   if (Op && (Op->getOp() == dwarf::DW_OP_plus_uconst)) {
 283     uint64_t Offset = Op->getArg(0);
 284     uint64_t IntMax = static_cast<uint64_t>(std::numeric_limits<int>::max());
 285     if (Offset <= IntMax) {
 286       SignedOffset = Offset;
 287       ExprCursor.take();
 288     }
 289   }
 290
 291   // [Reg, DW_OP_constu, Offset, DW_OP_plus]  --> [DW_OP_breg, Offset]
 292   // [Reg, DW_OP_constu, Offset, DW_OP_minus] --> [DW_OP_breg,-Offset]
 293   // If Reg is a subregister we need to mask it out before subtracting.
 294   if (Op && Op->getOp() == dwarf::DW_OP_constu) {
 295     uint64_t Offset = Op->getArg(0);
 296     uint64_t IntMax = static_cast<uint64_t>(std::numeric_limits<int>::max());
 297     auto N = ExprCursor.peekNext();
 298     if (N && N->getOp() == dwarf::DW_OP_plus && Offset <= IntMax) {
 299       SignedOffset = Offset;
 300       ExprCursor.consume(2);
 301     } else if (N && N->getOp() == dwarf::DW_OP_minus &&
 302                !SubRegisterSizeInBits && Offset <= IntMax + 1) {
 303       SignedOffset = -static_cast<int64_t>(Offset);
 304       ExprCursor.consume(2);
 305     }
 306   }
 307
 308   if (FBReg)
 309     addFBReg(SignedOffset);
 310   else
 311     addBReg(Reg.DwarfRegNo, SignedOffset);
 312   DwarfRegs.clear();
 313   return true;
 314 }
 315
 316 void DwarfExpression::addEntryValueExpression(DIExpressionCursor &ExprCursor) {
 317   auto Op = ExprCursor.take();
 318   assert(Op && Op->getOp() == dwarf::DW_OP_entry_value);
 319   assert(!isMemoryLocation() &&
 320          "We don't support entry values of memory locations yet");
 321
 322   emitOp(CU.getDwarf5OrGNULocationAtom(dwarf::DW_OP_entry_value));
 323   emitUnsigned(Op->getArg(0));
 324 }
 325
 326 /// Assuming a well-formed expression, match "DW_OP_deref* DW_OP_LLVM_fragment?".
 327 static bool isMemoryLocation(DIExpressionCursor ExprCursor) {
 328   while (ExprCursor) {
 329     auto Op = ExprCursor.take();
 330     switch (Op->getOp()) {
 331     case dwarf::DW_OP_deref:
 332     case dwarf::DW_OP_LLVM_fragment:
 333       break;
 334     default:
 335       return false;
 336     }
 337   }
 338   return true;
 339 }
 340
 341 void DwarfExpression::addExpression(DIExpressionCursor &&ExprCursor,
 342                                     unsigned FragmentOffsetInBits) {
 343   // If we need to mask out a subregister, do it now, unless the next
 344   // operation would emit an OpPiece anyway.
 345   auto N = ExprCursor.peek();
 346   if (SubRegisterSizeInBits && N && (N->getOp() != dwarf::DW_OP_LLVM_fragment))
 347     maskSubRegister();
 348
 349   Optional<DIExpression::ExprOperand> PrevConvertOp = None;
 350
 351   while (ExprCursor) {
 352     auto Op = ExprCursor.take();
 353     uint64_t OpNum = Op->getOp();
 354
 355     if (OpNum >= dwarf::DW_OP_reg0 && OpNum <= dwarf::DW_OP_reg31) {
 356       emitOp(OpNum);
 357       continue;
 358     } else if (OpNum >= dwarf::DW_OP_breg0 && OpNum <= dwarf::DW_OP_breg31) {
 359       addBReg(OpNum - dwarf::DW_OP_breg0, Op->getArg(0));
 360       continue;
 361     }
 362
 363     switch (OpNum) {
 364     case dwarf::DW_OP_LLVM_fragment: {
 365       unsigned SizeInBits = Op->getArg(1);
 366       unsigned FragmentOffset = Op->getArg(0);
 367       // The fragment offset must have already been adjusted by emitting an
 368       // empty DW_OP_piece / DW_OP_bit_piece before we emitted the base
 369       // location.
 370       assert(OffsetInBits >= FragmentOffset && "fragment offset not added?");
 371
 372       // If addMachineReg already emitted DW_OP_piece operations to represent
 373       // a super-register by splicing together sub-registers, subtract the size
 374       // of the pieces that was already emitted.
 375       SizeInBits -= OffsetInBits - FragmentOffset;
 376
 377       // If addMachineReg requested a DW_OP_bit_piece to stencil out a
 378       // sub-register that is smaller than the current fragment's size, use it.
 379       if (SubRegisterSizeInBits)
 380         SizeInBits = std::min<unsigned>(SizeInBits, SubRegisterSizeInBits);
 381
 382       // Emit a DW_OP_stack_value for implicit location descriptions.
 383       if (isImplicitLocation())
 384         addStackValue();
 385
 386       // Emit the DW_OP_piece.
 387       addOpPiece(SizeInBits, SubRegisterOffsetInBits);
 388       setSubRegisterPiece(0, 0);
 389       // Reset the location description kind.
 390       LocationKind = Unknown;
 391       return;
 392     }
 393     case dwarf::DW_OP_plus_uconst:
 394       assert(!isRegisterLocation());
 395       emitOp(dwarf::DW_OP_plus_uconst);
 396       emitUnsigned(Op->getArg(0));
 397       break;
 398     case dwarf::DW_OP_plus:
 399     case dwarf::DW_OP_minus:
 400     case dwarf::DW_OP_mul:
 401     case dwarf::DW_OP_div:
 402     case dwarf::DW_OP_mod:
 403     case dwarf::DW_OP_or:
 404     case dwarf::DW_OP_and:
 405     case dwarf::DW_OP_xor:
 406     case dwarf::DW_OP_shl:
 407     case dwarf::DW_OP_shr:
 408     case dwarf::DW_OP_shra:
 409     case dwarf::DW_OP_lit0:
 410     case dwarf::DW_OP_not:
 411     case dwarf::DW_OP_dup:
 412       emitOp(OpNum);
 413       break;
 414     case dwarf::DW_OP_deref:
 415       assert(!isRegisterLocation());
 416       if (!isMemoryLocation() && ::isMemoryLocation(ExprCursor))
 417         // Turning this into a memory location description makes the deref
 418         // implicit.
 419         LocationKind = Memory;
 420       else
 421         emitOp(dwarf::DW_OP_deref);
 422       break;
 423     case dwarf::DW_OP_constu:
 424       assert(!isRegisterLocation());
 425       emitConstu(Op->getArg(0));
 426       break;
 427     case dwarf::DW_OP_LLVM_convert: {
 428       unsigned BitSize = Op->getArg(0);
 429       dwarf::TypeKind Encoding = static_cast<dwarf::TypeKind>(Op->getArg(1));
 430       if (DwarfVersion >= 5) {
 431         emitOp(dwarf::DW_OP_convert);
 432         // Reuse the base_type if we already have one in this CU otherwise we
 433         // create a new one.
 434         unsigned I = 0, E = CU.ExprRefedBaseTypes.size();
 435         for (; I != E; ++I)
 436           if (CU.ExprRefedBaseTypes[I].BitSize == BitSize &&
 437               CU.ExprRefedBaseTypes[I].Encoding == Encoding)
 438             break;
 439
 440         if (I == E)
 441           CU.ExprRefedBaseTypes.emplace_back(BitSize, Encoding);
 442
 443         // If targeting a location-list; simply emit the index into the raw
 444         // byte stream as ULEB128, DwarfDebug::emitDebugLocEntry has been
 445         // fitted with means to extract it later.
 446         // If targeting a inlined DW_AT_location; insert a DIEBaseTypeRef
 447         // (containing the index and a resolve mechanism during emit) into the
 448         // DIE value list.
 449         emitBaseTypeRef(I);
 450       } else {
 451         if (PrevConvertOp && PrevConvertOp->getArg(0) < BitSize) {
 452           if (Encoding == dwarf::DW_ATE_signed)
 453             emitLegacySExt(PrevConvertOp->getArg(0));
 454           else if (Encoding == dwarf::DW_ATE_unsigned)
 455             emitLegacyZExt(PrevConvertOp->getArg(0));
 456           PrevConvertOp = None;
 457         } else {
 458           PrevConvertOp = Op;
 459         }
 460       }
 461       break;
 462     }
 463     case dwarf::DW_OP_stack_value:
 464       LocationKind = Implicit;
 465       break;
 466     case dwarf::DW_OP_swap:
 467       assert(!isRegisterLocation());
 468       emitOp(dwarf::DW_OP_swap);
 469       break;
 470     case dwarf::DW_OP_xderef:
 471       assert(!isRegisterLocation());
 472       emitOp(dwarf::DW_OP_xderef);
 473       break;
 474     case dwarf::DW_OP_deref_size:
 475       emitOp(dwarf::DW_OP_deref_size);
 476       emitData1(Op->getArg(0));
 477       break;
 478     case dwarf::DW_OP_LLVM_tag_offset:
 479       TagOffset = Op->getArg(0);
 480       break;
 481     case dwarf::DW_OP_regx:
 482       emitOp(dwarf::DW_OP_regx);
 483       emitUnsigned(Op->getArg(0));
 484       break;
 485     case dwarf::DW_OP_bregx:
 486       emitOp(dwarf::DW_OP_bregx);
 487       emitUnsigned(Op->getArg(0));
 488       emitSigned(Op->getArg(1));
 489       break;
 490     default:
 491       llvm_unreachable("unhandled opcode found in expression");
 492     }
 493   }
 494
 495   if (isImplicitLocation() && !isParameterValue())
 496     // Turn this into an implicit location description.
 497     addStackValue();
 498 }
 499
 500 /// add masking operations to stencil out a subregister.
 501 void DwarfExpression::maskSubRegister() {
 502   assert(SubRegisterSizeInBits && "no subregister was registered");
 503   if (SubRegisterOffsetInBits > 0)
 504     addShr(SubRegisterOffsetInBits);
 505   uint64_t Mask = (1ULL << (uint64_t)SubRegisterSizeInBits) - 1ULL;
 506   addAnd(Mask);
 507 }
 508
 509 void DwarfExpression::finalize() {
 510   assert(DwarfRegs.size() == 0 && "dwarf registers not emitted");
 511   // Emit any outstanding DW_OP_piece operations to mask out subregisters.
 512   if (SubRegisterSizeInBits == 0)
 513     return;
 514   // Don't emit a DW_OP_piece for a subregister at offset 0.
 515   if (SubRegisterOffsetInBits == 0)
 516     return;
 517   addOpPiece(SubRegisterSizeInBits, SubRegisterOffsetInBits);
 518 }
 519
 520 void DwarfExpression::addFragmentOffset(const DIExpression *Expr) {
 521   if (!Expr || !Expr->isFragment())
 522     return;
 523
 524   uint64_t FragmentOffset = Expr->getFragmentInfo()->OffsetInBits;
 525   assert(FragmentOffset >= OffsetInBits &&
 526          "overlapping or duplicate fragments");
 527   if (FragmentOffset > OffsetInBits)
 528     addOpPiece(FragmentOffset - OffsetInBits);
 529   OffsetInBits = FragmentOffset;
 530 }
 531
 532 void DwarfExpression::emitLegacySExt(unsigned FromBits) {
 533   // (((X >> (FromBits - 1)) * (~0)) << FromBits) | X
 534   emitOp(dwarf::DW_OP_dup);
 535   emitOp(dwarf::DW_OP_constu);
 536   emitUnsigned(FromBits - 1);
 537   emitOp(dwarf::DW_OP_shr);
 538   emitOp(dwarf::DW_OP_lit0);
 539   emitOp(dwarf::DW_OP_not);
 540   emitOp(dwarf::DW_OP_mul);
 541   emitOp(dwarf::DW_OP_constu);
 542   emitUnsigned(FromBits);
 543   emitOp(dwarf::DW_OP_shl);
 544   emitOp(dwarf::DW_OP_or);
 545 }
 546
 547 void DwarfExpression::emitLegacyZExt(unsigned FromBits) {
 548   // (X & (1 << FromBits - 1))
 549   emitOp(dwarf::DW_OP_constu);
 550   emitUnsigned((1ULL << FromBits) - 1);
 551   emitOp(dwarf::DW_OP_and);
 552 }