1; RUN: opt < %s -passes='default<O0>' -S | FileCheck %s
2
3; Define a function 'f' that resembles the Clang frontend's output for the
4; following C++ coroutine:
5;
6;   void foo() {
7;     int i = 0;
8;     ++i;
9;     int x = {};
10;     print(i);  // Prints '1'
11;
12;     co_await suspend_always();
13;
14;     int j = 0;
15;     x[0] = 1;
16;     x[1] = 2;
17;     ++i;
18;     print(i);  // Prints '2'
19;     ++j;
20;     print(j);  // Prints '1'
21;     print(x);  // Print '1'
22;   }
23;
24; The CHECKs verify that dbg.declare intrinsics are created for the coroutine
25; funclet 'f.resume', and that they reference the address of the variables on
26; the coroutine frame. The debug locations for the original function 'f' are
27; static (!11 and !13), whereas the coroutine funclet will have its own new
28; ones with identical line and column numbers.
29;
30; CHECK-LABEL: define void @f() {{.*}} {
31; CHECK:       entry:
32; CHECK:         %j = alloca i32, align 4
33; CHECK:         call void @llvm.dbg.declare(metadata i32* %j, metadata ![[JVAR:[0-9]+]], metadata !DIExpression()), !dbg ![[JDBGLOC:[0-9]+]]
34; CHECK:         %[[MEMORY:.*]] = call i8* @new
35; CHECK:         call void @llvm.dbg.declare(metadata i8* %[[MEMORY]], metadata ![[XVAR:[0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 32)), !dbg ![[IDBGLOC:[0-9]+]]
36; CHECK:         call void @llvm.dbg.declare(metadata i8* %[[MEMORY]], metadata ![[IVAR:[0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 20)), !dbg ![[IDBGLOC]]
37; CHECK:       await.ready:
38;
39; CHECK-LABEL: define internal fastcc void @f.resume({{.*}}) {{.*}} {
40; CHECK:       entry.resume:
41; CHECK-NEXT:    %[[DBG_PTR:.*]] = alloca %f.Frame*
42; CHECK-NEXT:    call void @llvm.dbg.declare(metadata %f.Frame** %[[DBG_PTR]], metadata ![[XVAR_RESUME:[0-9]+]],   metadata !DIExpression(DW_OP_deref, DW_OP_plus_uconst, 32)), !dbg
43; CHECK-NEXT:    call void @llvm.dbg.declare(metadata %f.Frame** %[[DBG_PTR]], metadata ![[IVAR_RESUME:[0-9]+]], metadata !DIExpression(DW_OP_deref, DW_OP_plus_uconst, 20)), !dbg ![[IDBGLOC_RESUME:[0-9]+]]
44; CHECK-NEXT:    store %f.Frame* {{.*}}, %f.Frame** %[[DBG_PTR]]
45; CHECK:         %[[J:.*]] = alloca i32, align 4
46; CHECK-NEXT:    call void @llvm.dbg.declare(metadata i32* %[[J]], metadata ![[JVAR_RESUME:[0-9]+]], metadata !DIExpression()), !dbg ![[JDBGLOC_RESUME:[0-9]+]]
47; CHECK:       init.ready:
48; CHECK:       await.ready:
49;
50; CHECK-DAG: ![[IVAR]] = !DILocalVariable(name: "i"
51; CHECK-DAG: ![[SCOPE:[0-9]+]] = distinct !DILexicalBlock(scope: !6, file: !1, line: 23, column: 12)
52; CHECK-DAG: ![[IDBGLOC]] = !DILocation(line: 24, column: 7, scope: ![[SCOPE]])
53; CHECK-DAG: ![[XVAR]] = !DILocalVariable(name: "x"
54; CHECK-DAG: ![[JVAR]] = !DILocalVariable(name: "j"
55; CHECK-DAG: ![[JDBGLOC]] = !DILocation(line: 32, column: 7, scope: ![[SCOPE]])
56
57; CHECK-DAG: ![[XVAR_RESUME]] = !DILocalVariable(name: "x"
58; CHECK-DAG: ![[IDBGLOC_RESUME]] = !DILocation(line: 24, column: 7, scope: ![[RESUME_SCOPE:[0-9]+]])
59; CHECK-DAG: ![[RESUME_SCOPE]] = distinct !DILexicalBlock(scope: !23, file: !1, line: 23, column: 12)
60; CHECK-DAG: ![[IVAR_RESUME]] = !DILocalVariable(name: "i"
61; CHECK-DAG: ![[JVAR_RESUME]] = !DILocalVariable(name: "j"
62; CHECK-DAG: ![[JDBGLOC_RESUME]] = !DILocation(line: 32, column: 7, scope: ![[RESUME_SCOPE]])
63define void @f() presplitcoroutine !dbg !8 {
64entry:
65  %__promise = alloca i8, align 8
66  %i = alloca i32, align 4
67  %j = alloca i32, align 4
68  %x = alloca [10 x i32], align 16
69  %id = call token @llvm.coro.id(i32 16, i8* %__promise, i8* null, i8* null)
70  %alloc = call i1 @llvm.coro.alloc(token %id)
71  br i1 %alloc, label %coro.alloc, label %coro.init
72
73coro.alloc:                                       ; preds = %entry
74  %size = call i64 @llvm.coro.size.i64()
75  %memory = call i8* @new(i64 %size)
76  br label %coro.init
77
78coro.init:                                        ; preds = %coro.alloc, %entry
79  %phi.entry.alloc = phi i8* [ null, %entry ], [ %memory, %coro.alloc ]
80  %begin = call i8* @llvm.coro.begin(token %id, i8* %phi.entry.alloc)
81  %ready = call i1 @await_ready()
82  br i1 %ready, label %init.ready, label %init.suspend
83
84init.suspend:                                     ; preds = %coro.init
85  %save = call token @llvm.coro.save(i8* null)
86  call void @await_suspend()
87  %suspend = call i8 @llvm.coro.suspend(token %save, i1 false)
88  switch i8 %suspend, label %coro.ret [
89    i8 0, label %init.ready
90    i8 1, label %init.cleanup
91  ]
92
93init.cleanup:                                     ; preds = %init.suspend
94  br label %cleanup
95
96init.ready:                                       ; preds = %init.suspend, %coro.init
97  call void @await_resume()
98  call void @llvm.dbg.declare(metadata i32* %i, metadata !6, metadata !DIExpression()), !dbg !11
99  store i32 0, i32* %i, align 4
100  %i.init.ready.load = load i32, i32* %i, align 4
101  %i.init.ready.inc = add nsw i32 %i.init.ready.load, 1
102  store i32 %i.init.ready.inc, i32* %i, align 4
103  call void @llvm.dbg.declare(metadata [10 x i32]* %x, metadata !14, metadata !DIExpression()), !dbg !11
104  %memset = bitcast [10 x i32]* %x to i8*, !dbg !11
105  call void @llvm.memset.p0i8.i64(i8* align 16 %memset, i8 0, i64 40, i1 false), !dbg !11
106  %i.init.ready.reload = load i32, i32* %i, align 4
107  call void @print(i32 %i.init.ready.reload)
108  %ready.again = call zeroext i1 @await_ready()
109  br i1 %ready.again, label %await.ready, label %await.suspend
110
111await.suspend:                                    ; preds = %init.ready
112  %save.again = call token @llvm.coro.save(i8* null)
113  %from.address = call i8* @from_address(i8* %begin)
114  call void @await_suspend()
115  %suspend.again = call i8 @llvm.coro.suspend(token %save.again, i1 false)
116  switch i8 %suspend.again, label %coro.ret [
117    i8 0, label %await.ready
118    i8 1, label %await.cleanup
119  ]
120
121await.cleanup:                                    ; preds = %await.suspend
122  br label %cleanup
123
124await.ready:                                      ; preds = %await.suspend, %init.ready
125  call void @await_resume()
126  call void @llvm.dbg.declare(metadata i32* %j, metadata !12, metadata !DIExpression()), !dbg !13
127  store i32 0, i32* %j, align 4
128  %arrayidx0 = getelementptr inbounds [10 x i32], [10 x i32]* %x, i64 0, i64 0, !dbg !18
129  store i32 1, i32* %arrayidx0, align 16, !dbg !19
130  %arrayidx1 = getelementptr inbounds [10 x i32], [10 x i32]* %x, i64 0, i64 1, !dbg !20
131  store i32 2, i32* %arrayidx1, align 4, !dbg !21
132  %i.await.ready.load = load i32, i32* %i, align 4
133  %i.await.ready.inc = add nsw i32 %i.await.ready.load, 1
134  store i32 %i.await.ready.inc, i32* %i, align 4
135  %j.await.ready.load = load i32, i32* %j, align 4
136  %j.await.ready.inc = add nsw i32 %j.await.ready.load, 1
137  store i32 %j.await.ready.inc, i32* %j, align 4
138  %i.await.ready.reload = load i32, i32* %i, align 4
139  call void @print(i32 %i.await.ready.reload)
140  %j.await.ready.reload = load i32, i32* %j, align 4
141  call void @print(i32 %j.await.ready.reload)
142  call void @return_void()
143  br label %coro.final
144
145coro.final:                                       ; preds = %await.ready
146  call void @final_suspend()
147  %coro.final.await_ready = call i1 @await_ready()
148  br i1 %coro.final.await_ready, label %final.ready, label %final.suspend
149
150final.suspend:                                    ; preds = %coro.final
151  %final.suspend.coro.save = call token @llvm.coro.save(i8* null)
152  %final.suspend.from_address = call i8* @from_address(i8* %begin)
153  call void @await_suspend()
154  %final.suspend.coro.suspend = call i8 @llvm.coro.suspend(token %final.suspend.coro.save, i1 true)
155  switch i8 %final.suspend.coro.suspend, label %coro.ret [
156    i8 0, label %final.ready
157    i8 1, label %final.cleanup
158  ]
159
160final.cleanup:                                    ; preds = %final.suspend
161  br label %cleanup
162
163final.ready:                                      ; preds = %final.suspend, %coro.final
164  call void @await_resume()
165  br label %cleanup
166
167cleanup:                                          ; preds = %final.ready, %final.cleanup, %await.cleanup, %init.cleanup
168  %cleanup.dest.slot.0 = phi i32 [ 0, %final.ready ], [ 2, %final.cleanup ], [ 2, %await.cleanup ], [ 2, %init.cleanup ]
169  %free.memory = call i8* @llvm.coro.free(token %id, i8* %begin)
170  %free = icmp ne i8* %free.memory, null
171  br i1 %free, label %coro.free, label %after.coro.free
172
173coro.free:                                        ; preds = %cleanup
174  call void @delete(i8* %free.memory)
175  br label %after.coro.free
176
177after.coro.free:                                  ; preds = %coro.free, %cleanup
178  switch i32 %cleanup.dest.slot.0, label %unreachable [
179    i32 0, label %cleanup.cont
180    i32 2, label %coro.ret
181  ]
182
183cleanup.cont:                                     ; preds = %after.coro.free
184  br label %coro.ret
185
186coro.ret:                                         ; preds = %cleanup.cont, %after.coro.free, %final.suspend, %await.suspend, %init.suspend
187  %end = call i1 @llvm.coro.end(i8* null, i1 false)
188  ret void
189
190unreachable:                                      ; preds = %after.coro.free
191  unreachable
192}
193
194declare void @llvm.dbg.declare(metadata, metadata, metadata)
195declare token @llvm.coro.id(i32, i8* readnone, i8* nocapture readonly, i8*)
196declare i1 @llvm.coro.alloc(token)
197declare i64 @llvm.coro.size.i64()
198declare token @llvm.coro.save(i8*)
199declare i8* @llvm.coro.begin(token, i8* writeonly)
200declare i8 @llvm.coro.suspend(token, i1)
201declare i8* @llvm.coro.free(token, i8* nocapture readonly)
202declare i1 @llvm.coro.end(i8*, i1)
203
204declare i8* @new(i64)
205declare void @delete(i8*)
206declare i1 @await_ready()
207declare void @await_suspend()
208declare void @await_resume()
209declare void @print(i32)
210declare i8* @from_address(i8*)
211declare void @return_void()
212declare void @final_suspend()
213
214declare void @llvm.memset.p0i8.i64(i8* nocapture writeonly, i8, i64, i1 immarg)
215
216!llvm.dbg.cu = !{!0}
217!llvm.linker.options = !{}
218!llvm.module.flags = !{!3, !4}
219!llvm.ident = !{!5}
220
221!0 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus_14, file: !1, producer: "clang version 11.0.0", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, enums: !2, retainedTypes: !2, splitDebugInlining: false, nameTableKind: None)
222!1 = !DIFile(filename: "repro.cpp", directory: ".")
223!2 = !{}
224!3 = !{i32 7, !"Dwarf Version", i32 4}
225!4 = !{i32 2, !"Debug Info Version", i32 3}
226!5 = !{!"clang version 11.0.0"}
227!6 = !DILocalVariable(name: "i", scope: !7, file: !1, line: 24, type: !10)
228!7 = distinct !DILexicalBlock(scope: !8, file: !1, line: 23, column: 12)
229!8 = distinct !DISubprogram(name: "foo", linkageName: "_Z3foov", scope: !1, file: !1, line: 23, type: !9, scopeLine: 23, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !0, retainedNodes: !2)
230!9 = !DISubroutineType(types: !2)
231!10 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
232!11 = !DILocation(line: 24, column: 7, scope: !7)
233!12 = !DILocalVariable(name: "j", scope: !7, file: !1, line: 32, type: !10)
234!13 = !DILocation(line: 32, column: 7, scope: !7)
235!14 = !DILocalVariable(name: "x", scope: !22, file: !1, line: 34, type: !15)
236!15 = !DICompositeType(tag: DW_TAG_array_type, baseType: !10, size: 320, elements: !16)
237!16 = !{!17}
238!17 = !DISubrange(count: 10)
239!18 = !DILocation(line: 42, column: 3, scope: !7)
240!19 = !DILocation(line: 42, column: 8, scope: !7)
241!20 = !DILocation(line: 43, column: 3, scope: !7)
242!21 = !DILocation(line: 43, column: 8, scope: !7)
243!22 = distinct !DILexicalBlock(scope: !8, file: !1, line: 23, column: 12)
244