[cherry-pick][swift/release/5.9] [clang][DebugInfo] Emit DW_AT_type of preferred name if available #6612
Conversation
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
|
@swift-ci test |
Michael137
force-pushed
the
feature/preferred-name-to-swift-5.9
branch
from
18299a8 to
bbb7995
Compare
With this patch, whenever we emit a `DW_AT_type` for some declaration
and the type is a template class with a `clang::PreferredNameAttr`, we
will emit the typedef that the attribute refers to instead. I.e.,
```
0x123 DW_TAG_variable
DW_AT_name "var"
DW_AT_type (0x123 "basic_string<char>")
0x124 DW_TAG_structure_type
DW_AT_name "basic_string<char>"
```
...becomes
```
0x123 DW_TAG_variable
DW_AT_name "var"
DW_AT_type (0x124 "std::string")
0x124 DW_TAG_structure_type
DW_AT_name "basic_string<char>"
0x125 DW_TAG_typedef
DW_AT_name "std::string"
DW_AT_type (0x124 "basic_string<char>")
```
We do this by returning the preferred name typedef `DIType` when
we create a structure definition. In some cases, e.g., with `-gmodules`,
we don't complete the structure definition immediately but do so later
via `completeClassData`, which overwrites the `TypeCache`. In such cases
we don't actually want to rewrite the cache with the preferred name. We
handle this by returning both the definition and the preferred typedef
from `CreateTypeDefinition` and let the callee decide what to do with
it.
Essentially we set up the types as:
```
TypeCache[Record] => DICompositeType
ReplaceMap[Record] => DIDerivedType(baseType: DICompositeType)
```
For now we keep this behind LLDB tuning.
**Testing**
- Added clang unit-test
- `check-llvm`, `check-clang` pass
- Confirmed that this change correctly repoints
`basic_string` references in some of my test programs.
- Will add follow-up LLDB API tests
Differential Revision: https://reviews.llvm.org/D145803
(cherry picked from commit 19cc390)
Describes changes made in D145803. Differential Revision: https://reviews.llvm.org/D147695 (cherry picked from commit 80fe7358f6f4811d2619cf4c09fb246b6b6c764b)
Add some tests to make sure we're formatting structures with preferred names correctly. Differential Revision: https://reviews.llvm.org/D145832 (cherry picked from commit 1eaf3b7)
Michael137
force-pushed
the
feature/preferred-name-to-swift-5.9
branch
from
bbb7995 to
3e95d3e
Compare
|
@swift-ci test |
1 similar comment
|
@swift-ci test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
With this patch, whenever we emit a
DW_AT_typefor some declarationand the type is a template class with a
clang::PreferredNameAttr, wewill emit the typedef that the attribute refers to instead. I.e.,
...becomes
We do this by returning the preferred name typedef
DITypewhenwe create a structure definition. In some cases, e.g., with
-gmodules,we don't complete the structure definition immediately but do so later
via
completeClassData, which overwrites theTypeCache. In such caseswe don't actually want to rewrite the cache with the preferred name. We
handle this by returning both the definition and the preferred typedef
from
CreateTypeDefinitionand let the callee decide what to do withit.
Essentially we set up the types as:
For now we keep this behind LLDB tuning.
Testing
check-llvm,check-clangpassbasic_stringreferences in some of my test programs.Differential Revision: https://reviews.llvm.org/D145803