https://github.com/john-brawn-arm updated
https://github.com/llvm/llvm-project/pull/85665
>From 665d4034a1428d9b5cf1c4d4e89a16fa00b94fb5 Mon Sep 17 00:00:00 2001
From: John Brawn <john.br...@arm.com>
Date: Thu, 14 Mar 2024 16:17:03 +0000
Subject: [PATCH 1/4] [DebugInfo] Use DW_op_bit_piece for structured bindings
of bitfields
Currently we use DW_OP_plus_uconst to handle the bitfield offset and
handle the bitfield size by choosing a type size that matches, but
this doesn't work if either offset or size aren't byte-aligned. Using
DW_op_bit_piece means we can handle any offset and size.
---
clang/lib/CodeGen/CGDebugInfo.cpp | 52 ++------
clang/lib/CodeGen/CGDebugInfo.h | 3 -
...debug-info-structured-binding-bitfield.cpp | 118 +++++++++---------
.../CodeGen/AsmPrinter/DwarfExpression.cpp | 3 +
llvm/lib/IR/DebugInfoMetadata.cpp | 2 +
5 files changed, 70 insertions(+), 108 deletions(-)
diff --git a/clang/lib/CodeGen/CGDebugInfo.cpp
b/clang/lib/CodeGen/CGDebugInfo.cpp
index c2c01439f2dc9..bf142bdbbe0f9 100644
--- a/clang/lib/CodeGen/CGDebugInfo.cpp
+++ b/clang/lib/CodeGen/CGDebugInfo.cpp
@@ -4777,40 +4777,6 @@ llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const
VarDecl *VD,
return D;
}
-llvm::DIType *CGDebugInfo::CreateBindingDeclType(const BindingDecl *BD) {
- llvm::DIFile *Unit = getOrCreateFile(BD->getLocation());
-
- // If the declaration is bound to a bitfield struct field, its type may have
a
- // size that is different from its deduced declaration type's.
- if (const MemberExpr *ME = dyn_cast<MemberExpr>(BD->getBinding())) {
- if (const FieldDecl *FD = dyn_cast<FieldDecl>(ME->getMemberDecl())) {
- if (FD->isBitField()) {
- ASTContext &Context = CGM.getContext();
- const CGRecordLayout &RL =
- CGM.getTypes().getCGRecordLayout(FD->getParent());
- const CGBitFieldInfo &Info = RL.getBitFieldInfo(FD);
-
- // Find an integer type with the same bitwidth as the bitfield size. If
- // no suitable type is present in the target, give up on producing
debug
- // information as it would be wrong. It is certainly possible to
produce
- // correct debug info, but the logic isn't currently implemented.
- uint64_t BitfieldSizeInBits = Info.Size;
- QualType IntTy =
- Context.getIntTypeForBitwidth(BitfieldSizeInBits, Info.IsSigned);
- if (IntTy.isNull())
- return nullptr;
- Qualifiers Quals = BD->getType().getQualifiers();
- QualType FinalTy = Context.getQualifiedType(IntTy, Quals);
- llvm::DIType *Ty = getOrCreateType(FinalTy, Unit);
- assert(Ty);
- return Ty;
- }
- }
- }
-
- return getOrCreateType(BD->getType(), Unit);
-}
-
llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const BindingDecl *BD,
llvm::Value *Storage,
std::optional<unsigned> ArgNo,
@@ -4825,7 +4791,8 @@ llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const
BindingDecl *BD,
if (isa<DeclRefExpr>(BD->getBinding()))
return nullptr;
- llvm::DIType *Ty = CreateBindingDeclType(BD);
+ llvm::DIFile *Unit = getOrCreateFile(BD->getLocation());
+ llvm::DIType *Ty = getOrCreateType(BD->getType(), Unit);
// If there is no debug info for this type then do not emit debug info
// for this variable.
@@ -4851,7 +4818,6 @@ llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const
BindingDecl *BD,
unsigned Column = getColumnNumber(BD->getLocation());
StringRef Name = BD->getName();
auto *Scope = cast<llvm::DIScope>(LexicalBlockStack.back());
- llvm::DIFile *Unit = getOrCreateFile(BD->getLocation());
// Create the descriptor for the variable.
llvm::DILocalVariable *D = DBuilder.createAutoVariable(
Scope, Name, Unit, Line, Ty, CGM.getLangOpts().Optimize,
@@ -4865,13 +4831,13 @@ llvm::DILocalVariable *CGDebugInfo::EmitDeclare(const
BindingDecl *BD,
const ASTRecordLayout &layout =
CGM.getContext().getASTRecordLayout(parent);
const uint64_t fieldOffset = layout.getFieldOffset(fieldIndex);
-
- if (fieldOffset != 0) {
- // Currently if the field offset is not a multiple of byte, the
produced
- // location would not be accurate. Therefore give up.
- if (fieldOffset % CGM.getContext().getCharWidth() != 0)
- return nullptr;
-
+ if (FD->isBitField()) {
+ Expr.push_back(llvm::dwarf::DW_OP_bit_piece);
+ Expr.push_back(FD->getBitWidthValue(CGM.getContext()));
+ Expr.push_back(fieldOffset);
+ } else if (fieldOffset != 0) {
+ assert(fieldOffset % CGM.getContext().getCharWidth() == 0 &&
+ "Unexpected non-bitfield with non-byte-aligned offset");
Expr.push_back(llvm::dwarf::DW_OP_plus_uconst);
Expr.push_back(
CGM.getContext().toCharUnitsFromBits(fieldOffset).getQuantity());
diff --git a/clang/lib/CodeGen/CGDebugInfo.h b/clang/lib/CodeGen/CGDebugInfo.h
index 7b60e94555d06..af58ccdb5b35d 100644
--- a/clang/lib/CodeGen/CGDebugInfo.h
+++ b/clang/lib/CodeGen/CGDebugInfo.h
@@ -337,9 +337,6 @@ class CGDebugInfo {
llvm::DIScope *RecordTy,
const RecordDecl *RD);
- /// Create type for binding declarations.
- llvm::DIType *CreateBindingDeclType(const BindingDecl *BD);
-
/// Create an anonnymous zero-size separator for bit-field-decl if needed on
/// the target.
llvm::DIDerivedType *createBitFieldSeparatorIfNeeded(
diff --git a/clang/test/CodeGenCXX/debug-info-structured-binding-bitfield.cpp
b/clang/test/CodeGenCXX/debug-info-structured-binding-bitfield.cpp
index d9f5e3eacac37..0cecf74c4bc6f 100644
--- a/clang/test/CodeGenCXX/debug-info-structured-binding-bitfield.cpp
+++ b/clang/test/CodeGenCXX/debug-info-structured-binding-bitfield.cpp
@@ -8,8 +8,8 @@ struct S0 {
// CHECK-LABEL: define dso_local void @_Z3fS0v
// CHECK: alloca %struct.S0, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S0, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S0_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S0_B:![0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 2))
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S0_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S0_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 16))
//
void fS0() {
S0 s0;
@@ -24,8 +24,8 @@ struct S1 {
// CHECK-LABEL: define dso_local void @_Z3fS1v
// CHECK: alloca %struct.S1, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S1, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S1_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S1_B:![0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 2))
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S1_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S1_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 16))
//
void fS1() {
S1 s1;
@@ -40,8 +40,8 @@ struct S2 {
// CHECK-LABEL: define dso_local void @_Z3fS2v
// CHECK: alloca %struct.S2, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S2, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S2_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S2_B:![0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 1))
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S2_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 8, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S2_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 8, 8))
//
void fS2() {
S2 s2;
@@ -56,8 +56,8 @@ struct S3 {
// CHECK-LABEL: define dso_local void @_Z3fS3v
// CHECK: alloca %struct.S3, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S3, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S3_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S3_B:![0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 1))
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S3_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 8, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S3_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 8, 8))
//
void fS3() {
S3 s3;
@@ -72,8 +72,8 @@ struct S4 {
// CHECK-LABEL: define dso_local void @_Z3fS4v
// CHECK: alloca %struct.S4, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S4, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S4_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S4_B:![0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 1))
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S4_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 8, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S4_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 8))
//
void fS4() {
S4 s4;
@@ -88,8 +88,8 @@ struct S5 {
// CHECK-LABEL: define dso_local void @_Z3fS5v
// CHECK: alloca %struct.S5, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S5, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S5_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S5_B:![0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 1))
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S5_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 8, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S5_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 8))
//
void fS5() {
S5 s5;
@@ -104,8 +104,8 @@ struct S6 {
// CHECK-LABEL: define dso_local void @_Z3fS6v
// CHECK: alloca %struct.S6, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S6, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S6_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S6_B:![0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 2))
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S6_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S6_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 8, 16))
//
void fS6() {
S6 s6;
@@ -120,8 +120,8 @@ struct S7 {
// CHECK-LABEL: define dso_local void @_Z3fS7v
// CHECK: alloca %struct.S7, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S7, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S7_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S7_B:![0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 2))
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S7_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S7_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 8, 16))
//
void fS7() {
S7 s7;
@@ -136,8 +136,8 @@ struct S8 {
// CHECK-LABEL: define dso_local void @_Z3fS8v
// CHECK: alloca %struct.S8, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S8, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S8_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S8_B:![0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 2))
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S8_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S8_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 16))
//
void fS8() {
S8 s8;
@@ -152,8 +152,8 @@ struct S9 {
// CHECK-LABEL: define dso_local void @_Z3fS9v
// CHECK: alloca %struct.S9, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S9, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S9_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S9_B:![0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 4))
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S9_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S9_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 32, 32))
//
void fS9() {
S9 s9;
@@ -167,8 +167,8 @@ struct S10 {
// CHECK-LABEL: define dso_local void @_Z4fS10v
// CHECK: alloca %struct.S10, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S10, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S10_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S10_B:![0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 1))
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S10_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 8, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S10_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 8, 8))
//
S10() : x(0), y(0) {}
};
@@ -178,9 +178,6 @@ void fS10() {
auto [a, b] = s10;
}
-// It's currently not possible to produce complete debug information for the
following cases.
-// Confirm that no wrong debug info is output.
-// Once this is implemented, these tests should be amended.
struct S11 {
unsigned int x : 15;
unsigned int y : 16;
@@ -189,7 +186,8 @@ struct S11 {
// CHECK-LABEL: define dso_local void @_Z4fS11v
// CHECK: alloca %struct.S11, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S11, align 4
-// CHECK-NOT: call void @llvm.dbg.declare(metadata ptr [[TMP0]]
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S11_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 15, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S11_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 15))
//
void fS11() {
S11 s11;
@@ -204,8 +202,8 @@ struct S12 {
// CHECK-LABEL: define dso_local void @_Z4fS12v
// CHECK: alloca %struct.S12, align 4
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S12, align 4
-// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S12_A:![0-9]+]], metadata !DIExpression())
-// CHECK-NOT: call void @llvm.dbg.declare(metadata ptr [[TMP0]]
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S12_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S12_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 17, 32))
//
void fS12() {
S12 s12;
@@ -220,7 +218,8 @@ struct __attribute__((packed)) S13 {
// CHECK-LABEL: define dso_local void @_Z4fS13v
// CHECK: alloca %struct.S13, align 1
// CHECK-NEXT: [[TMP0:%.*]] = alloca %struct.S13, align 1
-// CHECK-NOT: call void @llvm.dbg.declare(metadata ptr [[TMP0]]
+// CHECK: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S13_A:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 15, 0))
+// CHECK-NEXT: call void @llvm.dbg.declare(metadata ptr [[TMP0]], metadata
[[S13_B:![0-9]+]], metadata !DIExpression(DW_OP_bit_piece, 16, 15))
//
void fS13() {
S13 s13;
@@ -228,55 +227,50 @@ void fS13() {
}
// CHECK: [[UINT_TY:![0-9]+]] = !DIBasicType(name: "unsigned int", size: 32,
encoding: DW_ATE_unsigned)
-// CHECK: [[S0_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[USHORT_TY:![0-9]+]])
-// CHECK: [[USHORT_TY]] = !DIBasicType(name: "unsigned short", size: 16,
encoding: DW_ATE_unsigned)
-// CHECK: [[S0_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[USHORT_TY]])
+// CHECK: [[S0_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
+// CHECK: [[S0_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
// CHECK: [[VOLATILE_UINT_TY:![0-9]+]] = !DIDerivedType(tag:
DW_TAG_volatile_type, baseType: [[UINT_TY]])
-// CHECK: [[S1_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_USHORT_TY:![0-9]+]])
-// CHECK: [[VOLATILE_USHORT_TY]] = !DIDerivedType(tag: DW_TAG_volatile_type,
baseType: [[USHORT_TY]])
-// CHECK: [[S1_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_USHORT_TY]])
+// CHECK: [[S1_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UINT_TY:![0-9]+]])
+// CHECK: [[S1_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UINT_TY]])
-// CHECK: [[S2_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UCHAR_TY:![0-9]+]])
-// CHECK: [[UCHAR_TY]] = !DIBasicType(name: "unsigned char", size: 8,
encoding: DW_ATE_unsigned_char)
-// CHECK: [[S2_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UCHAR_TY]])
+// CHECK: [[S2_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
+// CHECK: [[S2_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
-// CHECK: [[S3_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UCHAR_TY:![0-9]+]])
-// CHECK: [[VOLATILE_UCHAR_TY]] = !DIDerivedType(tag: DW_TAG_volatile_type,
baseType: [[UCHAR_TY]])
-// CHECK: [[S3_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UCHAR_TY]])
+// CHECK: [[S3_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UINT_TY]])
+// CHECK: [[S3_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UINT_TY]])
-// CHECK: [[S4_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UCHAR_TY]])
-// CHECK: [[S4_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[USHORT_TY]])
+// CHECK: [[S4_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
+// CHECK: [[S4_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
-// CHECK: [[S5_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UCHAR_TY]])
-// CHECK: [[S5_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_USHORT_TY]])
+// CHECK: [[S5_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UINT_TY]])
+// CHECK: [[S5_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UINT_TY]])
-// CHECK: [[S6_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[USHORT_TY]])
-// CHECK: [[S6_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UCHAR_TY]])
+// CHECK: [[S6_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
+// CHECK: [[S6_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
-// CHECK: [[S7_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_USHORT_TY]])
-// CHECK: [[S7_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UCHAR_TY]])
+// CHECK: [[S7_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UINT_TY]])
+// CHECK: [[S7_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UINT_TY]])
-// CHECK: [[S8_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[USHORT_TY]])
-// CHECK: [[S8_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_USHORT_TY]])
+// CHECK: [[S8_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
+// CHECK: [[S8_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[VOLATILE_UINT_TY]])
-// CHECK: [[S9_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[USHORT_TY]])
+// CHECK: [[S9_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
// CHECK: [[S9_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
// CHECK: [[CONST_UINT_TY:![0-9]+]] = !DIDerivedType(tag: DW_TAG_const_type,
baseType: [[UINT_TY]])
-// CHECK: [[S10_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[CONST_UCHAR_TY:![0-9]+]])
-// CHECK: [[CONST_UCHAR_TY]] = !DIDerivedType(tag: DW_TAG_const_type,
baseType: [[UCHAR_TY]])
-// CHECK: [[S10_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[CONST_VOLATILE_UCHAR_TY:![0-9]+]])
-// CHECK: [[CONST_VOLATILE_UCHAR_TY]] = !DIDerivedType(tag: DW_TAG_const_type,
baseType: [[VOLATILE_UCHAR_TY]])
+// CHECK: [[CONST_VOLATILE_UINT_TY:![0-9]+]] = !DIDerivedType(tag:
DW_TAG_const_type, baseType: [[VOLATILE_UINT_TY]])
+// CHECK: [[S10_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[CONST_UINT_TY]])
+// CHECK: [[S10_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[CONST_VOLATILE_UINT_TY]])
// S11
-// CHECK-NOT: !DILocalVariable(name: "a"
-// CHECK-NOT: !DILocalVariable(name: "b"
+// CHECK: [[S11_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
+// CHECK: [[S11_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
// S12
-// CHECK: [[S12_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[USHORT_TY]])
-// CHECK-NOT: !DILocalVariable(name: "b"
+// CHECK: [[S12_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
+// CHECK: [[S12_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
// S13
-// CHECK-NOT: !DILocalVariable(name: "a"
-// CHECK-NOT: !DILocalVariable(name: "b"
\ No newline at end of file
+// CHECK: [[S13_A]] = !DILocalVariable(name: "a", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
+// CHECK: [[S13_B]] = !DILocalVariable(name: "b", scope: {{.*}}, file: {{.*}},
line: {{.*}}, type: [[UINT_TY]])
diff --git a/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp
b/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp
index a74d43897d45b..5a54c4b761a65 100644
--- a/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp
+++ b/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp
@@ -645,6 +645,9 @@ bool DwarfExpression::addExpression(
emitUnsigned(Op->getArg(0));
emitSigned(Op->getArg(1));
break;
+ case dwarf::DW_OP_bit_piece:
+ addOpPiece(Op->getArg(0), Op->getArg(1));
+ break;
default:
llvm_unreachable("unhandled opcode found in expression");
}
diff --git a/llvm/lib/IR/DebugInfoMetadata.cpp
b/llvm/lib/IR/DebugInfoMetadata.cpp
index f37add2120f13..28d8c45c43167 100644
--- a/llvm/lib/IR/DebugInfoMetadata.cpp
+++ b/llvm/lib/IR/DebugInfoMetadata.cpp
@@ -1395,6 +1395,7 @@ unsigned DIExpression::ExprOperand::getSize() const {
case dwarf::DW_OP_LLVM_convert:
case dwarf::DW_OP_LLVM_fragment:
case dwarf::DW_OP_bregx:
+ case dwarf::DW_OP_bit_piece:
return 3;
case dwarf::DW_OP_constu:
case dwarf::DW_OP_consts:
@@ -1494,6 +1495,7 @@ bool DIExpression::isValid() const {
case dwarf::DW_OP_ge:
case dwarf::DW_OP_lt:
case dwarf::DW_OP_le:
+ case dwarf::DW_OP_bit_piece:
break;
}
}
>From 5d35b0fe31d0cab2de6820a09951f7c141dae16c Mon Sep 17 00:00:00 2001
From: John Brawn <john.br...@arm.com>
Date: Wed, 8 May 2024 14:04:57 +0100
Subject: [PATCH 2/4] Add DW_OP_bit_piece test, and adjust DwarfExpression.cpp
so dbg.value works correctly
---
.../CodeGen/AsmPrinter/DwarfExpression.cpp | 10 ++-
llvm/test/DebugInfo/X86/DW_OP_bit_piece.ll | 75 +++++++++++++++++++
2 files changed, 82 insertions(+), 3 deletions(-)
create mode 100644 llvm/test/DebugInfo/X86/DW_OP_bit_piece.ll
diff --git a/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp
b/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp
index 5a54c4b761a65..624e025ac1769 100644
--- a/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp
+++ b/llvm/lib/CodeGen/AsmPrinter/DwarfExpression.cpp
@@ -259,7 +259,8 @@ bool DwarfExpression::addMachineRegExpression(const
TargetRegisterInfo &TRI,
bool HasComplexExpression = false;
auto Op = ExprCursor.peek();
- if (Op && Op->getOp() != dwarf::DW_OP_LLVM_fragment)
+ if (Op && Op->getOp() != dwarf::DW_OP_LLVM_fragment &&
+ Op->getOp() != dwarf::DW_OP_bit_piece)
HasComplexExpression = true;
// If the register can only be described by a complex expression (i.e.,
@@ -314,7 +315,8 @@ bool DwarfExpression::addMachineRegExpression(const
TargetRegisterInfo &TRI,
// operation would emit an OpPiece anyway.
auto NextOp = ExprCursor.peek();
if (SubRegisterSizeInBits && NextOp &&
- (NextOp->getOp() != dwarf::DW_OP_LLVM_fragment))
+ NextOp->getOp() != dwarf::DW_OP_LLVM_fragment &&
+ NextOp->getOp() != dwarf::DW_OP_bit_piece)
maskSubRegister();
return true;
}
@@ -382,7 +384,8 @@ bool DwarfExpression::addMachineRegExpression(const
TargetRegisterInfo &TRI,
// operation would emit an OpPiece anyway.
auto NextOp = ExprCursor.peek();
if (SubRegisterSizeInBits && NextOp &&
- (NextOp->getOp() != dwarf::DW_OP_LLVM_fragment))
+ NextOp->getOp() != dwarf::DW_OP_LLVM_fragment &&
+ NextOp->getOp() != dwarf::DW_OP_bit_piece)
maskSubRegister();
return true;
@@ -473,6 +476,7 @@ static bool isMemoryLocation(DIExpressionCursor ExprCursor)
{
switch (Op->getOp()) {
case dwarf::DW_OP_deref:
case dwarf::DW_OP_LLVM_fragment:
+ case dwarf::DW_OP_bit_piece:
break;
default:
return false;
diff --git a/llvm/test/DebugInfo/X86/DW_OP_bit_piece.ll
b/llvm/test/DebugInfo/X86/DW_OP_bit_piece.ll
new file mode 100644
index 0000000000000..e794a943ed2c6
--- /dev/null
+++ b/llvm/test/DebugInfo/X86/DW_OP_bit_piece.ll
@@ -0,0 +1,75 @@
+; RUN: llc -mtriple=x86_64-unknown-linux-gnu %s -o %t -filetype=obj
+; RUN: llvm-dwarfdump --debug-info %t | FileCheck %s
+
+%struct.struct_t = type { i8 }
+
+@g = dso_local global %struct.struct_t zeroinitializer, align 1, !dbg !0
+
+; CHECK-LABEL: DW_TAG_subprogram
+; CHECK: DW_AT_name ("test1")
+; CHECK: DW_TAG_variable
+; CHECK: DW_AT_location (DW_OP_fbreg -1, DW_OP_bit_piece 0x3 0x0)
+; CHECK: DW_AT_name ("x")
+; CHECK: DW_TAG_variable
+; CHECK: DW_AT_location (DW_OP_fbreg -1, DW_OP_bit_piece 0x4 0x3)
+; CHECK: DW_AT_name ("y")
+
+define i32 @test1() !dbg !13 {
+entry:
+ %0 = alloca %struct.struct_t, align 1
+ tail call void @llvm.dbg.declare(metadata ptr %0, metadata !17, metadata
!DIExpression(DW_OP_bit_piece, 3, 0)), !dbg !18
+ tail call void @llvm.dbg.declare(metadata ptr %0, metadata !19, metadata
!DIExpression(DW_OP_bit_piece, 4, 3)), !dbg !20
+ ret i32 0, !dbg !21
+}
+
+; CHECK-LABEL: DW_TAG_subprogram
+; CHECK: DW_AT_name ("test2")
+; CHECK: DW_TAG_variable
+; CHECK: DW_AT_location (DW_OP_reg0 RAX, DW_OP_bit_piece 0x3 0x0)
+; CHECK: DW_AT_name ("x")
+; CHECK: DW_TAG_variable
+; CHECK: DW_AT_location (DW_OP_reg0 RAX, DW_OP_bit_piece 0x4 0x3)
+; CHECK: DW_AT_name ("y")
+
+define i8 @test2() !dbg !22 {
+entry:
+ %0 = load i8, ptr @g, align 1
+ tail call void @llvm.dbg.value(metadata i8 %0, metadata !23, metadata
!DIExpression(DW_OP_bit_piece, 3, 0)), !dbg !24
+ tail call void @llvm.dbg.value(metadata i8 %0, metadata !25, metadata
!DIExpression(DW_OP_bit_piece, 4, 3)), !dbg !26
+ ret i8 %0, !dbg !27
+}
+
+declare void @llvm.dbg.declare(metadata, metadata, metadata)
+declare void @llvm.dbg.value(metadata, metadata, metadata)
+
+!llvm.dbg.cu = !{!2}
+!llvm.module.flags = !{!11, !12}
+
+!0 = !DIGlobalVariableExpression(var: !1, expr: !DIExpression())
+!1 = distinct !DIGlobalVariable(name: "g", scope: !2, file: !3, line: 6, type:
!5, isLocal: false, isDefinition: true)
+!2 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus_14, file: !3,
isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, globals: !4,
splitDebugInlining: false, nameTableKind: None)
+!3 = !DIFile(filename: "DW_OP_bit_piece.cpp", directory: "./")
+!4 = !{!0}
+!5 = !DIDerivedType(tag: DW_TAG_typedef, name: "struct_t", file: !3, line: 4,
baseType: !6)
+!6 = distinct !DICompositeType(tag: DW_TAG_structure_type, file: !3, line: 1,
size: 8, flags: DIFlagTypePassByValue, elements: !7, identifier:
"_ZTS8struct_t")
+!7 = !{!8, !10}
+!8 = !DIDerivedType(tag: DW_TAG_member, name: "x", scope: !6, file: !3, line:
2, baseType: !9, size: 3, flags: DIFlagBitField, extraData: i64 0)
+!9 = !DIBasicType(name: "unsigned int", size: 32, encoding: DW_ATE_unsigned)
+!10 = !DIDerivedType(tag: DW_TAG_member, name: "y", scope: !6, file: !3, line:
3, baseType: !9, size: 4, offset: 3, flags: DIFlagBitField, extraData: i64 0)
+!11 = !{i32 7, !"Dwarf Version", i32 5}
+!12 = !{i32 2, !"Debug Info Version", i32 3}
+!13 = distinct !DISubprogram(name: "test1", linkageName: "test1", scope: !3,
file: !3, line: 8, type: !14, scopeLine: 8, flags: DIFlagPrototyped, spFlags:
DISPFlagDefinition, unit: !2, retainedNodes: !16)
+!14 = !DISubroutineType(types: !15)
+!15 = !{!9}
+!16 = !{}
+!17 = !DILocalVariable(name: "x", scope: !13, file: !3, line: 9, type: !9)
+!18 = !DILocation(line: 9, column: 9, scope: !13)
+!19 = !DILocalVariable(name: "y", scope: !13, file: !3, line: 9, type: !9)
+!20 = !DILocation(line: 9, column: 12, scope: !13)
+!21 = !DILocation(line: 10, column: 3, scope: !13)
+!22 = distinct !DISubprogram(name: "test2", linkageName: "test2", scope: !3,
file: !3, line: 8, type: !14, scopeLine: 8, flags: DIFlagPrototyped, spFlags:
DISPFlagDefinition, unit: !2, retainedNodes: !16)
+!23 = !DILocalVariable(name: "x", scope: !22, file: !3, line: 9, type: !9)
+!24 = !DILocation(line: 9, column: 9, scope: !22)
+!25 = !DILocalVariable(name: "y", scope: !22, file: !3, line: 9, type: !9)
+!26 = !DILocation(line: 9, column: 12, scope: !22)
+!27 = !DILocation(line: 10, column: 3, scope: !22)
>From c36cdf06159281906f84ce6b3788fd8691840b49 Mon Sep 17 00:00:00 2001
From: John Brawn <john.br...@arm.com>
Date: Wed, 8 May 2024 16:26:51 +0100
Subject: [PATCH 3/4] Add DW_OP_bit_piece to LangRef, and adjust
DW_OP_LLVM_fragment so it's hopefully clearer
---
llvm/docs/LangRef.rst | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/llvm/docs/LangRef.rst b/llvm/docs/LangRef.rst
index e07b642285b3e..82395a3c56d81 100644
--- a/llvm/docs/LangRef.rst
+++ b/llvm/docs/LangRef.rst
@@ -6178,10 +6178,16 @@ The current supported opcode vocabulary is limited:
the last entry from the second last entry and appends the result to the
expression stack.
- ``DW_OP_plus_uconst, 93`` adds ``93`` to the working expression.
-- ``DW_OP_LLVM_fragment, 16, 8`` specifies the offset and size (``16`` and
``8``
- here, respectively) of the variable fragment from the working expression.
Note
- that contrary to DW_OP_bit_piece, the offset is describing the location
- within the described source variable.
+- ``DW_OP_LLVM_fragment, 16, 8`` specifies that the top of the expression stack
+ is a fragment of the source language variable with the given offset and size
+ (``16`` and ``8`` here, respectively). Note that the offset and size are the
+ opposite way around to ``DW_OP_bit_piece``, and the offset is within the
+ source language variable.
+- ``DW_OP_bit_piece, 8, 16`` specifies that the source language variable can be
+ found in the sequence of bits at the given size and offset (``8`` and ``16``
+ here, respectively) within the top of the expression stack. Note that the
+ offset and size are the opposite way around to ``DW_OP_LLVM_fragment``, and
the
+ offset is within the LLVM variable (if that's at the top of the stack).
- ``DW_OP_LLVM_convert, 16, DW_ATE_signed`` specifies a bit size and encoding
(``16`` and ``DW_ATE_signed`` here, respectively) to which the top of the
expression stack is to be converted. Maps into a ``DW_OP_convert`` operation
>From 841d8d0aa4e75e5706e2129dcb25140c3eec9595 Mon Sep 17 00:00:00 2001
From: John Brawn <john.br...@arm.com>
Date: Thu, 9 May 2024 13:40:32 +0100
Subject: [PATCH 4/4] Check that DW_OP_bit_piece is the last expression, and
add test
---
llvm/lib/IR/DebugInfoMetadata.cpp | 4 ++--
llvm/test/Verifier/diexpression-last.ll | 23 +++++++++++++++++++++++
2 files changed, 25 insertions(+), 2 deletions(-)
create mode 100644 llvm/test/Verifier/diexpression-last.ll
diff --git a/llvm/lib/IR/DebugInfoMetadata.cpp
b/llvm/lib/IR/DebugInfoMetadata.cpp
index 28d8c45c43167..b6f6e48dbd2f9 100644
--- a/llvm/lib/IR/DebugInfoMetadata.cpp
+++ b/llvm/lib/IR/DebugInfoMetadata.cpp
@@ -1427,7 +1427,8 @@ bool DIExpression::isValid() const {
default:
return false;
case dwarf::DW_OP_LLVM_fragment:
- // A fragment operator must appear at the end.
+ case dwarf::DW_OP_bit_piece:
+ // A fragment or bit piece operator must appear at the end.
return I->get() + I->getSize() == E->get();
case dwarf::DW_OP_stack_value: {
// Must be the last one or followed by a DW_OP_LLVM_fragment.
@@ -1495,7 +1496,6 @@ bool DIExpression::isValid() const {
case dwarf::DW_OP_ge:
case dwarf::DW_OP_lt:
case dwarf::DW_OP_le:
- case dwarf::DW_OP_bit_piece:
break;
}
}
diff --git a/llvm/test/Verifier/diexpression-last.ll
b/llvm/test/Verifier/diexpression-last.ll
new file mode 100644
index 0000000000000..5cad6b8d36f52
--- /dev/null
+++ b/llvm/test/Verifier/diexpression-last.ll
@@ -0,0 +1,23 @@
+; RUN: not llvm-as -disable-output < %s 2>&1 | FileCheck %s
+
+; Check that we give an error for expressions that are required to be the last
+; in the list.
+
+!named = !{!0, !1, !2, !3, !4, !5}
+; CHECK: invalid expression
+; CHECK-NEXT: !DIExpression({{.+}}, 0, 10, {{.+}})
+!0 = !DIExpression(DW_OP_LLVM_fragment, 0, 10, DW_OP_deref)
+; CHECK: invalid expression
+; CHECK-NEXT: !DIExpression({{.+}}, 0, 20, {{.+}})
+!1 = !DIExpression(DW_OP_bit_piece, 0, 20, DW_OP_deref)
+; CHECK: invalid expression
+; CHECK-NEXT: !DIExpression({{.+}}, 0, 30, {{.+}}, 3, 0)
+!2 = !DIExpression(DW_OP_LLVM_fragment, 0, 30, DW_OP_bit_piece, 3, 0)
+; CHECK: invalid expression
+; CHECK-NEXT: !DIExpression({{.+}}, 40, 0, {{.+}}, 0, 4)
+!3 = !DIExpression(DW_OP_bit_piece, 40, 0, DW_OP_LLVM_fragment, 0, 4)
+
+; We shouldn't give an error if other expressions come earlier
+; CHECK-NOT: invalid expression
+!4 = !DIExpression(DW_OP_deref, DW_OP_LLVM_fragment, 0, 50)
+!5 = !DIExpression(DW_OP_deref, DW_OP_bit_piece, 0, 60)
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
