Skip to content

Commit e48826e

Browse files
dpaolielloefriedma-quic
authored andcommitted
Emit the correct flags for the PROC CodeView Debug Symbol
The S_LPROC32_ID and S_GPROC32_ID CodeView Debug Symbols have a flags field which LLVM has had the values for (in the ProcSymFlags enum) but has never actually set. These flags are used by Microsoft-internal tooling that leverages debug information to do binary analysis. Modified LLVM to set the correct flags: - ProcSymFlags::HasOptimizedDebugInfo - always set, as this indicates that debug info is present for optimized builds (if debug info is not emitted for optimized builds, then LLVM won't emit a debug symbol at all). - ProcSymFlags::IsNoReturn and ProcSymFlags::IsNoInline - set if the function has the NoReturn or NoInline attributes respectively. - ProcSymFlags::HasFP - set if the function requires a frame pointer (per TargetFrameLowering::hasFP). Differential Revision: https://reviews.llvm.org/D148761
1 parent 1c2b812 commit e48826e

File tree

14 files changed

+146
-15
lines changed

14 files changed

+146
-15
lines changed

llvm/lib/CodeGen/AsmPrinter/CodeViewDebug.cpp

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1160,7 +1160,14 @@ void CodeViewDebug::emitDebugInfoForFunction(const Function *GV,
11601160
OS.AddComment("Function section index");
11611161
OS.emitCOFFSectionIndex(Fn);
11621162
OS.AddComment("Flags");
1163-
OS.emitInt8(0);
1163+
ProcSymFlags ProcFlags = ProcSymFlags::HasOptimizedDebugInfo;
1164+
if (FI.HasFramePointer)
1165+
ProcFlags |= ProcSymFlags::HasFP;
1166+
if (GV->hasFnAttribute(Attribute::NoReturn))
1167+
ProcFlags |= ProcSymFlags::IsNoReturn;
1168+
if (GV->hasFnAttribute(Attribute::NoInline))
1169+
ProcFlags |= ProcSymFlags::IsNoInline;
1170+
OS.emitInt8(static_cast<uint8_t>(ProcFlags));
11641171
// Emit the function display name as a null-terminated string.
11651172
OS.AddComment("Function name");
11661173
// Truncate the name so we won't overflow the record length field.
@@ -1478,6 +1485,7 @@ void CodeViewDebug::beginFunctionImpl(const MachineFunction *MF) {
14781485
CurFn->EncodedLocalFramePtrReg = EncodedFramePtrReg::StackPtr;
14791486
CurFn->EncodedParamFramePtrReg = EncodedFramePtrReg::StackPtr;
14801487
} else {
1488+
CurFn->HasFramePointer = true;
14811489
// If there is an FP, parameters are always relative to it.
14821490
CurFn->EncodedParamFramePtrReg = EncodedFramePtrReg::FramePtr;
14831491
if (CurFn->HasStackRealignment) {

llvm/lib/CodeGen/AsmPrinter/CodeViewDebug.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,8 @@ class LLVM_LIBRARY_VISIBILITY CodeViewDebug : public DebugHandlerBase {
191191
bool HasStackRealignment = false;
192192

193193
bool HaveLineInfo = false;
194+
195+
bool HasFramePointer = false;
194196
};
195197
FunctionInfo *CurFn = nullptr;
196198

llvm/test/DebugInfo/COFF/fpo-realign-alloca.ll

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
; RUN: llc < %s | FileCheck %s
2+
; RUN: llc -mtriple=i686-windows-msvc < %s -filetype=obj | llvm-readobj --codeview - | FileCheck %s --check-prefix=OBJ
23

34
; C source:
45
; void usethings(ptr, ptr p);
@@ -33,6 +34,15 @@
3334
; CHECK: retl
3435
; CHECK: .cv_fpo_endproc
3536

37+
; OBJ-LABEL: FunctionType: realign_and_alloca (0x1002)
38+
; OBJ-NEXT: CodeOffset: _realign_and_alloca+0x0
39+
; OBJ-NEXT: Segment: 0x0
40+
; OBJ-NEXT: Flags [ (0x81)
41+
; OBJ-NEXT: HasFP (0x1)
42+
; OBJ-NEXT: HasOptimizedDebugInfo (0x80)
43+
; OBJ-NEXT: ]
44+
; OBJ-NEXT: DisplayName: realign_and_alloca
45+
; OBJ-NEXT: LinkageName: _realign_and_alloca
3646

3747
; ModuleID = 't.c'
3848
source_filename = "t.c"

llvm/test/DebugInfo/COFF/fpo-realign-vframe.ll

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,10 @@
9595
; OBJ: SubSectionType: Symbols (0xF1)
9696
; OBJ: GlobalProcIdSym {
9797
; OBJ: Kind: S_GPROC32_ID (0x1147)
98+
; OBJ: Flags [ (0x81)
99+
; OBJ: HasFP (0x1)
100+
; OBJ: HasOptimizedDebugInfo (0x80)
101+
; OBJ: ]
98102
; OBJ: DisplayName: realign_with_csrs
99103
; OBJ: LinkageName: _realign_with_csrs
100104
; OBJ: }

llvm/test/DebugInfo/COFF/frameproc-flags.ll

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,22 +63,27 @@
6363
; }
6464

6565
; CHECK-LABEL: S_GPROC32_ID [size = 52] `use_alloca`
66+
; CHECK: type = `0x1002 (use_alloca)`, debug start = 0, debug end = 0, flags = has fp | opt debuginfo
6667
; CHECK: S_FRAMEPROC [size = 32]
6768
; CHECK: local fp reg = VFRAME, param fp reg = EBP
6869
; CHECK: flags = has alloca | secure checks | strict secure checks | opt speed
6970
; CHECK-LABEL: S_GPROC32_ID [size = 52] `call_setjmp`
71+
; CHECK: type = `0x1003 (call_setjmp)`, debug start = 0, debug end = 0, flags = opt debuginfo
7072
; CHECK: S_FRAMEPROC [size = 32]
7173
; CHECK: local fp reg = NONE, param fp reg = NONE
7274
; CHECK: flags = has setjmp | opt speed
7375
; CHECK-LABEL: S_GPROC32_ID [size = 56] `use_inlineasm`
76+
; CHECK: type = `0x1006 (use_inlineasm)`, debug start = 0, debug end = 0, flags = opt debuginfo
7477
; CHECK: S_FRAMEPROC [size = 32]
7578
; CHECK: local fp reg = NONE, param fp reg = NONE
7679
; CHECK: flags = has inline asm | safe buffers | opt speed
7780
; CHECK-LABEL: S_GPROC32_ID [size = 48] `cpp_eh`
81+
; CHECK: type = `0x1007 (cpp_eh)`, debug start = 0, debug end = 0, flags = has fp | opt debuginfo
7882
; CHECK: S_FRAMEPROC [size = 32]
7983
; CHECK: local fp reg = EBP, param fp reg = EBP
8084
; CHECK: flags = has eh | opt speed
8185
; CHECK-LABEL: S_GPROC32_ID [size = 52] `use_inline`
86+
; CHECK: type = `0x100C (use_inline)`, debug start = 0, debug end = 0, flags = opt debuginfo
8287
; CHECK: S_FRAMEPROC [size = 32]
8388
; CHECK: local fp reg = NONE, param fp reg = NONE
8489
; CHECK: flags = safe buffers | opt speed
@@ -87,6 +92,7 @@
8792
; CHECK: local fp reg = NONE, param fp reg = NONE
8893
; CHECK: flags = marked inline | safe buffers | opt speed
8994
; CHECK-LABEL: S_GPROC32_ID [size = 44] `seh`
95+
; CHECK: type = `0x100E (seh)`, debug start = 0, debug end = 0, flags = has fp | opt debuginfo
9096
; CHECK: S_FRAMEPROC [size = 32]
9197
; CHECK: local fp reg = EBP, param fp reg = EBP
9298
; CHECK: flags = has seh | opt speed
@@ -95,10 +101,12 @@
95101
; CHECK: local fp reg = EBP, param fp reg = EBP
96102
; CHECK: flags = safe buffers | opt speed
97103
; CHECK-LABEL: S_GPROC32_ID [size = 52] `use_naked`
104+
; CHECK: type = `0x1010 (use_naked)`, debug start = 0, debug end = 0, flags = noinline | opt debuginfo
98105
; CHECK: S_FRAMEPROC [size = 32]
99106
; CHECK: local fp reg = NONE, param fp reg = NONE
100107
; CHECK: flags = has inline asm | naked | safe buffers | opt speed
101108
; CHECK-LABEL: S_GPROC32_ID [size = 52] `stack_guard`
109+
; CHECK: type = `0x1011 (stack_guard)`, debug start = 0, debug end = 0, flags = opt debuginfo
102110
; CHECK: S_FRAMEPROC [size = 32]
103111
; CHECK: local fp reg = VFRAME, param fp reg = VFRAME
104112
; CHECK: flags = secure checks | strict secure checks | opt speed

llvm/test/DebugInfo/COFF/function-options.ll

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,97 @@
376376
; CHECK: }
377377
; CHECK: ]
378378

379+
; CHECK-LABEL: FunctionType: Func_AClass (0x1008)
380+
; CHECK-NEXT: CodeOffset: ?Func_AClass@@YA?AVAClass@@AEAV1@@Z+0x0
381+
; CHECK-NEXT: Segment: 0x0
382+
; CHECK-NEXT: Flags [ (0xC0)
383+
; CHECK-NEXT: HasOptimizedDebugInfo (0x80)
384+
; CHECK-NEXT: IsNoInline (0x40)
385+
; CHECK-NEXT: ]
386+
; CHECK-NEXT: DisplayName: Func_AClass
387+
; CHECK-NEXT: LinkageName: ?Func_AClass@@YA?AVAClass@@AEAV1@@Z
388+
; CHECK-LABEL: FunctionType: Func_BClass (0x1013)
389+
; CHECK-NEXT: CodeOffset: ?Func_BClass@@YA?AVBClass@@AEAV1@@Z+0x0
390+
; CHECK-NEXT: Segment: 0x0
391+
; CHECK-NEXT: Flags [ (0xC0)
392+
; CHECK-NEXT: HasOptimizedDebugInfo (0x80)
393+
; CHECK-NEXT: IsNoInline (0x40)
394+
; CHECK-NEXT: ]
395+
; CHECK-NEXT: DisplayName: Func_BClass
396+
; CHECK-NEXT: LinkageName: ?Func_BClass@@YA?AVBClass@@AEAV1@@Z
397+
; CHECK-LABEL: FunctionType: Func_C1Class (0x101D)
398+
; CHECK-NEXT: CodeOffset: ?Func_C1Class@@YA?AVC1Class@@AEAV1@@Z+0x0
399+
; CHECK-NEXT: Segment: 0x0
400+
; CHECK-NEXT: Flags [ (0xC0)
401+
; CHECK-NEXT: HasOptimizedDebugInfo (0x80)
402+
; CHECK-NEXT: IsNoInline (0x40)
403+
; CHECK-NEXT: ]
404+
; CHECK-NEXT: DisplayName: Func_C1Class
405+
; CHECK-NEXT: LinkageName: ?Func_C1Class@@YA?AVC1Class@@AEAV1@@Z
406+
; CHECK-LABEL: FunctionType: Func_C2Class (0x1027)
407+
; CHECK-NEXT: CodeOffset: ?Func_C2Class@@YA?AVC2Class@@AEAV1@@Z+0x0
408+
; CHECK-NEXT: Segment: 0x0
409+
; CHECK-NEXT: Flags [ (0xC0)
410+
; CHECK-NEXT: HasOptimizedDebugInfo (0x80)
411+
; CHECK-NEXT: IsNoInline (0x40)
412+
; CHECK-NEXT: ]
413+
; CHECK-NEXT: DisplayName: Func_C2Class
414+
; CHECK-NEXT: LinkageName: ?Func_C2Class@@YA?AVC2Class@@AEAV1@@Z
415+
; CHECK-LABEL: FunctionType: Func_DClass (0x102F)
416+
; CHECK-NEXT: CodeOffset: ?Func_DClass@@YA?AVDClass@@AEAV1@@Z+0x0
417+
; CHECK-NEXT: Segment: 0x0
418+
; CHECK-NEXT: Flags [ (0xC0)
419+
; CHECK-NEXT: HasOptimizedDebugInfo (0x80)
420+
; CHECK-NEXT: IsNoInline (0x40)
421+
; CHECK-NEXT: ]
422+
; CHECK-NEXT: DisplayName: Func_DClass
423+
; CHECK-NEXT: LinkageName: ?Func_DClass@@YA?AVDClass@@AEAV1@@Z
424+
; CHECK-LABEL: FunctionType: Func_FClass (0x103A)
425+
; CHECK-NEXT: CodeOffset: ?Func_FClass@@YA?AVFClass@@AEAV1@@Z+0x0
426+
; CHECK-NEXT: Segment: 0x0
427+
; CHECK-NEXT: Flags [ (0xC0)
428+
; CHECK-NEXT: HasOptimizedDebugInfo (0x80)
429+
; CHECK-NEXT: IsNoInline (0x40)
430+
; CHECK-NEXT: ]
431+
; CHECK-NEXT: DisplayName: Func_FClass
432+
; CHECK-NEXT: LinkageName: ?Func_FClass@@YA?AVFClass@@AEAV1@@Z
433+
; CHECK-LABEL: FunctionType: Func_AStruct (0x1041)
434+
; CHECK-NEXT: CodeOffset: ?Func_AStruct@@YA?AUAStruct@@AEAU1@@Z+0x0
435+
; CHECK-NEXT: Segment: 0x0
436+
; CHECK-NEXT: Flags [ (0xC0)
437+
; CHECK-NEXT: HasOptimizedDebugInfo (0x80)
438+
; CHECK-NEXT: IsNoInline (0x40)
439+
; CHECK-NEXT: ]
440+
; CHECK-NEXT: DisplayName: Func_AStruct
441+
; CHECK-NEXT: LinkageName: ?Func_AStruct@@YA?AUAStruct@@AEAU1@@Z
442+
; CHECK-LABEL: FunctionType: Func_BStruct (0x104B)
443+
; CHECK-NEXT: CodeOffset: ?Func_BStruct@@YA?AUBStruct@@AEAU1@@Z+0x0
444+
; CHECK-NEXT: Segment: 0x0
445+
; CHECK-NEXT: Flags [ (0xC0)
446+
; CHECK-NEXT: HasOptimizedDebugInfo (0x80)
447+
; CHECK-NEXT: IsNoInline (0x40)
448+
; CHECK-NEXT: ]
449+
; CHECK-NEXT: DisplayName: Func_BStruct
450+
; CHECK-NEXT: LinkageName: ?Func_BStruct@@YA?AUBStruct@@AEAU1@@Z
451+
; CHECK-LABEL: FunctionType: Func_AUnion (0x1052)
452+
; CHECK-NEXT: CodeOffset: ?Func_AUnion@@YA?ATAUnion@@AEAT1@@Z+0x0
453+
; CHECK-NEXT: Segment: 0x0
454+
; CHECK-NEXT: Flags [ (0xC0)
455+
; CHECK-NEXT: HasOptimizedDebugInfo (0x80)
456+
; CHECK-NEXT: IsNoInline (0x40)
457+
; CHECK-NEXT: ]
458+
; CHECK-NEXT: DisplayName: Func_AUnion
459+
; CHECK-NEXT: LinkageName: ?Func_AUnion@@YA?ATAUnion@@AEAT1@@Z
460+
; CHECK-LABEL: FunctionType: Func_BUnion (0x105C)
461+
; CHECK-NEXT: CodeOffset: ?Func_BUnion@@YA?ATBUnion@@AEAT1@@Z+0x0
462+
; CHECK-NEXT: Segment: 0x0
463+
; CHECK-NEXT: Flags [ (0xC0)
464+
; CHECK-NEXT: HasOptimizedDebugInfo (0x80)
465+
; CHECK-NEXT: IsNoInline (0x40)
466+
; CHECK-NEXT: ]
467+
; CHECK-NEXT: DisplayName: Func_BUnion
468+
; CHECK-NEXT: LinkageName: ?Func_BUnion@@YA?ATBUnion@@AEAT1@@Z
469+
379470
; ModuleID = 't.cpp'
380471
source_filename = "t.cpp"
381472
target datalayout = "e-m:w-p270:32:32-p271:32:32-p272:64:64-i64:64-f80:128-n8:16:32:64-S128"

llvm/test/DebugInfo/COFF/inlining-header.ll

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@
6868
; OBJ: FunctionType: main (0x1005)
6969
; OBJ: CodeOffset: _main+0x0
7070
; OBJ: Segment: 0x0
71-
; OBJ: Flags [ (0x0)
71+
; OBJ: Flags [ (0x80)
72+
; OBJ: HasOptimizedDebugInfo (0x80)
7273
; OBJ: ]
7374
; OBJ: DisplayName: main
7475
; OBJ: LinkageName: _main

llvm/test/DebugInfo/COFF/inlining.ll

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,8 @@
160160
; OBJ: FunctionType: baz (0x1004)
161161
; OBJ: CodeOffset: ?baz@@YAXXZ+0x0
162162
; OBJ: Segment: 0x0
163-
; OBJ: Flags [ (0x0)
163+
; OBJ: Flags [ (0x80)
164+
; OBJ: HasOptimizedDebugInfo (0x80)
164165
; OBJ: ]
165166
; OBJ: DisplayName: baz
166167
; OBJ: LinkageName: ?baz@@YAXXZ

llvm/test/DebugInfo/COFF/long-name.ll

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
; CHECK: FunctionType: {{A+}} (0x1002)
66
; CHECK: CodeOffset: f+0x0
77
; CHECK: Segment: 0x0
8-
; CHECK: Flags [ (0x0)
8+
; CHECK: Flags [ (0x80)
9+
; CHECK: HasOptimizedDebugInfo (0x80)
910
; CHECK: ]
1011
; CHECK: DisplayName: {{A+$}}
1112
; CHECK: LinkageName: f

llvm/test/DebugInfo/COFF/multifunction.ll

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
; X86-NEXT: .long 4098
7979
; X86-NEXT: .secrel32 _x
8080
; X86-NEXT: .secidx _x
81-
; X86-NEXT: .byte 0
81+
; X86-NEXT: .byte 128
8282
; X86-NEXT: .asciz "x"
8383
; X86-NEXT: .p2align 2
8484
; X86-NEXT: [[PROC_SEGMENT_END]]:
@@ -117,7 +117,7 @@
117117
; X86-NEXT: .long 4099
118118
; X86-NEXT: .secrel32 _y
119119
; X86-NEXT: .secidx _y
120-
; X86-NEXT: .byte 0
120+
; X86-NEXT: .byte 128
121121
; X86-NEXT: .asciz "y"
122122
; X86-NEXT: .p2align 2
123123
; X86-NEXT: [[PROC_SEGMENT_END]]:
@@ -156,7 +156,7 @@
156156
; X86-NEXT: .long 4100
157157
; X86-NEXT: .secrel32 _f
158158
; X86-NEXT: .secidx _f
159-
; X86-NEXT: .byte 0
159+
; X86-NEXT: .byte 128
160160
; X86-NEXT: .asciz "f"
161161
; X86-NEXT: .p2align 2
162162
; X86-NEXT: [[PROC_SEGMENT_END]]:
@@ -390,7 +390,7 @@
390390
; X64-NEXT: .long 4098
391391
; X64-NEXT: .secrel32 x
392392
; X64-NEXT: .secidx x
393-
; X64-NEXT: .byte 0
393+
; X64-NEXT: .byte 128
394394
; X64-NEXT: .asciz "x"
395395
; X64-NEXT: .p2align 2
396396
; X64-NEXT: [[PROC_SEGMENT_END]]:
@@ -428,7 +428,7 @@
428428
; X64-NEXT: .long 4099
429429
; X64-NEXT: .secrel32 y
430430
; X64-NEXT: .secidx y
431-
; X64-NEXT: .byte 0
431+
; X64-NEXT: .byte 128
432432
; X64-NEXT: .asciz "y"
433433
; X64-NEXT: .p2align 2
434434
; X64-NEXT: [[PROC_SEGMENT_END]]:
@@ -466,7 +466,7 @@
466466
; X64-NEXT: .long 4100
467467
; X64-NEXT: .secrel32 f
468468
; X64-NEXT: .secidx f
469-
; X64-NEXT: .byte 0
469+
; X64-NEXT: .byte 128
470470
; X64-NEXT: .asciz "f"
471471
; X64-NEXT: .p2align 2
472472
; X64-NEXT: [[PROC_SEGMENT_END]]:

llvm/test/DebugInfo/COFF/simple.ll

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
; X86-NEXT: .long 4098
5959
; X86-NEXT: .secrel32 _f
6060
; X86-NEXT: .secidx _f
61-
; X86-NEXT: .byte 0
61+
; X86-NEXT: .byte 128
6262
; X86-NEXT: .asciz "f"
6363
; X86-NEXT: .p2align 2
6464
; X86-NEXT: [[PROC_SEGMENT_END]]:
@@ -188,7 +188,7 @@
188188
; X64-NEXT: .long 4098
189189
; X64-NEXT: .secrel32 f
190190
; X64-NEXT: .secidx f
191-
; X64-NEXT: .byte 0
191+
; X64-NEXT: .byte 128
192192
; X64-NEXT: .asciz "f"
193193
; X64-NEXT: .p2align 2
194194
; X64-NEXT: [[PROC_SEGMENT_END]]:

llvm/test/DebugInfo/COFF/types-array.ll

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@
5858
; CHECK: FunctionType: f (0x1002)
5959
; CHECK: CodeOffset: ?f@@YAXXZ+0x0
6060
; CHECK: Segment: 0x0
61-
; CHECK: Flags [ (0x0)
61+
; CHECK: Flags [ (0x81)
62+
; CHECK: HasFP (0x1)
63+
; CHECK: HasOptimizedDebugInfo (0x80)
6264
; CHECK: ]
6365
; CHECK: DisplayName: f
6466
; CHECK: LinkageName: ?f@@YAXXZ

llvm/test/DebugInfo/COFF/types-basic.ll

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,8 @@
221221
; CHECK: FunctionType: f (0x1002)
222222
; CHECK: CodeOffset: ?f@@YAXMN_J@Z+0x0
223223
; CHECK: Segment: 0x0
224-
; CHECK: Flags [ (0x0)
224+
; CHECK: Flags [ (0x80)
225+
; CHECK: HasOptimizedDebugInfo (0x80)
225226
; CHECK: ]
226227
; CHECK: DisplayName: f
227228
; CHECK: LinkageName: ?f@@YAXMN_J@Z

llvm/test/MC/AArch64/coff-debug.ll

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,9 @@ attributes #0 = { noinline nounwind optnone "correctly-rounded-divide-sqrt-fp-ma
9595
; CHECK: FunctionType: main (0x1002)
9696
; CHECK: CodeOffset: main+0x0
9797
; CHECK: Segment: 0x0
98-
; CHECK: Flags [ (0x0)
98+
; CHECK: Flags [ (0xC0)
99+
; CHECK: HasOptimizedDebugInfo (0x80)
100+
; CHECK: IsNoInline (0x40)
99101
; CHECK: ]
100102
; CHECK: DisplayName: main
101103
; CHECK: LinkageName: main

0 commit comments

Comments
 (0)