-
Notifications
You must be signed in to change notification settings - Fork 15.2k
[clang][DebugInfo] Add symbol for debugger with VTable information. #130255
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
Merged
CarlosAlbertoEnciso
merged 5 commits into
llvm:main
from
CarlosAlbertoEnciso:debugger-vtables
May 28, 2025
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
4bd0c48
[DebugInfo] Add symbol for debugger with VTable information.
CarlosAlbertoEnciso e811ab7
[DebugInfo] Add symbol for debugger with VTable information.
CarlosAlbertoEnciso dc84180
[DebugInfo] Add symbol for debugger with VTable information.
CarlosAlbertoEnciso 8356bb7
[DebugInfo] Add symbol for debugger with VTable information.
CarlosAlbertoEnciso 75357fa
[DebugInfo] Add symbol for debugger with VTable information.
CarlosAlbertoEnciso 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2518,6 +2518,57 @@ StringRef CGDebugInfo::getVTableName(const CXXRecordDecl *RD) { | |
| return internString("_vptr$", RD->getNameAsString()); | ||
| } | ||
|
|
||
| // Emit symbol for the debugger that points to the vtable address for | ||
| // the given class. The symbol is named as '_vtable$'. | ||
| // The debugger does not need to know any details about the contents of the | ||
| // vtable as it can work this out using its knowledge of the ABI and the | ||
| // existing information in the DWARF. The type is assumed to be 'void *'. | ||
| void CGDebugInfo::emitVTableSymbol(llvm::GlobalVariable *VTable, | ||
| const CXXRecordDecl *RD) { | ||
| if (!CGM.getTarget().getCXXABI().isItaniumFamily()) | ||
| return; | ||
|
|
||
| ASTContext &Context = CGM.getContext(); | ||
| SmallString<64> Buffer; | ||
| StringRef SymbolName = "_vtable$"; | ||
| const DeclContext *DC = static_cast<const DeclContext *>(RD); | ||
|
||
| SourceLocation Loc; | ||
| QualType VoidPtr = Context.getPointerType(Context.VoidTy); | ||
|
|
||
| // We deal with two different contexts: | ||
| // - The type for the variable, which is part of the class that has the | ||
| // vtable, is placed in the context of the DICompositeType metadata. | ||
| // - The DIGlobalVariable for the vtable is put in the DICompileUnitScope. | ||
|
|
||
| // The created non-member should be mark as 'artificial'. It will be | ||
| // placed inside the scope of the C++ class/structure. | ||
| llvm::DIScope *DContext = getContextDescriptor(cast<Decl>(DC), TheCU); | ||
| auto *Ctxt = cast<llvm::DICompositeType>(DContext); | ||
| llvm::DIFile *Unit = getOrCreateFile(Loc); | ||
| llvm::DIType *VTy = getOrCreateType(VoidPtr, Unit); | ||
| llvm::DINode::DIFlags Flags = getAccessFlag(AccessSpecifier::AS_private, RD) | | ||
| llvm::DINode::FlagArtificial; | ||
| auto Tag = CGM.getCodeGenOpts().DwarfVersion >= 5 | ||
| ? llvm::dwarf::DW_TAG_variable | ||
| : llvm::dwarf::DW_TAG_member; | ||
| llvm::DIDerivedType *DT = DBuilder.createStaticMemberType( | ||
| Ctxt, SymbolName, Unit, /*LineNumber=*/0, VTy, Flags, | ||
| /*Val=*/nullptr, Tag); | ||
|
|
||
| // Use the same vtable pointer to global alignment for the symbol. | ||
| unsigned PAlign = CGM.getVtableGlobalVarAlignment(); | ||
|
|
||
| // The global variable is in the CU scope, and links back to the type it's | ||
| // "within" via the declaration field. | ||
| llvm::DIGlobalVariableExpression *GVE = | ||
| DBuilder.createGlobalVariableExpression( | ||
| TheCU, SymbolName, VTable->getName(), Unit, /*LineNo=*/0, | ||
| getOrCreateType(VoidPtr, Unit), VTable->hasLocalLinkage(), | ||
| /*isDefined=*/true, nullptr, DT, /*TemplateParameters=*/nullptr, | ||
| PAlign); | ||
| VTable->addDebugInfo(GVE); | ||
| } | ||
|
|
||
| StringRef CGDebugInfo::getDynamicInitializerName(const VarDecl *VD, | ||
| DynamicInitKind StubKind, | ||
| llvm::Function *InitFn) { | ||
|
|
||
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
87 changes: 87 additions & 0 deletions
87
clang/test/CodeGenCXX/vtable-debug-info-inheritance-diamond.cpp
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 |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| // REQUIRES: target={{x86_64.*-linux.*}} | ||
|
|
||
| // Diamond inheritance case: | ||
| // For CBase, CLeft, CRight and CDerived we check: | ||
| // - Generation of their vtables (including attributes). | ||
| // - Generation of their '_vtable$' data members: | ||
| // * Correct scope and attributes | ||
|
|
||
| namespace NSP { | ||
| struct CBase { | ||
| int B = 0; | ||
| virtual char fooBase() { return 'B'; } | ||
| }; | ||
| } | ||
|
|
||
| namespace NSP_1 { | ||
| struct CLeft : NSP::CBase { | ||
| int M1 = 1; | ||
| char fooBase() override { return 'O'; }; | ||
| virtual int fooLeft() { return 1; } | ||
| }; | ||
| } | ||
|
|
||
| namespace NSP_2 { | ||
| struct CRight : NSP::CBase { | ||
| int M2 = 2; | ||
| char fooBase() override { return 'T'; }; | ||
| virtual int fooRight() { return 2; } | ||
| }; | ||
| } | ||
|
|
||
| struct CDerived : NSP_1::CLeft, NSP_2::CRight { | ||
| int D = 3; | ||
| char fooBase() override { return 'D'; }; | ||
| int fooDerived() { return 3; }; | ||
| }; | ||
|
|
||
| int main() { | ||
| NSP::CBase Base; | ||
| NSP_1::CLeft Left; | ||
| NSP_2::CRight Right; | ||
| CDerived Derived; | ||
|
|
||
| return 0; | ||
| } | ||
|
|
||
| // RUN: %clang --target=x86_64-linux -Xclang -disable-O0-optnone -Xclang -disable-llvm-passes -emit-llvm -S -g %s -o - | FileCheck %s | ||
|
|
||
| // CHECK: $_ZTVN3NSP5CBaseE = comdat any | ||
| // CHECK: $_ZTVN5NSP_15CLeftE = comdat any | ||
| // CHECK: $_ZTVN5NSP_26CRightE = comdat any | ||
| // CHECK: $_ZTV8CDerived = comdat any | ||
|
|
||
| // CHECK: @_ZTVN3NSP5CBaseE = linkonce_odr {{dso_local|hidden}} unnamed_addr constant {{.*}}, comdat, align 8, !dbg [[BASE_VTABLE_VAR:![0-9]*]] | ||
| // CHECK: @_ZTVN5NSP_15CLeftE = linkonce_odr {{dso_local|hidden}} unnamed_addr constant {{.*}}, comdat, align 8, !dbg [[LEFT_VTABLE_VAR:![0-9]*]] | ||
| // CHECK: @_ZTVN5NSP_26CRightE = linkonce_odr {{dso_local|hidden}} unnamed_addr constant {{.*}}, comdat, align 8, !dbg [[RIGHT_VTABLE_VAR:![0-9]*]] | ||
| // CHECK: @_ZTV8CDerived = linkonce_odr {{dso_local|hidden}} unnamed_addr constant {{.*}}, comdat, align 8, !dbg [[DERIVED_VTABLE_VAR:![0-9]*]] | ||
|
|
||
| // CHECK: [[BASE_VTABLE_VAR]] = !DIGlobalVariableExpression(var: [[BASE_VTABLE:![0-9]*]], expr: !DIExpression()) | ||
| // CHECK-NEXT: [[BASE_VTABLE]] = distinct !DIGlobalVariable(name: "_vtable$", linkageName: "_ZTVN3NSP5CBaseE" | ||
|
|
||
| // CHECK: [[LEFT_VTABLE_VAR]] = !DIGlobalVariableExpression(var: [[LEFT_VTABLE:![0-9]*]], expr: !DIExpression()) | ||
| // CHECK-NEXT: [[LEFT_VTABLE]] = distinct !DIGlobalVariable(name: "_vtable$", linkageName: "_ZTVN5NSP_15CLeftE" | ||
|
|
||
| // CHECK: [[TYPE:![0-9]*]] = !DIDerivedType(tag: DW_TAG_pointer_type, baseType: null, size: 64) | ||
|
|
||
| // CHECK: !DIDerivedType(tag: DW_TAG_variable, name: "_vtable$", scope: [[LEFT:![0-9]*]], file: {{.*}}, baseType: [[TYPE]], flags: DIFlagPrivate | DIFlagArtificial | DIFlagStaticMember) | ||
|
|
||
| // CHECK: [[LEFT]] = distinct !DICompositeType(tag: DW_TAG_structure_type, name: "CLeft" | ||
|
|
||
| // CHECK: [[BASE:![0-9]*]] = distinct !DICompositeType(tag: DW_TAG_structure_type, name: "CBase" | ||
|
|
||
| // CHECK: [[RIGHT_VTABLE_VAR]] = !DIGlobalVariableExpression(var: [[RIGHT_VTABLE:![0-9]*]], expr: !DIExpression()) | ||
| // CHECK-NEXT: [[RIGHT_VTABLE]] = distinct !DIGlobalVariable(name: "_vtable$", linkageName: "_ZTVN5NSP_26CRightE" | ||
|
|
||
| // CHECK: !DIDerivedType(tag: DW_TAG_variable, name: "_vtable$", scope: [[RIGHT:![0-9]*]], file: {{.*}}, baseType: [[TYPE]], flags: DIFlagPrivate | DIFlagArtificial | DIFlagStaticMember) | ||
|
|
||
| // CHECK: [[RIGHT]] = distinct !DICompositeType(tag: DW_TAG_structure_type, name: "CRight" | ||
|
|
||
| // CHECK: [[DERIVED_VTABLE_VAR]] = !DIGlobalVariableExpression(var: [[DERIVED_VTABLE:![0-9]*]], expr: !DIExpression()) | ||
| // CHECK-NEXT: [[DERIVED_VTABLE]] = distinct !DIGlobalVariable(name: "_vtable$", linkageName: "_ZTV8CDerived" | ||
|
|
||
| // CHECK: !DIDerivedType(tag: DW_TAG_variable, name: "_vtable$", scope: [[DERIVED:![0-9]*]], file: {{.*}}, baseType: [[TYPE]], flags: DIFlagPrivate | DIFlagArtificial | DIFlagStaticMember) | ||
|
|
||
| // CHECK: [[DERIVED]] = distinct !DICompositeType(tag: DW_TAG_structure_type, name: "CDerived" | ||
|
|
||
| // CHECK: !DIDerivedType(tag: DW_TAG_variable, name: "_vtable$", scope: [[BASE]], file: {{.*}}, baseType: [[TYPE]], flags: DIFlagPrivate | DIFlagArtificial | DIFlagStaticMember) |
72 changes: 72 additions & 0 deletions
72
clang/test/CodeGenCXX/vtable-debug-info-inheritance-multiple.cpp
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 |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| // REQUIRES: target={{x86_64.*-linux.*}} | ||
|
|
||
| // Multiple inheritance case: | ||
| // For CBaseOne, CBaseTwo and CDerived we check: | ||
| // - Generation of their vtables (including attributes). | ||
| // - Generation of their '_vtable$' data members: | ||
| // * Correct scope and attributes | ||
|
|
||
| namespace NSP_1 { | ||
| struct CBaseOne { | ||
| int B1 = 1; | ||
| virtual int one() { return 1; } | ||
| virtual int two() { return 2; } | ||
| virtual int three() { return 3; } | ||
| }; | ||
| } | ||
|
|
||
| namespace NSP_2 { | ||
| struct CBaseTwo { | ||
| int B2 = 1; | ||
| virtual int four() { return 4; } | ||
| virtual int five() { return 5; } | ||
| virtual int six() { return 6; } | ||
| }; | ||
| } | ||
|
|
||
| struct CDerived : NSP_1::CBaseOne, NSP_2::CBaseTwo { | ||
| int D = 1; | ||
| int two() override { return 22; }; | ||
| int six() override { return 66; } | ||
| }; | ||
|
|
||
| int main() { | ||
| NSP_1::CBaseOne BaseOne; | ||
| NSP_2::CBaseTwo BaseTwo; | ||
| CDerived Derived; | ||
|
|
||
| return 0; | ||
| } | ||
|
|
||
| // RUN: %clang --target=x86_64-linux -Xclang -disable-O0-optnone -Xclang -disable-llvm-passes -emit-llvm -S -g %s -o - | FileCheck %s | ||
|
|
||
| // CHECK: $_ZTVN5NSP_18CBaseOneE = comdat any | ||
| // CHECK: $_ZTVN5NSP_28CBaseTwoE = comdat any | ||
| // CHECK: $_ZTV8CDerived = comdat any | ||
|
|
||
| // CHECK: @_ZTVN5NSP_18CBaseOneE = linkonce_odr {{dso_local|hidden}} unnamed_addr constant {{.*}}, comdat, align 8, !dbg [[BASE_ONE_VTABLE_VAR:![0-9]*]] | ||
| // CHECK: @_ZTVN5NSP_28CBaseTwoE = linkonce_odr {{dso_local|hidden}} unnamed_addr constant {{.*}}, comdat, align 8, !dbg [[BASE_TWO_VTABLE_VAR:![0-9]*]] | ||
| // CHECK: @_ZTV8CDerived = linkonce_odr {{dso_local|hidden}} unnamed_addr constant {{.*}}, comdat, align 8, !dbg [[DERIVED_VTABLE_VAR:![0-9]*]] | ||
|
|
||
| // CHECK: [[BASE_ONE_VTABLE_VAR]] = !DIGlobalVariableExpression(var: [[BASE_ONE_VTABLE:![0-9]*]], expr: !DIExpression()) | ||
| // CHECK-NEXT: [[BASE_ONE_VTABLE]] = distinct !DIGlobalVariable(name: "_vtable$", linkageName: "_ZTVN5NSP_18CBaseOneE" | ||
|
|
||
| // CHECK: [[BASE_TWO_VTABLE_VAR]] = !DIGlobalVariableExpression(var: [[BASE_TWO_VTABLE:![0-9]*]], expr: !DIExpression()) | ||
| // CHECK-NEXT: [[BASE_TWO_VTABLE]] = distinct !DIGlobalVariable(name: "_vtable$", linkageName: "_ZTVN5NSP_28CBaseTwoE" | ||
|
|
||
| // CHECK: [[TYPE:![0-9]*]] = !DIDerivedType(tag: DW_TAG_pointer_type, baseType: null, size: 64) | ||
|
|
||
| // CHECK: !DIDerivedType(tag: DW_TAG_variable, name: "_vtable$", scope: [[BASE_TWO:![0-9]*]], file: {{.*}}, baseType: [[TYPE]], flags: DIFlagPrivate | DIFlagArtificial | DIFlagStaticMember) | ||
|
|
||
| // check: [[BASE_TWO]] = distinct !DICompositeType(tag: DW_TAG_structure_type, name: "CBaseTwo" | ||
|
|
||
| // CHECK: [[DERIVED_VTABLE_VAR]] = !DIGlobalVariableExpression(var: [[DERIVED_VTABLE:![0-9]*]], expr: !DIExpression()) | ||
| // CHECK: [[DERIVED_VTABLE]] = distinct !DIGlobalVariable(name: "_vtable$", linkageName: "_ZTV8CDerived" | ||
|
|
||
| // CHECK: !DIDerivedType(tag: DW_TAG_variable, name: "_vtable$", scope: [[DERIVED:![0-9]*]], file: {{.*}}, baseType: [[TYPE]], flags: DIFlagPrivate | DIFlagArtificial | DIFlagStaticMember) | ||
|
|
||
| // CHECK: [[DERIVED]] = distinct !DICompositeType(tag: DW_TAG_structure_type, name: "CDerived" | ||
|
|
||
| // CHECK: [[BASE_ONE:![0-9]*]] = distinct !DICompositeType(tag: DW_TAG_structure_type, name: "CBaseOne" | ||
|
|
||
| // CHECK: !DIDerivedType(tag: DW_TAG_variable, name: "_vtable$", scope: [[BASE_ONE]], file: {{.*}}, baseType: [[TYPE]], flags: DIFlagPrivate | DIFlagArtificial | DIFlagStaticMember) |
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.
unused?