This is an archive of the discontinued LLVM Phabricator instance.

Differential D147747

Add test to verify behavior of .cfi_sections .debug_frame intrinsic
ClosedPublic

Authored by rastogishubham on Apr 6 2023, 3:30 PM.

Details

Reviewers
aprantl
friss
t.p.northover
Commits
rGfe8eab468eee: Add tests to verify behavior of .cfi_sections .debug_frame intrinsic.
Summary

I noticed that there was some lacking test coverage for checking when the .cfi_sections .debug_frame intrinsic is emitted. I added this test to address this.

On x86_64 we can see that even with -fno-exceptions there is no .cfi_sections .debug_frame intrinsic emitted because there is an unwind table attribute.

On Arm64 we can see that with -fno-exceptions, there is no unwind table attribute, so the .cfi_sections .debug_frame intrinsic is emitted correctly.

Alternatively, with -fexceptions, both Arm64 and x86_64 emit an unwind table and therefore do not emit a .cfi_sections .debug_frame intrinsic

All this work was done in addition to https://reviews.llvm.org/D139663 patch.

Diff Detail

Unit TestsFailed

TimeTest
120 msx64 debian > LLVM.Examples/OrcV2Examples::lljit-with-thinlto-summaries.test
40 msx64 debian > LLVM.Examples/OrcV2Examples::orcv2-cbindings-add-object-file.test
40 msx64 debian > LLVM.Examples/OrcV2Examples::orcv2-cbindings-basic-usage.test
40 msx64 debian > LLVM.Examples/OrcV2Examples::orcv2-cbindings-lazy.test
30 msx64 debian > LLVM.Examples/OrcV2Examples::orcv2-cbindings-removable-code.test

Event Timeline

rastogishubham created this revision.Apr 6 2023, 3:30 PM
Herald added a project: Restricted Project. · View Herald TranscriptApr 6 2023, 3:30 PM
Herald added subscribers: pengfei, kristof.beyls. · View Herald Transcript
rastogishubham requested review of this revision.Apr 6 2023, 3:30 PM
rastogishubham added reviewers: aprantl, friss, t.p.northover.
Harbormaster completed remote builds in B224123: Diff 511548.Apr 6 2023, 4:08 PM
aprantl requested changes to this revision.Apr 10 2023, 3:38 PM

Clang tests should not depend on a target. The right thing to do here is to generate LLVM IR from the source code and then check in LLVM IR somewhere into llvm/test and compile that with llc. IF there is something in clang that needs to be tested then you can add a second test that does source -> IR -> FileCheck in Clang.

This revision now requires changes to proceed.Apr 10 2023, 3:38 PM
rastogishubham updated this revision to Diff 514735.Apr 18 2023, 1:59 PM

Addressed review feedback by making some tests llc tests instead of the clang driver tests

Herald added a project: Restricted Project. · View Herald TranscriptApr 18 2023, 1:59 PM
Herald added a subscriber: llvm-commits. · View Herald Transcript
Harbormaster completed remote builds in B226450: Diff 514735.Apr 18 2023, 5:01 PM
Herald added a subscriber: ormris. · View Herald TranscriptApr 18 2023, 5:01 PM
aprantl added inline comments.Apr 19 2023, 3:12 PM
llvm/test/DebugInfo/AArch64/test-fexceptions-debug-frame.ll
1

Can you add a comment explaining what is being tested here?

2

Can you also add one positive CHECK as a sanity check? Otherwise this test passes even if the llc binary outputs nothing.

16

it's considered good practice to strip all the "string" attributes that arent' strictly needed from tests, so they are easier to maintain when these attributes change in the future.

llvm/test/DebugInfo/AArch64/test-fno-exceptions-debug-frame.ll
16

strip if possible

llvm/test/DebugInfo/X86/test-fexceptions-debug-frame.ll
16

ditto

llvm/test/DebugInfo/X86/test-fno-exceptions-debug-frame.ll
2

ditto

rastogishubham updated this revision to Diff 517209.Apr 26 2023, 9:38 AM
rastogishubham marked 6 inline comments as done.

Addressed review comments, mainly:

  1. Added a description to explain what each test does
  1. Added a CHECK in tests that just had a CHECK-NOT
  1. Renamed test-cfi.cpp to test-uwtable.cpp
rastogishubham updated this revision to Diff 517230.Apr 26 2023, 10:26 AM
Harbormaster completed remote builds in B228331: Diff 517230.Apr 26 2023, 11:43 AM
aprantl accepted this revision.Apr 26 2023, 1:18 PM
This revision is now accepted and ready to land.Apr 26 2023, 1:18 PM
Closed by commit rGfe8eab468eee: Add tests to verify behavior of .cfi_sections .debug_frame intrinsic. (authored by rastogishubham). · Explain WhyApr 26 2023, 4:16 PM
This revision was automatically updated to reflect the committed changes.
rastogishubham added a commit: rGfe8eab468eee: Add tests to verify behavior of .cfi_sections .debug_frame intrinsic..
Herald added a project: Restricted Project. · View Herald TranscriptApr 26 2023, 4:16 PM
Herald added a subscriber: cfe-commits. · View Herald Transcript

Revision Contents

PathSize
clang/
test/
Driver/
19 lines
llvm/
test/
DebugInfo/
AArch64/
37 lines
36 lines
X86/
37 lines
37 lines

Diff 514735

clang/test/Driver/test-cfi.cpp

  • This file was added.
// RUN: %clang -g -fexceptions --target=x86_64-apple-darwin %s -S -emit-llvm -o - | FileCheck %s --check-prefix=X86_64_UWTABLE_EXCEPTIONS
// X86_64_UWTABLE_EXCEPTIONS: attributes #0 = { {{.*}} uwtable
// X86_64_UWTABLE_EXCEPTIONS: !{{[0-9]+}} = !{i32 7, !"uwtable", i32 2}
// RUN: %clang -g -fno-exceptions --target=x86_64-apple-darwin %s -S -emit-llvm -o - | FileCheck %s --check-prefix=X86_64_UWTABLE
// X86_64_UWTABLE: attributes #0 = { {{.*}} uwtable
// X86_64_UWTABLE: !{{[0-9]+}} = !{i32 7, !"uwtable", i32 2}
// RUN: %clang -g -fexceptions --target=arm64-apple-darwin %s -S -emit-llvm -o - | FileCheck %s --check-prefix=ARM64_UWTABLE_EXCEPTIONS
// ARM64_UWTABLE_EXCEPTIONS: attributes #0 = { {{.*}} uwtable
// ARM64_UWTABLE_EXCEPTIONS: !{{[0-9]+}} = !{i32 7, !"uwtable", i32 1}
// RUN: %clang -g -fno-exceptions --target=arm64-apple-darwin %s -S -emit-llvm -o - | FileCheck %s --check-prefix=ARM64_UWTABLE
// ARM64_UWTABLE-NOT: attributes #0 = { {{.*}} uwtable
// ARM64_UWTABLE-NOT: !{{[0-9]+}} = !{i32 7, !"uwtable", i32 2}
int main() {
return 1;
}

llvm/test/DebugInfo/AArch64/test-fexceptions-debug-frame.ll

  • This file was added.
; RUN: llc --filetype=asm %s -o - | FileCheck %s
aprantlUnsubmitted
Done
ReplyInline Actions

Can you add a comment explaining what is being tested here?

aprantl: Can you add a comment explaining what is being tested here?
; CHECK-NOT: .cfi_sections .debug_frame
aprantlUnsubmitted
Done
ReplyInline Actions

Can you also add one positive CHECK as a sanity check? Otherwise this test passes even if the llc binary outputs nothing.

aprantl: Can you also add one positive CHECK as a sanity check? Otherwise this test passes even if the…
; ModuleID = 'test.cpp'
source_filename = "test.cpp"
target datalayout = "e-m:o-i64:64-i128:128-n32:64-S128"
target triple = "arm64-apple-macosx13.0.0"
; Function Attrs: noinline norecurse nounwind optnone ssp uwtable(sync)
define i32 @main() #0 !dbg !10 {
%1 = alloca i32, align 4
store i32 0, ptr %1, align 4
ret i32 1, !dbg !15
}
attributes #0 = { noinline norecurse nounwind optnone ssp uwtable(sync) "frame-pointer"="non-leaf" "min-legal-vector-width"="0" "no-builtin-calloc" "no-builtin-stpcpy" "no-trapping-math"="true" "probe-stack"="__chkstk_darwin" "stack-protector-buffer-size"="8" "target-cpu"="apple-m1" "target-features"="+aes,+amx,+amx2,+crc,+crypto,+dotprod,+fp-armv8,+fp16fml,+fullfp16,+lse,+neon,+ras,+rcpc,+rdm,+sha2,+sha3,+sm4,+v8.1a,+v8.2a,+v8.3a,+v8.4a,+v8.5a,+v8a,+zcm,+zcz" }
aprantlUnsubmitted
Done
ReplyInline Actions

it's considered good practice to strip all the "string" attributes that arent' strictly needed from tests, so they are easier to maintain when these attributes change in the future.

aprantl: it's considered good practice to strip all the "string" attributes that arent' strictly needed…
!llvm.module.flags = !{!0, !1, !2, !3, !4, !5, !6}
!llvm.dbg.cu = !{!7}
!llvm.ident = !{!9}
!0 = !{i32 2, !"SDK Version", [2 x i32] [i32 14, i32 0]}
!1 = !{i32 7, !"Dwarf Version", i32 4}
!2 = !{i32 2, !"Debug Info Version", i32 3}
!3 = !{i32 1, !"wchar_size", i32 4}
!4 = !{i32 8, !"PIC Level", i32 2}
!5 = !{i32 7, !"uwtable", i32 1}
!6 = !{i32 7, !"frame-pointer", i32 1}
!7 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus, file: !8, producer: "Apple clang version 15.0.0 (clang-1500.0.16.8) [+internal-os]", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None, sysroot: "/Users/shubham/apple-internal/Xcode-Rainbow/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX14.0.Internal.sdk", sdk: "MacOSX14.0.Internal.sdk")
!8 = !DIFile(filename: "test.cpp", directory: "/Users/shubham/Development/tedk")
!9 = !{!"Apple clang version 15.0.0 (clang-1500.0.16.8) [+internal-os]"}
!10 = distinct !DISubprogram(name: "main", scope: !8, file: !8, line: 1, type: !11, scopeLine: 1, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !7, retainedNodes: !14)
!11 = !DISubroutineType(types: !12)
!12 = !{!13}
!13 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
!14 = !{}
!15 = !DILocation(line: 2, column: 5, scope: !10)

llvm/test/DebugInfo/AArch64/test-fno-exceptions-debug-frame.ll

  • This file was added.
; RUN: llc --filetype=asm %s -o - | FileCheck %s
; CHECK: .cfi_sections .debug_frame
; ModuleID = 'test.cpp'
source_filename = "test.cpp"
target datalayout = "e-m:o-i64:64-i128:128-n32:64-S128"
target triple = "arm64-apple-macosx13.0.0"
; Function Attrs: noinline norecurse nounwind optnone ssp
define i32 @main() #0 !dbg !9 {
%1 = alloca i32, align 4
store i32 0, ptr %1, align 4
ret i32 1, !dbg !14
}
attributes #0 = { noinline norecurse nounwind optnone ssp "frame-pointer"="non-leaf" "min-legal-vector-width"="0" "no-builtin-calloc" "no-builtin-stpcpy" "no-trapping-math"="true" "probe-stack"="__chkstk_darwin" "stack-protector-buffer-size"="8" "target-cpu"="apple-m1" "target-features"="+aes,+amx,+amx2,+crc,+crypto,+dotprod,+fp-armv8,+fp16fml,+fullfp16,+lse,+neon,+ras,+rcpc,+rdm,+sha2,+sha3,+sm4,+v8.1a,+v8.2a,+v8.3a,+v8.4a,+v8.5a,+v8a,+zcm,+zcz" }
aprantlUnsubmitted
Done
ReplyInline Actions

strip if possible

aprantl: strip if possible
!llvm.module.flags = !{!0, !1, !2, !3, !4, !5}
!llvm.dbg.cu = !{!6}
!llvm.ident = !{!8}
!0 = !{i32 2, !"SDK Version", [2 x i32] [i32 14, i32 0]}
!1 = !{i32 7, !"Dwarf Version", i32 4}
!2 = !{i32 2, !"Debug Info Version", i32 3}
!3 = !{i32 1, !"wchar_size", i32 4}
!4 = !{i32 8, !"PIC Level", i32 2}
!5 = !{i32 7, !"frame-pointer", i32 1}
!6 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus, file: !7, producer: "Apple clang version 15.0.0 (clang-1500.0.16.8) [+internal-os]", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None, sysroot: "/Users/shubham/apple-internal/Xcode-Rainbow/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX14.0.Internal.sdk", sdk: "MacOSX14.0.Internal.sdk")
!7 = !DIFile(filename: "test.cpp", directory: "/Users/shubham/Development/tedk")
!8 = !{!"Apple clang version 15.0.0 (clang-1500.0.16.8) [+internal-os]"}
!9 = distinct !DISubprogram(name: "main", scope: !7, file: !7, line: 1, type: !10, scopeLine: 1, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !6, retainedNodes: !13)
!10 = !DISubroutineType(types: !11)
!11 = !{!12}
!12 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
!13 = !{}
!14 = !DILocation(line: 2, column: 5, scope: !9)

llvm/test/DebugInfo/X86/test-fexceptions-debug-frame.ll

  • This file was added.
; RUN: llc --filetype=asm %s -o - | FileCheck %s
; CHECK-NOT: .cfi_sections .debug_frame
; ModuleID = 'test.cpp'
source_filename = "test.cpp"
target datalayout = "e-m:o-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128"
target triple = "x86_64-apple-macosx13.0.0"
; Function Attrs: noinline norecurse nounwind optnone ssp uwtable
define i32 @main() #0 !dbg !10 {
%1 = alloca i32, align 4
store i32 0, ptr %1, align 4
ret i32 1, !dbg !15
}
attributes #0 = { noinline norecurse nounwind optnone ssp uwtable "frame-pointer"="all" "min-legal-vector-width"="0" "no-builtin-calloc" "no-builtin-stpcpy" "no-trapping-math"="true" "probe-stack"="__chkstk_darwin" "stack-protector-buffer-size"="8" "target-cpu"="penryn" "target-features"="+cx16,+cx8,+fxsr,+mmx,+sahf,+sse,+sse2,+sse3,+sse4.1,+ssse3,+x87" "tune-cpu"="generic" }
aprantlUnsubmitted
Done
ReplyInline Actions

ditto

aprantl: ditto
!llvm.module.flags = !{!0, !1, !2, !3, !4, !5, !6}
!llvm.dbg.cu = !{!7}
!llvm.ident = !{!9}
!0 = !{i32 2, !"SDK Version", [2 x i32] [i32 14, i32 0]}
!1 = !{i32 7, !"Dwarf Version", i32 4}
!2 = !{i32 2, !"Debug Info Version", i32 3}
!3 = !{i32 1, !"wchar_size", i32 4}
!4 = !{i32 8, !"PIC Level", i32 2}
!5 = !{i32 7, !"uwtable", i32 2}
!6 = !{i32 7, !"frame-pointer", i32 2}
!7 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus, file: !8, producer: "Apple clang version 15.0.0 (clang-1500.0.16.8) [+internal-os]", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None, sysroot: "/Users/shubham/apple-internal/Xcode-Rainbow/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX14.0.Internal.sdk", sdk: "MacOSX14.0.Internal.sdk")
!8 = !DIFile(filename: "test.cpp", directory: "/Users/shubham/Development/tedk")
!9 = !{!"Apple clang version 15.0.0 (clang-1500.0.16.8) [+internal-os]"}
!10 = distinct !DISubprogram(name: "main", scope: !8, file: !8, line: 1, type: !11, scopeLine: 1, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !7, retainedNodes: !14)
!11 = !DISubroutineType(types: !12)
!12 = !{!13}
!13 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
!14 = !{}
!15 = !DILocation(line: 2, column: 5, scope: !10)

llvm/test/DebugInfo/X86/test-fno-exceptions-debug-frame.ll

  • This file was added.
; RUN: llc --filetype=asm %s -o - | FileCheck %s
; CHECK-NOT: .cfi_sections .debug_frame
aprantlUnsubmitted
Done
ReplyInline Actions

ditto

aprantl: ditto
; ModuleID = 'test.cpp'
source_filename = "test.cpp"
target datalayout = "e-m:o-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128"
target triple = "x86_64-apple-macosx13.0.0"
; Function Attrs: noinline norecurse nounwind optnone ssp uwtable
define i32 @main() #0 !dbg !10 {
%1 = alloca i32, align 4
store i32 0, ptr %1, align 4
ret i32 1, !dbg !15
}
attributes #0 = { noinline norecurse nounwind optnone ssp uwtable "frame-pointer"="all" "min-legal-vector-width"="0" "no-builtin-calloc" "no-builtin-stpcpy" "no-trapping-math"="true" "probe-stack"="__chkstk_darwin" "stack-protector-buffer-size"="8" "target-cpu"="penryn" "target-features"="+cx16,+cx8,+fxsr,+mmx,+sahf,+sse,+sse2,+sse3,+sse4.1,+ssse3,+x87" "tune-cpu"="generic" }
!llvm.module.flags = !{!0, !1, !2, !3, !4, !5, !6}
!llvm.dbg.cu = !{!7}
!llvm.ident = !{!9}
!0 = !{i32 2, !"SDK Version", [2 x i32] [i32 14, i32 0]}
!1 = !{i32 7, !"Dwarf Version", i32 4}
!2 = !{i32 2, !"Debug Info Version", i32 3}
!3 = !{i32 1, !"wchar_size", i32 4}
!4 = !{i32 8, !"PIC Level", i32 2}
!5 = !{i32 7, !"uwtable", i32 2}
!6 = !{i32 7, !"frame-pointer", i32 2}
!7 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus, file: !8, producer: "Apple clang version 15.0.0 (clang-1500.0.16.8) [+internal-os]", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, splitDebugInlining: false, nameTableKind: None, sysroot: "/Users/shubham/apple-internal/Xcode-Rainbow/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX14.0.Internal.sdk", sdk: "MacOSX14.0.Internal.sdk")
!8 = !DIFile(filename: "test.cpp", directory: "/Users/shubham/Development/tedk")
!9 = !{!"Apple clang version 15.0.0 (clang-1500.0.16.8) [+internal-os]"}
!10 = distinct !DISubprogram(name: "main", scope: !8, file: !8, line: 1, type: !11, scopeLine: 1, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !7, retainedNodes: !14)
!11 = !DISubroutineType(types: !12)
!12 = !{!13}
!13 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
!14 = !{}
!15 = !DILocation(line: 2, column: 5, scope: !10)