-
Notifications
You must be signed in to change notification settings - Fork 13.5k
Generate DW_AT_RUST_short_backtrace
attributes for DISubprogram
nodes
#123683
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
jyn514
wants to merge
1
commit into
llvm:main
Choose a base branch
from
jyn514:short-backtraces-upstream
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5630,9 +5630,9 @@ bool LLParser::parseDICompileUnit(MDNode *&Result, bool IsDistinct) { | |
/// isDefinition: true, scopeLine: 8, containingType: !3, | ||
/// virtuality: DW_VIRTUALTIY_pure_virtual, | ||
/// virtualIndex: 10, thisAdjustment: 4, flags: 11, | ||
/// spFlags: 10, isOptimized: false, templateParams: !4, | ||
/// declaration: !5, retainedNodes: !6, thrownTypes: !7, | ||
/// annotations: !8) | ||
/// spFlags: 10, shortBacktrace: 0, isOptimized: false, | ||
/// templateParams: !4, declaration: !5, retainedNodes: !6, | ||
/// thrownTypes: !7, annotations: !8) | ||
bool LLParser::parseDISubprogram(MDNode *&Result, bool IsDistinct) { | ||
auto Loc = Lex.getLoc(); | ||
#define VISIT_MD_FIELDS(OPTIONAL, REQUIRED) \ | ||
|
@@ -5658,10 +5658,30 @@ bool LLParser::parseDISubprogram(MDNode *&Result, bool IsDistinct) { | |
OPTIONAL(retainedNodes, MDField, ); \ | ||
OPTIONAL(thrownTypes, MDField, ); \ | ||
OPTIONAL(annotations, MDField, ); \ | ||
OPTIONAL(shortBacktrace, MDSignedField, (-1, -1, 2)); \ | ||
OPTIONAL(targetFuncName, MDStringField, ); | ||
PARSE_MD_FIELDS(); | ||
#undef VISIT_MD_FIELDS | ||
|
||
std::optional<ShortBacktraceAttr> parsedShortBacktrace; | ||
switch (shortBacktrace.Val) { | ||
case -1: | ||
parsedShortBacktrace = std::nullopt; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This requires a debug assertion. |
||
break; | ||
case 0: | ||
parsedShortBacktrace = ShortBacktraceAttr::SkipFrame; | ||
break; | ||
case 1: | ||
parsedShortBacktrace = ShortBacktraceAttr::StartShortBacktrace; | ||
break; | ||
case 2: | ||
parsedShortBacktrace = ShortBacktraceAttr::EndShortBacktrace; | ||
break; | ||
default: | ||
llvm_unreachable( | ||
"shortBacktrace debuginfo attribute must be in range [-1, 2]"); | ||
} | ||
|
||
// An explicit spFlags field takes precedence over individual fields in | ||
// older IR versions. | ||
DISubprogram::DISPFlags SPFlags = | ||
|
@@ -5676,9 +5696,9 @@ bool LLParser::parseDISubprogram(MDNode *&Result, bool IsDistinct) { | |
DISubprogram, | ||
(Context, scope.Val, name.Val, linkageName.Val, file.Val, line.Val, | ||
type.Val, scopeLine.Val, containingType.Val, virtualIndex.Val, | ||
thisAdjustment.Val, flags.Val, SPFlags, unit.Val, templateParams.Val, | ||
declaration.Val, retainedNodes.Val, thrownTypes.Val, annotations.Val, | ||
targetFuncName.Val)); | ||
thisAdjustment.Val, flags.Val, SPFlags, parsedShortBacktrace, unit.Val, | ||
templateParams.Val, declaration.Val, retainedNodes.Val, thrownTypes.Val, | ||
annotations.Val, targetFuncName.Val)); | ||
return false; | ||
} | ||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you add some documents? I'm not clear why
StartShortBacktrace
andEndShortBacktrace
cannot be replaced bySkipFrame
? IIUC, we can addSkipFrame
annotation to all frames/functions that betweenStartShortBacktrace
andEndShortBacktrace
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a few cases where this cannot be replaced by annotating individual frames. Consider these three:
StartShortBacktrace
, and it has no correspondingEndShortBacktrace
pair.Rust currently handles this with a
define void @__rust_start_short_backtrace() noinline
function, and it works ok. But you mentioned that you want this to be extensible to other languages and tools. And in that case they probably don't want to hardcode__rust
in the name, nor be forced to use frames instead of debuginfo.I am happy to document the three cases above inline in this enum.