[clang] 8bf1244 - DebugInfo: workaround for context-sensitive use of non-type-template-parameter integer suffixes
David Blaikie via cfe-commits
cfe-commits at lists.llvm.org
Mon Nov 1 17:08:56 PDT 2021
Author: David Blaikie
Date: 2021-11-01T17:08:26-07:00
New Revision: 8bf12445383b2f3149a9d095bfbc0f6d5b00dfaa
URL: https://github.com/llvm/llvm-project/commit/8bf12445383b2f3149a9d095bfbc0f6d5b00dfaa
DIFF: https://github.com/llvm/llvm-project/commit/8bf12445383b2f3149a9d095bfbc0f6d5b00dfaa.diff
LOG: DebugInfo: workaround for context-sensitive use of non-type-template-parameter integer suffixes
There's a nuanced check about when to use suffixes on these integer
non-type-template-parameters, but when rebuilding names for
-gsimple-template-names there isn't enough data in the DWARF to
determine when to use suffixes or not. So turn on suffixes always to
make it easy to match up names in llvm-dwarfdump --verify.
I /think/ if we correctly modelled auto non-type-template parameters
maybe we could put suffixes only on those. But there's also some logic
in Clang that puts the suffixes on overloaded functions - at least
that's what the parameter says (see D77598 and printTemplateArguments
"TemplOverloaded" parameter) - but I think maybe it's for anything that
/can/ be overloaded, not necessarily only the things that are overloaded
(the argument value is hardcoded at the various callsites, doesn't seem
to depend on overload resolution/searching for overloaded functions). So
maybe with "auto" modeled more accurately, and differentiating between
function templates (always using type suffixes there) and class/variable
templates (only using the suffix for "auto" types) we could correctly
use integer type suffixes only in the minimal set of cases.
But that seems all too much fuss, so let's just put integer type
suffixes everywhere always in the debug info of integer non-type
template parameters in template names.
(more context:
* https://reviews.llvm.org/D77598#inline-1057607
* https://groups.google.com/g/llvm-dev/c/ekLMllbLIZg/m/-dhJ0hO1AAAJ )
Differential Revision: https://reviews.llvm.org/D111477
Added:
Modified:
clang/include/clang/AST/DeclTemplate.h
clang/include/clang/AST/PrettyPrinter.h
clang/lib/AST/DeclPrinter.cpp
clang/lib/AST/DeclTemplate.cpp
clang/lib/AST/Expr.cpp
clang/lib/AST/TypePrinter.cpp
clang/lib/CodeGen/CGDebugInfo.cpp
clang/lib/Sema/SemaDeclCXX.cpp
clang/lib/Sema/SemaTemplate.cpp
clang/test/CodeGenCXX/debug-info-template.cpp
clang/test/Modules/lsv-debuginfo.cpp
libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp
Removed:
################################################################################
diff --git a/clang/include/clang/AST/DeclTemplate.h b/clang/include/clang/AST/DeclTemplate.h
index 2408f50c074b..d33babef958e 100644
--- a/clang/include/clang/AST/DeclTemplate.h
+++ b/clang/include/clang/AST/DeclTemplate.h
@@ -203,7 +203,8 @@ class TemplateParameterList final
void print(raw_ostream &Out, const ASTContext &Context,
const PrintingPolicy &Policy, bool OmitTemplateKW = false) const;
- static bool shouldIncludeTypeForArgument(const TemplateParameterList *TPL,
+ static bool shouldIncludeTypeForArgument(const PrintingPolicy &Policy,
+ const TemplateParameterList *TPL,
unsigned Idx);
};
diff --git a/clang/include/clang/AST/PrettyPrinter.h b/clang/include/clang/AST/PrettyPrinter.h
index 8cab7f189559..38d122db0749 100644
--- a/clang/include/clang/AST/PrettyPrinter.h
+++ b/clang/include/clang/AST/PrettyPrinter.h
@@ -75,7 +75,7 @@ struct PrintingPolicy {
MSVCFormatting(false), ConstantsAsWritten(false),
SuppressImplicitBase(false), FullyQualifiedName(false),
PrintCanonicalTypes(false), PrintInjectedClassNameWithArguments(true),
- UsePreferredNames(true) {}
+ UsePreferredNames(true), UseIntegerTypeSuffixesAlways(false) {}
/// Adjust this printing policy for cases where it's known that we're
/// printing C++ code (for instance, if AST dumping reaches a C++-only
@@ -273,8 +273,15 @@ struct PrintingPolicy {
/// written. When a template argument is unnamed, printing it results in
/// invalid C++ code.
unsigned PrintInjectedClassNameWithArguments : 1;
+
+ /// Whether to use C++ template preferred_name attributes when printing
+ /// templates.
unsigned UsePreferredNames : 1;
+ /// Whether to use type suffixes (eg: 1U) on integral non-type template
+ /// parameters.
+ unsigned UseIntegerTypeSuffixesAlways : 1;
+
/// Callbacks to use to allow the behavior of printing to be customized.
const PrintingCallbacks *Callbacks = nullptr;
};
diff --git a/clang/lib/AST/DeclPrinter.cpp b/clang/lib/AST/DeclPrinter.cpp
index f2d7a792567d..7f3d3c5a9ec3 100644
--- a/clang/lib/AST/DeclPrinter.cpp
+++ b/clang/lib/AST/DeclPrinter.cpp
@@ -1105,9 +1105,9 @@ void DeclPrinter::printTemplateArguments(ArrayRef<TemplateArgument> Args,
if (TemplOverloaded || !Params)
Args[I].print(Policy, Out, /*IncludeType*/ true);
else
- Args[I].print(
- Policy, Out,
- TemplateParameterList::shouldIncludeTypeForArgument(Params, I));
+ Args[I].print(Policy, Out,
+ TemplateParameterList::shouldIncludeTypeForArgument(
+ Policy, Params, I));
}
Out << ">";
}
@@ -1124,7 +1124,8 @@ void DeclPrinter::printTemplateArguments(ArrayRef<TemplateArgumentLoc> Args,
else
Args[I].getArgument().print(
Policy, Out,
- TemplateParameterList::shouldIncludeTypeForArgument(Params, I));
+ TemplateParameterList::shouldIncludeTypeForArgument(Policy, Params,
+ I));
}
Out << ">";
}
diff --git a/clang/lib/AST/DeclTemplate.cpp b/clang/lib/AST/DeclTemplate.cpp
index fa73c5386649..10f7155fcb96 100644
--- a/clang/lib/AST/DeclTemplate.cpp
+++ b/clang/lib/AST/DeclTemplate.cpp
@@ -202,8 +202,9 @@ bool TemplateParameterList::hasAssociatedConstraints() const {
}
bool TemplateParameterList::shouldIncludeTypeForArgument(
- const TemplateParameterList *TPL, unsigned Idx) {
- if (!TPL || Idx >= TPL->size())
+ const PrintingPolicy &Policy, const TemplateParameterList *TPL,
+ unsigned Idx) {
+ if (!TPL || Idx >= TPL->size() || Policy.UseIntegerTypeSuffixesAlways)
return true;
const NamedDecl *TemplParam = TPL->getParam(Idx);
if (const auto *ParamValueDecl =
diff --git a/clang/lib/AST/Expr.cpp b/clang/lib/AST/Expr.cpp
index 415b6e52b564..e7049408eb88 100644
--- a/clang/lib/AST/Expr.cpp
+++ b/clang/lib/AST/Expr.cpp
@@ -763,9 +763,9 @@ std::string PredefinedExpr::ComputeName(IdentKind IK, const Decl *CurrentDecl) {
StringRef Param = Params->getParam(i)->getName();
if (Param.empty()) continue;
TOut << Param << " = ";
- Args.get(i).print(
- Policy, TOut,
- TemplateParameterList::shouldIncludeTypeForArgument(Params, i));
+ Args.get(i).print(Policy, TOut,
+ TemplateParameterList::shouldIncludeTypeForArgument(
+ Policy, Params, i));
TOut << ", ";
}
}
diff --git a/clang/lib/AST/TypePrinter.cpp b/clang/lib/AST/TypePrinter.cpp
index cceed1ca26f3..40127f18ce46 100644
--- a/clang/lib/AST/TypePrinter.cpp
+++ b/clang/lib/AST/TypePrinter.cpp
@@ -2039,9 +2039,9 @@ printTo(raw_ostream &OS, ArrayRef<TA> Args, const PrintingPolicy &Policy,
if (!FirstArg)
OS << Comma;
// Tries to print the argument with location info if exists.
- printArgument(
- Arg, Policy, ArgOS,
- TemplateParameterList::shouldIncludeTypeForArgument(TPL, ParmIndex));
+ printArgument(Arg, Policy, ArgOS,
+ TemplateParameterList::shouldIncludeTypeForArgument(
+ Policy, TPL, ParmIndex));
}
StringRef ArgString = ArgOS.str();
diff --git a/clang/lib/CodeGen/CGDebugInfo.cpp b/clang/lib/CodeGen/CGDebugInfo.cpp
index 6e477d40b83e..64dd70f837f7 100644
--- a/clang/lib/CodeGen/CGDebugInfo.cpp
+++ b/clang/lib/CodeGen/CGDebugInfo.cpp
@@ -247,6 +247,7 @@ PrintingPolicy CGDebugInfo::getPrintingPolicy() const {
PP.SuppressInlineNamespace = false;
PP.PrintCanonicalTypes = true;
PP.UsePreferredNames = false;
+ PP.UseIntegerTypeSuffixesAlways = true;
// Apply -fdebug-prefix-map.
PP.Callbacks = &PrintCB;
diff --git a/clang/lib/Sema/SemaDeclCXX.cpp b/clang/lib/Sema/SemaDeclCXX.cpp
index 05d146cb2494..562d10313ec9 100644
--- a/clang/lib/Sema/SemaDeclCXX.cpp
+++ b/clang/lib/Sema/SemaDeclCXX.cpp
@@ -984,9 +984,9 @@ static std::string printTemplateArgs(const PrintingPolicy &PrintingPolicy,
for (auto &Arg : Args.arguments()) {
if (!First)
OS << ", ";
- Arg.getArgument().print(
- PrintingPolicy, OS,
- TemplateParameterList::shouldIncludeTypeForArgument(Params, I));
+ Arg.getArgument().print(PrintingPolicy, OS,
+ TemplateParameterList::shouldIncludeTypeForArgument(
+ PrintingPolicy, Params, I));
First = false;
I++;
}
diff --git a/clang/lib/Sema/SemaTemplate.cpp b/clang/lib/Sema/SemaTemplate.cpp
index 068b74f0f8ba..aed96e1f404f 100644
--- a/clang/lib/Sema/SemaTemplate.cpp
+++ b/clang/lib/Sema/SemaTemplate.cpp
@@ -10917,9 +10917,9 @@ Sema::getTemplateArgumentBindingsText(const TemplateParameterList *Params,
}
Out << " = ";
- Args[I].print(
- getPrintingPolicy(), Out,
- TemplateParameterList::shouldIncludeTypeForArgument(Params, I));
+ Args[I].print(getPrintingPolicy(), Out,
+ TemplateParameterList::shouldIncludeTypeForArgument(
+ getPrintingPolicy(), Params, I));
}
Out << ']';
diff --git a/clang/test/CodeGenCXX/debug-info-template.cpp b/clang/test/CodeGenCXX/debug-info-template.cpp
index ba25e2136b22..4843f8994356 100644
--- a/clang/test/CodeGenCXX/debug-info-template.cpp
+++ b/clang/test/CodeGenCXX/debug-info-template.cpp
@@ -30,7 +30,7 @@ void func();
// CHECK: ![[TCNESTED]] ={{.*}}!DICompositeType(tag: DW_TAG_structure_type, name: "nested",
// CHECK-SAME: scope: ![[TC:[0-9]+]],
-// CHECK: ![[TC]] = distinct !DICompositeType(tag: DW_TAG_structure_type, name: "TC<unsigned int, 2, &glb, &foo::e, &foo::f, &foo::g, 1, 2, 3>"
+// CHECK: ![[TC]] = distinct !DICompositeType(tag: DW_TAG_structure_type, name: "TC<unsigned int, 2U, &glb, &foo::e, &foo::f, &foo::g, 1, 2, 3>"
// CHECK-SAME: templateParams: [[TCARGS:![0-9]*]]
TC
// CHECK: [[EMPTY:![0-9]*]] = !{}
diff --git a/clang/test/Modules/lsv-debuginfo.cpp b/clang/test/Modules/lsv-debuginfo.cpp
index 30d3c2583fbd..d4c646146b37 100644
--- a/clang/test/Modules/lsv-debuginfo.cpp
+++ b/clang/test/Modules/lsv-debuginfo.cpp
@@ -26,14 +26,14 @@
// CHECK: @__clang_ast =
// This type isn't anchored anywhere, expect a full definition.
-// CHECK: !DICompositeType({{.*}}, name: "AlignedCharArray<4, 16>",
+// CHECK: !DICompositeType({{.*}}, name: "AlignedCharArray<4U, 16U>",
// CHECK-SAME: elements:
// C
// CHECK: @__clang_ast =
// Here, too.
-// CHECK: !DICompositeType({{.*}}, name: "AlignedCharArray<4, 16>",
+// CHECK: !DICompositeType({{.*}}, name: "AlignedCharArray<4U, 16U>",
// CHECK-SAME: elements:
#include <B/B.h>
diff --git a/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp b/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp
index f1cbefbaba6e..f918cf841b32 100644
--- a/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp
+++ b/libcxx/test/libcxx/gdb/gdb_pretty_printer_test.sh.cpp
@@ -244,14 +244,14 @@ void unique_ptr_test() {
void bitset_test() {
std::bitset<258> i_am_empty(0);
- ComparePrettyPrintToChars(i_am_empty, "std::bitset<258>");
+ ComparePrettyPrintToChars(i_am_empty, "std::bitset<258ul>");
std::bitset<0> very_empty;
- ComparePrettyPrintToChars(very_empty, "std::bitset<0>");
+ ComparePrettyPrintToChars(very_empty, "std::bitset<0ul>");
std::bitset<15> b_000001111111100(1020);
ComparePrettyPrintToChars(b_000001111111100,
- "std::bitset<15> = {[2] = 1, [3] = 1, [4] = 1, [5] = 1, [6] = 1, "
+ "std::bitset<15ul> = {[2] = 1, [3] = 1, [4] = 1, [5] = 1, [6] = 1, "
"[7] = 1, [8] = 1, [9] = 1}");
std::bitset<258> b_0_129_132(0);
@@ -259,7 +259,7 @@ void bitset_test() {
b_0_129_132[129] = true;
b_0_129_132[132] = true;
ComparePrettyPrintToChars(b_0_129_132,
- "std::bitset<258> = {[0] = 1, [129] = 1, [132] = 1}");
+ "std::bitset<258ul> = {[0] = 1, [129] = 1, [132] = 1}");
}
void list_test() {
More information about the cfe-commits
mailing list