Skip to content

Commit 8dd2971

Browse files
adrian-prantladrian-prantl
authored
Merge pull request #73652 from Snowy1803/6.0-complete-getvarinfo
[6.0] [DebugInfo] Return complete variable info from getVarInfo by default
2 parents 60cbe5e + 2b3bdfd commit 8dd2971

30 files changed

+242
-120
lines changed

‎docs/HowToUpdateDebugInfo.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,9 @@ debug_value %0 : $*T, let, name "address", type $UnsafeRawPointer
108108
The variable will usually have an associated expression yielding the correct
109109
type.
110110

111+
> [!Note]
112+
> As there are no pointers in Swift, the type should never be an address type.
113+
111114
### Variable expressions
112115

113116
A variable can have an associated expression if the value needs computation.

‎include/swift/SIL/DebugUtils.h

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -437,16 +437,24 @@ struct DebugVarCarryingInst : VarDeclCarryingInst {
437437

438438
Kind getKind() const { return Kind(VarDeclCarryingInst::getKind()); }
439439

440-
std::optional<SILDebugVariable> getVarInfo() const {
440+
/// Returns the debug variable information attached to the instruction.
441+
///
442+
/// \param complete If true, always retrieve the complete variable with
443+
/// location and scope, and the type if possible. If false, only return the
444+
/// values if they are stored (if they are different from the instruction's
445+
/// location, scope, and type). This should only be set to false in
446+
/// SILPrinter. Incomplete var info is unpredictable, as it will sometimes
447+
/// have location and scope and sometimes not.
448+
std::optional<SILDebugVariable> getVarInfo(bool complete = true) const {
441449
switch (getKind()) {
442450
case Kind::Invalid:
443451
llvm_unreachable("Invalid?!");
444452
case Kind::DebugValue:
445-
return cast<DebugValueInst>(**this)->getVarInfo();
453+
return cast<DebugValueInst>(**this)->getVarInfo(complete);
446454
case Kind::AllocStack:
447-
return cast<AllocStackInst>(**this)->getVarInfo();
455+
return cast<AllocStackInst>(**this)->getVarInfo(complete);
448456
case Kind::AllocBox:
449-
return cast<AllocBoxInst>(**this)->getVarInfo();
457+
return cast<AllocBoxInst>(**this)->getVarInfo(complete);
450458
}
451459
llvm_unreachable("covered switch");
452460
}

‎include/swift/SIL/SILBuilder.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ class SILBuilder {
425425
#endif
426426
// Don't apply location overrides on variables.
427427
if (Var && !Var->Loc)
428-
Var->Loc = Loc;
428+
Var->Loc = Loc.strippedForDebugVariable();
429429
return insert(AllocStackInst::create(
430430
getSILDebugLocation(Loc, true), elementType, getFunction(),
431431
substituteAnonymousArgs(Name, Var, Loc), dynamic, isLexical,

‎include/swift/SIL/SILDebugInfoExpression.h

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,16 @@ class SILDebugInfoExpression {
296296
return Elements.size() &&
297297
Elements[0].getAsOperator() == SILDIExprOperator::Dereference;
298298
}
299+
300+
/// Return the part of this SILDebugInfoExpression corresponding to fragments
301+
SILDebugInfoExpression getFragmentPart() const {
302+
for (auto it = element_begin(), end = element_end(); it != end; ++it) {
303+
if (it->getAsOperator() == SILDIExprOperator::Fragment
304+
|| it->getAsOperator() == SILDIExprOperator::TupleFragment)
305+
return SILDebugInfoExpression(ArrayRef(it, element_end()));
306+
}
307+
return {};
308+
}
299309
};
300310

301311
/// Returns the hashcode for the di expr element.

‎include/swift/SIL/SILInstruction.h

Lines changed: 48 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1875,9 +1875,9 @@ class TailAllocatedDebugVariable {
18751875
bool isLet() const { return Bits.Data.Constant; }
18761876

18771877
std::optional<SILDebugVariable>
1878-
get(VarDecl *VD, const char *buf, std::optional<SILType> AuxVarType = {},
1879-
std::optional<SILLocation> DeclLoc = {},
1880-
const SILDebugScope *DeclScope = nullptr,
1878+
get(VarDecl *VD, const char *buf, std::optional<SILType> AuxVarType,
1879+
std::optional<SILLocation> DeclLoc,
1880+
const SILDebugScope *DeclScope,
18811881
llvm::ArrayRef<SILDIExprElement> DIExprElements = {}) const {
18821882
if (!Bits.Data.HasValue)
18831883
return std::nullopt;
@@ -2087,11 +2087,18 @@ class AllocStackInst final
20872087
SILLocation getVarLoc() const {
20882088
if (hasAuxDebugLocation())
20892089
return *getTrailingObjects<SILLocation>();
2090-
return getLoc();
2090+
return getLoc().strippedForDebugVariable();
20912091
}
20922092

20932093
/// Return the debug variable information attached to this instruction.
2094-
std::optional<SILDebugVariable> getVarInfo() const {
2094+
///
2095+
/// \param complete If true, always retrieve the complete variable with
2096+
/// location, scope, and element type. If false, only return the
2097+
/// values if they are stored (if they are different from the instruction's
2098+
/// location, scope, and type). This should only be set to false in
2099+
/// SILPrinter. Incomplete var info is unpredictable, as it will sometimes
2100+
/// have location and scope and sometimes not.
2101+
std::optional<SILDebugVariable> getVarInfo(bool complete = true) const {
20952102
// If we used to have debug info attached but our debug info is now
20962103
// invalidated, just bail.
20972104
if (sharedUInt8().AllocStackInst.hasInvalidatedVarInfo) {
@@ -2103,11 +2110,18 @@ class AllocStackInst final
21032110
const SILDebugScope *VarDeclScope = nullptr;
21042111
if (HasAuxDebugVariableType)
21052112
AuxVarType = *getTrailingObjects<SILType>();
2113+
else if (complete)
2114+
AuxVarType = getElementType();
21062115

21072116
if (hasAuxDebugLocation())
21082117
VarDeclLoc = *getTrailingObjects<SILLocation>();
2118+
else if (complete)
2119+
VarDeclLoc = getLoc().strippedForDebugVariable();
2120+
21092121
if (hasAuxDebugScope())
21102122
VarDeclScope = *getTrailingObjects<const SILDebugScope *>();
2123+
else if (complete)
2124+
VarDeclScope = getDebugScope();
21112125

21122126
llvm::ArrayRef<SILDIExprElement> DIExprElements(
21132127
getTrailingObjects<SILDIExprElement>(), NumDIExprOperands);
@@ -2509,8 +2523,13 @@ class AllocBoxInst final
25092523
SILType getAddressType() const;
25102524

25112525
/// Return the debug variable information attached to this instruction.
2512-
std::optional<SILDebugVariable> getVarInfo() const {
2513-
return VarInfo.get(getDecl(), getTrailingObjects<char>());
2526+
std::optional<SILDebugVariable> getVarInfo(bool complete = true) const {
2527+
if (complete)
2528+
return VarInfo.get(getDecl(), getTrailingObjects<char>(),
2529+
getAddressType().getObjectType(),
2530+
getLoc().strippedForDebugVariable(),
2531+
getDebugScope());
2532+
return VarInfo.get(getDecl(), getTrailingObjects<char>(), {}, {}, nullptr);
25142533
};
25152534

25162535
void setUsesMoveableValueDebugInfo() {
@@ -5351,21 +5370,41 @@ class DebugValueInst final
53515370
SILLocation getVarLoc() const {
53525371
if (hasAuxDebugLocation())
53535372
return *getTrailingObjects<SILLocation>();
5354-
return getLoc();
5373+
return getLoc().strippedForDebugVariable();
53555374
}
53565375

53575376
/// Return the debug variable information attached to this instruction.
5358-
std::optional<SILDebugVariable> getVarInfo() const {
5377+
///
5378+
/// \param complete If true, always retrieve the complete variable with
5379+
/// location and scope, and the type if possible. If false, only return the
5380+
/// values if they are stored (if they are different from the instruction's
5381+
/// location, scope, and type). This should only be set to false in
5382+
/// SILPrinter. Incomplete var info is unpredictable, as it will sometimes
5383+
/// have location and scope and sometimes not.
5384+
///
5385+
/// \note The type is not included because it can change during a pass.
5386+
/// Passes must make sure to not lose the type information.
5387+
std::optional<SILDebugVariable> getVarInfo(bool complete = true) const {
53595388
std::optional<SILType> AuxVarType;
53605389
std::optional<SILLocation> VarDeclLoc;
53615390
const SILDebugScope *VarDeclScope = nullptr;
5391+
53625392
if (HasAuxDebugVariableType)
53635393
AuxVarType = *getTrailingObjects<SILType>();
5394+
// TODO: passes break if we set the type here, as the type of the operand
5395+
// can be changed during a pass.
5396+
// else if (complete)
5397+
// AuxVarType = getOperand()->getType().getObjectType();
53645398

53655399
if (hasAuxDebugLocation())
53665400
VarDeclLoc = *getTrailingObjects<SILLocation>();
5401+
else if (complete)
5402+
VarDeclLoc = getLoc().strippedForDebugVariable();
5403+
53675404
if (hasAuxDebugScope())
53685405
VarDeclScope = *getTrailingObjects<const SILDebugScope *>();
5406+
else if (complete)
5407+
VarDeclScope = getDebugScope();
53695408

53705409
llvm::ArrayRef<SILDIExprElement> DIExprElements(
53715410
getTrailingObjects<SILDIExprElement>(), NumDIExprOperands);

‎include/swift/SIL/SILLocation.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -520,8 +520,13 @@ class SILLocation {
520520
};
521521

522522
inline llvm::hash_code hash_value(const SILLocation &R) {
523-
return llvm::hash_combine(R.kindAndFlags.packedKindAndFlags,
524-
*R.storage.filePositionLoc);
523+
if (R.isFilenameAndLocation()) {
524+
return llvm::hash_combine(R.kindAndFlags.packedKindAndFlags,
525+
*R.storage.filePositionLoc);
526+
} else {
527+
return llvm::hash_combine(R.kindAndFlags.packedKindAndFlags,
528+
R.storage.filePositionLoc);
529+
}
525530
}
526531

527532
inline llvm::hash_code hash_value(const SILLocation::FilenameAndLocation &R) {

‎lib/IRGen/IRGenSIL.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -674,7 +674,7 @@ class IRGenSILFunction :
674674
if (!VarInfo)
675675
return StringRef();
676676

677-
StringRef Name = i->getVarInfo()->Name;
677+
StringRef Name = VarInfo->Name;
678678
// The $match variables generated by the type checker are not
679679
// guaranteed to be unique within their scope, but they have
680680
// unique VarDecls.

‎lib/SIL/IR/SILBasicBlock.cpp

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,8 +339,10 @@ transferNodesFromList(llvm::ilist_traits<SILBasicBlock> &SrcTraits,
339339

340340
II.setDebugScope(ScopeCloner.getOrCreateClonedScope(II.getDebugScope()));
341341
// Special handling for SILDebugVariable.
342+
// Fetch incomplete var info to avoid calling setDebugVarScope on
343+
// alloc_box, crashing.
342344
if (auto DVI = DebugVarCarryingInst(&II))
343-
if (auto VarInfo = DVI.getVarInfo())
345+
if (auto VarInfo = DVI.getVarInfo(false))
344346
if (VarInfo->Scope)
345347
DVI.setDebugVarScope(
346348
ScopeCloner.getOrCreateClonedScope(VarInfo->Scope));

‎lib/SIL/IR/SILInstructions.cpp

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -199,26 +199,10 @@ StringRef TailAllocatedDebugVariable::getName(const char *buf) const {
199199

200200
std::optional<SILDebugVariable>
201201
SILDebugVariable::createFromAllocation(const AllocationInst *AI) {
202-
std::optional<SILDebugVariable> VarInfo;
203202
if (const auto *ASI = dyn_cast_or_null<AllocStackInst>(AI))
204-
VarInfo = ASI->getVarInfo();
203+
return ASI->getVarInfo();
205204
// TODO: Support AllocBoxInst
206-
207-
if (!VarInfo)
208-
return {};
209-
210-
// Coalesce the debug loc attached on AI into VarInfo
211-
SILType Type = AI->getType();
212-
SILLocation InstLoc = AI->getLoc();
213-
const SILDebugScope *InstDS = AI->getDebugScope();
214-
if (!VarInfo->Type)
215-
VarInfo->Type = Type;
216-
if (!VarInfo->Loc)
217-
VarInfo->Loc = InstLoc;
218-
if (!VarInfo->Scope)
219-
VarInfo->Scope = InstDS;
220-
221-
return VarInfo;
205+
return {};
222206
}
223207

224208
AllocStackInst::AllocStackInst(
@@ -268,7 +252,7 @@ AllocStackInst *AllocStackInst::create(SILDebugLocation Loc,
268252
UsesMoveableValueDebugInfo_t wasMoved) {
269253
// Don't store the same information twice.
270254
if (Var) {
271-
if (Var->Loc == Loc.getLocation())
255+
if (Var->Loc == Loc.getLocation().strippedForDebugVariable())
272256
Var->Loc = {};
273257
if (Var->Scope == Loc.getScope())
274258
Var->Scope = nullptr;
@@ -473,7 +457,7 @@ DebugValueInst *DebugValueInst::create(SILDebugLocation DebugLoc,
473457
UsesMoveableValueDebugInfo_t wasMoved,
474458
bool trace) {
475459
// Don't store the same information twice.
476-
if (Var.Loc == DebugLoc.getLocation())
460+
if (Var.Loc == DebugLoc.getLocation().strippedForDebugVariable())
477461
Var.Loc = {};
478462
if (Var.Scope == DebugLoc.getScope())
479463
Var.Scope = nullptr;

‎lib/SIL/IR/SILPrinter.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1446,7 +1446,7 @@ class SILPrinter : public SILInstructionVisitor<SILPrinter> {
14461446
if (AVI->usesMoveableValueDebugInfo() && !AVI->getType().isMoveOnly())
14471447
*this << "[moveable_value_debuginfo] ";
14481448
*this << AVI->getElementType();
1449-
printDebugVar(AVI->getVarInfo(),
1449+
printDebugVar(AVI->getVarInfo(false),
14501450
&AVI->getModule().getASTContext().SourceMgr);
14511451
}
14521452
void visitAllocVectorInst(AllocVectorInst *AVI) {
@@ -1503,7 +1503,7 @@ class SILPrinter : public SILInstructionVisitor<SILPrinter> {
15031503
}
15041504

15051505
*this << ABI->getType();
1506-
printDebugVar(ABI->getVarInfo(),
1506+
printDebugVar(ABI->getVarInfo(false),
15071507
&ABI->getModule().getASTContext().SourceMgr);
15081508
}
15091509

@@ -1907,7 +1907,7 @@ class SILPrinter : public SILInstructionVisitor<SILPrinter> {
19071907
if (DVI->hasTrace())
19081908
*this << "[trace] ";
19091909
*this << getIDAndType(DVI->getOperand());
1910-
printDebugVar(DVI->getVarInfo(),
1910+
printDebugVar(DVI->getVarInfo(false),
19111911
&DVI->getModule().getASTContext().SourceMgr);
19121912
}
19131913

‎lib/SIL/Verifier/SILVerifier.cpp

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1465,39 +1465,34 @@ class SILVerifier : public SILVerifierBase<SILVerifier> {
14651465

14661466
void checkDebugVariable(SILInstruction *inst) {
14671467
std::optional<SILDebugVariable> varInfo;
1468-
if (auto *di = dyn_cast<AllocStackInst>(inst))
1469-
varInfo = di->getVarInfo();
1470-
else if (auto *di = dyn_cast<AllocBoxInst>(inst))
1471-
varInfo = di->getVarInfo();
1472-
else if (auto *di = dyn_cast<DebugValueInst>(inst))
1473-
varInfo = di->getVarInfo();
1468+
if (auto di = DebugVarCarryingInst(inst))
1469+
varInfo = di.getVarInfo();
14741470

14751471
if (!varInfo)
14761472
return;
14771473

14781474
// Retrieve debug variable type
1479-
SILType DebugVarTy;
1480-
if (varInfo->Type)
1481-
DebugVarTy = *varInfo->Type;
1482-
else {
1483-
// Fetch from related SSA value
1484-
switch (inst->getKind()) {
1485-
case SILInstructionKind::AllocStackInst:
1486-
case SILInstructionKind::AllocBoxInst:
1487-
DebugVarTy = inst->getResult(0)->getType();
1488-
break;
1489-
case SILInstructionKind::DebugValueInst:
1490-
DebugVarTy = inst->getOperand(0)->getType();
1491-
if (DebugVarTy.isAddress()) {
1492-
// FIXME: op_deref could be applied to address types only.
1493-
// FIXME: Add this check
1494-
if (varInfo->DIExpr.startsWithDeref())
1495-
DebugVarTy = DebugVarTy.getObjectType();
1496-
}
1497-
break;
1498-
default:
1499-
llvm_unreachable("impossible instruction kind");
1500-
}
1475+
SILType SSAType;
1476+
switch (inst->getKind()) {
1477+
case SILInstructionKind::AllocStackInst:
1478+
case SILInstructionKind::AllocBoxInst:
1479+
// TODO: unwrap box for AllocBox
1480+
SSAType = inst->getResult(0)->getType().getObjectType();
1481+
break;
1482+
case SILInstructionKind::DebugValueInst:
1483+
SSAType = inst->getOperand(0)->getType();
1484+
break;
1485+
default:
1486+
llvm_unreachable("impossible instruction kind");
1487+
}
1488+
1489+
SILType DebugVarTy = varInfo->Type ? *varInfo->Type :
1490+
SSAType.getObjectType();
1491+
if (!varInfo->DIExpr && !isa<SILBoxType>(SSAType.getASTType())) {
1492+
// FIXME: Remove getObjectType() below when we fix create/createAddr
1493+
require(DebugVarTy.removingMoveOnlyWrapper()
1494+
== SSAType.getObjectType().removingMoveOnlyWrapper(),
1495+
"debug type mismatch without a DIExpr");
15011496
}
15021497

15031498
auto *debugScope = inst->getDebugScope();

‎lib/SILOptimizer/Differentiation/Common.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,12 +241,12 @@ void collectMinimalIndicesForFunctionCall(
241241
std::optional<std::pair<SILDebugLocation, SILDebugVariable>>
242242
findDebugLocationAndVariable(SILValue originalValue) {
243243
if (auto *asi = dyn_cast<AllocStackInst>(originalValue))
244-
return swift::transform(asi->getVarInfo(), [&](SILDebugVariable var) {
244+
return swift::transform(asi->getVarInfo(false), [&](SILDebugVariable var) {
245245
return std::make_pair(asi->getDebugLocation(), var);
246246
});
247247
for (auto *use : originalValue->getUses()) {
248248
if (auto *dvi = dyn_cast<DebugValueInst>(use->getUser()))
249-
return swift::transform(dvi->getVarInfo(), [&](SILDebugVariable var) {
249+
return swift::transform(dvi->getVarInfo(false), [&](SILDebugVariable var) {
250250
// We need to drop `op_deref` here as we're transferring debug info
251251
// location from debug_value instruction (which describes how to get value)
252252
// into alloc_stack (which describes the location)

‎lib/SILOptimizer/Differentiation/JVPCloner.cpp

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1000,9 +1000,16 @@ class JVPCloner::Implementation final
10001000
/// Tangent: tan[y] = alloc_stack $T.Tangent
10011001
CLONE_AND_EMIT_TANGENT(AllocStack, asi) {
10021002
auto &diffBuilder = getDifferentialBuilder();
1003+
auto varInfo = asi->getVarInfo();
1004+
if (varInfo) {
1005+
// This is a new variable, it shouldn't keep the old scope, type, etc.
1006+
varInfo->Type = {};
1007+
varInfo->DIExpr = {};
1008+
varInfo->Loc = {};
1009+
varInfo->Scope = nullptr;
1010+
}
10031011
auto *mappedAllocStackInst = diffBuilder.createAllocStack(
1004-
asi->getLoc(), getRemappedTangentType(asi->getElementType()),
1005-
asi->getVarInfo());
1012+
asi->getLoc(), getRemappedTangentType(asi->getElementType()), varInfo);
10061013
setTangentBuffer(asi->getParent(), asi, mappedAllocStackInst);
10071014
}
10081015

‎lib/SILOptimizer/Differentiation/PullbackCloner.cpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -664,6 +664,11 @@ class PullbackCloner::Implementation final
664664
}
665665
adjNameStream << " (scope #" << origBB->getDebugID() << ")";
666666
dv.Name = adjName;
667+
// We have no meaningful debug location, and the type is different.
668+
dv.Scope = nullptr;
669+
dv.Loc = {};
670+
dv.Type = {};
671+
dv.DIExpr = {};
667672
return dv;
668673
}));
669674
return (insertion.first->getSecond() = newBuf);

0 commit comments

Comments
 (0)