[CodeGen] Add Machine Function Splitter and DebugInfo composite testcase

[TaoPan]

Summary

The Machine Function Splitter splits out cold basic block, it changes
dawrf range. Add Machine Function Splitter and DebugInfo composite
testcase to ensure debug information after the splitting work correctly.

[TaoPan]

I referred llvm/test/CodeGen/X86/machine-function-splitter.ll and llvm/test/DebugInfo/X86/basic-block-sections_1.ll to add this machine function splitter and DebugInfo composite testcase.
Could you please have a review?

[snehasish]

Can you elaborate on the motivation behind this test?

As the behaviour exists today, -split-machine-functions and -basic-block-sections are exclusive options and the former takes precedence. With D96392 we are planning on switching the precedence but they still remain exclusive. Thus in this test, the RUN invocations on line 2,3 and 4 are using -split-machine-functions. Furthermore, the underlying mechanism driving both options are the same so testing the generation of debug information together is redundant. For more information take a look at the discussion in D90989.

[TaoPan]

Remove redundant -basic-block-sections test as it's exclusive with -split-machine-functions.

[TaoPan]

git rebase

[TaoPan]

In D96393#2553156, @snehasish wrote:

Can you elaborate on the motivation behind this test?

As the behaviour exists today, -split-machine-functions and -basic-block-sections are exclusive options and the former takes precedence. With D96392 we are planning on switching the precedence but they still remain exclusive. Thus in this test, the RUN invocations on line 2,3 and 4 are using -split-machine-functions. Furthermore, the underlying mechanism driving both options are the same so testing the generation of debug information together is redundant. For more information take a look at the discussion in D90989.

Thanks for your review comment! I got the current exclusive relation, and -basic-block-section will take precedence over -split-machine-functions after D96392 is done.
I added motivation to Summary, removed redundant test related to -basic-block-sections.
Could you please have a look?

[TaoPan]

I'll take 1 week national holiday, 2/11~2/17, I'll handle the review comment soon after the holiday, thanks in advance!

[snehasish]

We have discussed this approach and decided against adding a separate debug info test for function splitting (see the discussion in D90717). The underlying functionality is tested in test/DebugInfo/X86/basic-block-sections_1.ll. Based on the direction in your previous patch (D95209) - emitting dwarf based debug info for PE/COFF executables has limited utility as far as I can tell. While tooling under cygwin will be able to use this information most Windows native debuggers may not support reading from dwarf (eg. libdwarf started supporting PE mid-2019: https://www.prevanders.net/dwarf.html#libdwarf-20190104). For Windows, we need to look into the CodeView format (see the slides from https://llvm.org/devmtg/2016-11/Slides/Kleckner-CodeViewInLLVM.pdf).

[TaoPan]

Thanks for reminding the discussion of not adding a separate debug info test for function splitting! I’ll merge the test into test/DebugInfo/X86/basic-block-sections_1.ll.
Thanks for sharing information of dwarf, PE/COFF, CodeView, cygwin and Windows native debuggers! I think

add dwarf based test for Linux and Windows Cygwin

is independent on

(refer to your shared information and existing test of test/DebugInfo/PDB/Native/ to) add CodeView based test for Windows native debuggers, it’s depends on #D95209, it’s better be added in #D95209.

[snehasish]

In D96393#2570438, @TaoPan wrote:

Thanks for reminding the discussion of not adding a separate debug info test for function splitting! I’ll merge the test into test/DebugInfo/X86/basic-block-sections_1.ll.

Please do not merge this test. Apologies if I was unclear earlier - there is no need for this test since the functionality is already tested in test/DebugInfo/X86/basic-block-sections_1.ll
The machine function splitter (MFS) pass uses basic block sections so if the dwarf debug info generated by basic block sections is correct then MFS is also correct.

Thanks for sharing information of dwarf, PE/COFF, CodeView, cygwin and Windows native debuggers! I think

add dwarf based test for Linux and Windows Cygwin

is independent on

(refer to your shared information and existing test of test/DebugInfo/PDB/Native/ to) add CodeView based test for Windows native debuggers, it’s depends on #D95209, it’s better be added in #D95209.

Sounds good!

[TaoPan]

In D96393#2570472, @snehasish wrote:

Please do not merge this test. Apologies if I was unclear earlier - there is no need for this test since the functionality is already tested in test/DebugInfo/X86/basic-block-sections_1.ll
The machine function splitter (MFS) pass uses basic block sections so if the dwarf debug info generated by basic block sections is correct then MFS is also correct.

Thanks! I got it's MFS dependent basic block sections ensure dwarf debug info correct.
As for Windows COFF, is it also not MFS but MFS dependent basic block sections may be incorrect for Windows native debuggers, so need to extend basic block sections debug info test at first?

[snehasish]

As for Windows COFF, is it also not MFS but MFS dependent basic block sections may be incorrect for Windows native debuggers, so need to extend basic block sections debug info test at first?

We have not added support for Windows debug info format so we need to add that before extending the test. :)
Lets discuss the approach offline before spending time on how to add this support.

[TaoPan]

In D96393#2570622, @snehasish wrote:

We have not added support for Windows debug info format so we need to add that before extending the test. :)
Lets discuss the approach offline before spending time on how to add this support.

Thanks! I got the status of Windows debug info format. Let's discuss offline.

llvm/test/DebugInfo/X86/machine-function-splitter.ll

+; RUN: llc -O2 %s -split-machine-functions -mtriple=x86_64 -filetype=obj -o %t && llvm-dwarfdump -debug-info -v %t | FileCheck --check-prefix=MFS-SECTIONS %s
+; RUN: llc -O2 %s --basic-block-sections=all --unique-basic-block-section-names -split-machine-functions -mtriple=x86_64 -filetype=obj -o %t && llvm-dwarfdump -debug-info -v %t | FileCheck --check-prefix=MFS-SECTIONS %s
+; RUN: llc -O2 %s --basic-block-sections=all --unique-basic-block-section-names -mtriple=x86_64 -split-machine-functions -filetype=obj -split-dwarf-file=%t.dwo -o %t && llvm-dwarfdump -debug-info -v %t | FileCheck --check-prefix=MFS-SECTIONS %s
+; RUN: llc -O2 %s --basic-block-sections=all -split-machine-functions -mtriple=x86_64 -o - | FileCheck --check-prefix=MFS-SECTIONS-ASM %s
+; RUN: llc -O2 %s -split-machine-functions -mtriple=x86_64 -filetype=obj -o %t && llvm-dwarfdump  -debug-line %t | FileCheck --check-prefix=MFS-SECTIONS-LINE-TABLE %s
+
+; From:
+; 1  int foo(int a) {
+; 2    if (a > 20)
+; 3      return bar();
+; 4    else
+; 5      return baz();
+; 6  }
+
+; MFS-SECTIONS: DW_AT_low_pc [DW_FORM_addr] (0x0000000000000000)
+; MFS-SECTIONS: DW_AT_ranges [DW_FORM_sec_offset]
+; MFS-SECTIONS: [{{.*}}) ".text.split._Z3fooi"
+; MFS-SECTIONS: [{{.*}}) ".text.hot."
+; MFS-SECTIONS-ASM: _Z3fooi:
+; MFS-SECTIONS-ASM: .Ltmp{{[0-9]+}}:
+; MFS-SECTIONS-ASM-NEXT: .loc 1 2 9 prologue_end
+; MFS-SECTIONS-ASM: .Ltmp{{[0-9]+}}:
+; MFS-SECTIONS-ASM-NEXT: .loc 1 2 7 is_stmt 0
+; MFS-SECTIONS-ASM: .Ltmp{{[0-9]+}}:
+; MFS-SECTIONS-ASM: .Ltmp{{[0-9]+}}:
+; MFS-SECTIONS-ASM-NEXT: .loc 1 6 1 is_stmt 1
+; MFS-SECTIONS-ASM: .Ltmp{{[0-9]+}}:
+; MFS-SECTIONS-ASM-NEXT: .cfi_endproc
+; MFS-SECTIONS-ASM-NEXT: .section .text.split._Z3fooi,"ax",@progbits
+; MFS-SECTIONS-ASM: _Z3fooi.cold:
+; MFS-SECTIONS-ASM: .LBB_END0_{{[0-9]+}}:
+; MFS-SECTIONS-ASM: .size _Z3fooi.cold, .LBB_END0_{{[0-9]+}}-_Z3fooi.cold
+; MFS-SECTIONS-ASM: .Lfunc_end0:
+; MFS-SECTIONS-ASM: .Ldebug_ranges0:
+; MFS-SECTIONS-ASM-NEXT:  .quad _Z3fooi.cold
+; MFS-SECTIONS-ASM-NEXT:  .quad .LBB_END0_{{[0-9]+}}
+; MFS-SECTIONS-ASM-NEXT:  .quad .Lfunc_begin0
+; MFS-SECTIONS-ASM-NEXT:  .quad .Lfunc_end0
+; MFS-SECTIONS-ASM-NEXT:  .quad 0
+; MFS-SECTIONS-ASM-NEXT:  .quad 0
+; MFS-SECTIONS-LINE-TABLE:      0x0000000000000000 1 0 1 0 0 is_stmt
+; MFS-SECTIONS-LINE-TABLE-NEXT: 0x0000000000000005 2 9 1 0 0 is_stmt prologue_end
+; MFS-SECTIONS-LINE-TABLE-NEXT: 0x0000000000000008 2 7 1 0 0
+; MFS-SECTIONS-LINE-TABLE-NEXT: 0x000000000000000e 0 7 1 0 0
+; MFS-SECTIONS-LINE-TABLE-NEXT: 0x0000000000000016 6 1 1 0 0 is_stmt
+; MFS-SECTIONS-LINE-TABLE-NEXT: 0x000000000000001b 6 1 1 0 0 is_stmt end_sequence
+; MFS-SECTIONS-LINE-TABLE-NEXT: 0x0000000000000000 0 1 1 0 0
+; MFS-SECTIONS-LINE-TABLE-NEXT: 0x000000000000000a 0 1 1 0 0 end_sequence
+
+; Function Attrs: noinline nounwind optnone uwtable
+define dso_local i32 @_Z3fooi(i32 %0) !dbg !7 !prof !34 !section_prefix !35 {
+  %2 = alloca i32, align 4
+  %3 = alloca i32, align 4
+  store i32 %0, i32* %3, align 4
+  call void @llvm.dbg.declare(metadata i32* %3, metadata !11, metadata !DIExpression()), !dbg !12
+  %4 = load i32, i32* %3, align 4, !dbg !13
+  %5 = icmp sgt i32 %4, 20, !dbg !15
+  br i1 %5, label %6, label %8, !dbg !16, !prof !36
+
+6:                                                ; preds = %1
+  %7 = call i32 @bar()
+  store i32 %7, i32* %2, align 4, !dbg !17
+  br label %10, !dbg !17
+
+8:                                                ; preds = %1
+  %9 = call i32 @baz()
+  store i32 %9, i32* %2, align 4, !dbg !18
+  br label %10, !dbg !18
+
+10:                                                ; preds = %8, %6
+  %11 = load i32, i32* %2, align 4, !dbg !19
+  ret i32 %11, !dbg !19
+}
+
+; Function Attrs: nounwind readnone speculatable willreturn
+declare void @llvm.dbg.declare(metadata, metadata, metadata)
+declare i32 @bar()
+declare i32 @baz()
+
+!llvm.dbg.cu = !{!0}
+!llvm.module.flags = !{!3, !4, !20}
+
+!0 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus, file: !1, producer: "clang version 10.0.0 ([e-mail]:google/llvm-propeller.git f9421ebf4b3d8b64678bf6c49d1607fdce3f50c5)", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, enums: !2, nameTableKind: None)
+!1 = !DIFile(filename: "debuginfo.cc", directory: "/")
+!2 = !{}
+!3 = !{i32 2, !"Dwarf Version", i32 4}
+!4 = !{i32 2, !"Debug Info Version", i32 3}
+!7 = distinct !DISubprogram(name: "foo", linkageName: "_Z3fooi", scope: !1, file: !1, line: 1, type: !8, scopeLine: 1, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !0, retainedNodes: !2)
+!8 = !DISubroutineType(types: !9)
+!9 = !{!10, !10}
+!10 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
+!11 = !DILocalVariable(name: "a", arg: 1, scope: !7, file: !1, line: 1, type: !10)
+!12 = !DILocation(line: 1, column: 13, scope: !7)
+!13 = !DILocation(line: 2, column: 7, scope: !14)
+!14 = distinct !DILexicalBlock(scope: !7, file: !1, line: 2, column: 7)
+!15 = !DILocation(line: 2, column: 9, scope: !14)
+!16 = !DILocation(line: 2, column: 7, scope: !7)
+!17 = !DILocation(line: 3, column: 5, scope: !14)
+!18 = !DILocation(line: 5, column: 5, scope: !14)
+!19 = !DILocation(line: 6, column: 1, scope: !7)
+!20 = !{i32 1, !"ProfileSummary", !21}
+!21 = !{!22, !23, !24, !25, !26, !27, !28, !29}
+!22 = !{!"ProfileFormat", !"InstrProf"}
+!23 = !{!"TotalCount", i64 10000}
+!24 = !{!"MaxCount", i64 10}
+!25 = !{!"MaxInternalCount", i64 1}
+!26 = !{!"MaxFunctionCount", i64 1000}
+!27 = !{!"NumCounts", i64 3}
+!28 = !{!"NumFunctions", i64 5}
+!29 = !{!"DetailedSummary", !30}
+!30 = !{!31, !32, !33}
+!31 = !{i32 10000, i64 100, i32 1}
+!32 = !{i32 999900, i64 100, i32 1}
+!33 = !{i32 999999, i64 1, i32 2}
+!34 = !{!"function_entry_count", i64 7000}
+!35 = !{!"function_section_prefix", !"hot"}
+!36 = !{!"branch_weights", i32 6999, i32 1}