llvm/test/Transforms/Coroutines/coro-debug-frame-variable.ll

   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 ptr %j, metadata ![[JVAR:[0-9]+]], metadata !DIExpression()), !dbg ![[JDBGLOC:[0-9]+]]
  34 ; CHECK:         %[[MEMORY:.*]] = call ptr @new
  35 ; CHECK:         call void @llvm.dbg.declare(metadata ptr %[[MEMORY]], metadata ![[XVAR:[0-9]+]], metadata !DIExpression(DW_OP_plus_uconst, 32)), !dbg ![[IDBGLOC:[0-9]+]]
  36 ; CHECK:         call void @llvm.dbg.declare(metadata ptr %[[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 ptr
  42 ; CHECK-NEXT:    call void @llvm.dbg.declare(metadata ptr %[[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 ptr %[[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 ptr {{.*}}, ptr %[[DBG_PTR]]
  45 ; CHECK:         %[[J:.*]] = alloca i32, align 4
  46 ; CHECK-NEXT:    call void @llvm.dbg.declare(metadata ptr %[[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: !22, 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]])
  63 define void @f() presplitcoroutine !dbg !8 {
  64 entry:
  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, ptr %__promise, ptr null, ptr null)
  70   %alloc = call i1 @llvm.coro.alloc(token %id)
  71   br i1 %alloc, label %coro.alloc, label %coro.init
  72
  73 coro.alloc:                                       ; preds = %entry
  74   %size = call i64 @llvm.coro.size.i64()
  75   %memory = call ptr @new(i64 %size)
  76   br label %coro.init
  77
  78 coro.init:                                        ; preds = %coro.alloc, %entry
  79   %phi.entry.alloc = phi ptr [ null, %entry ], [ %memory, %coro.alloc ]
  80   %begin = call ptr @llvm.coro.begin(token %id, ptr %phi.entry.alloc)
  81   %ready = call i1 @await_ready()
  82   br i1 %ready, label %init.ready, label %init.suspend
  83
  84 init.suspend:                                     ; preds = %coro.init
  85   %save = call token @llvm.coro.save(ptr 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
  93 init.cleanup:                                     ; preds = %init.suspend
  94   br label %cleanup
  95
  96 init.ready:                                       ; preds = %init.suspend, %coro.init
  97   call void @await_resume()
  98   call void @llvm.dbg.declare(metadata ptr %i, metadata !6, metadata !DIExpression()), !dbg !11
  99   store i32 0, ptr %i, align 4
 100   %i.init.ready.load = load i32, ptr %i, align 4
 101   %i.init.ready.inc = add nsw i32 %i.init.ready.load, 1
 102   store i32 %i.init.ready.inc, ptr %i, align 4
 103   call void @llvm.dbg.declare(metadata ptr %x, metadata !14, metadata !DIExpression()), !dbg !11
 104   call void @llvm.memset.p0.i64(ptr align 16 %x, i8 0, i64 40, i1 false), !dbg !11
 105   %i.init.ready.reload = load i32, ptr %i, align 4
 106   call void @print(i32 %i.init.ready.reload)
 107   %ready.again = call zeroext i1 @await_ready()
 108   br i1 %ready.again, label %await.ready, label %await.suspend
 109
 110 await.suspend:                                    ; preds = %init.ready
 111   %save.again = call token @llvm.coro.save(ptr null)
 112   %from.address = call ptr @from_address(ptr %begin)
 113   call void @await_suspend()
 114   %suspend.again = call i8 @llvm.coro.suspend(token %save.again, i1 false)
 115   switch i8 %suspend.again, label %coro.ret [
 116     i8 0, label %await.ready
 117     i8 1, label %await.cleanup
 118   ]
 119
 120 await.cleanup:                                    ; preds = %await.suspend
 121   br label %cleanup
 122
 123 await.ready:                                      ; preds = %await.suspend, %init.ready
 124   call void @await_resume()
 125   call void @llvm.dbg.declare(metadata ptr %j, metadata !12, metadata !DIExpression()), !dbg !13
 126   store i32 0, ptr %j, align 4
 127   store i32 1, ptr %x, align 16, !dbg !19
 128   %arrayidx1 = getelementptr inbounds [10 x i32], ptr %x, i64 0, i64 1, !dbg !20
 129   store i32 2, ptr %arrayidx1, align 4, !dbg !21
 130   %i.await.ready.load = load i32, ptr %i, align 4
 131   %i.await.ready.inc = add nsw i32 %i.await.ready.load, 1
 132   store i32 %i.await.ready.inc, ptr %i, align 4
 133   %j.await.ready.load = load i32, ptr %j, align 4
 134   %j.await.ready.inc = add nsw i32 %j.await.ready.load, 1
 135   store i32 %j.await.ready.inc, ptr %j, align 4
 136   %i.await.ready.reload = load i32, ptr %i, align 4
 137   call void @print(i32 %i.await.ready.reload)
 138   %j.await.ready.reload = load i32, ptr %j, align 4
 139   call void @print(i32 %j.await.ready.reload)
 140   call void @return_void()
 141   br label %coro.final
 142
 143 coro.final:                                       ; preds = %await.ready
 144   call void @final_suspend()
 145   %coro.final.await_ready = call i1 @await_ready()
 146   br i1 %coro.final.await_ready, label %final.ready, label %final.suspend
 147
 148 final.suspend:                                    ; preds = %coro.final
 149   %final.suspend.coro.save = call token @llvm.coro.save(ptr null)
 150   %final.suspend.from_address = call ptr @from_address(ptr %begin)
 151   call void @await_suspend()
 152   %final.suspend.coro.suspend = call i8 @llvm.coro.suspend(token %final.suspend.coro.save, i1 true)
 153   switch i8 %final.suspend.coro.suspend, label %coro.ret [
 154     i8 0, label %final.ready
 155     i8 1, label %final.cleanup
 156   ]
 157
 158 final.cleanup:                                    ; preds = %final.suspend
 159   br label %cleanup
 160
 161 final.ready:                                      ; preds = %final.suspend, %coro.final
 162   call void @await_resume()
 163   br label %cleanup
 164
 165 cleanup:                                          ; preds = %final.ready, %final.cleanup, %await.cleanup, %init.cleanup
 166   %cleanup.dest.slot.0 = phi i32 [ 0, %final.ready ], [ 2, %final.cleanup ], [ 2, %await.cleanup ], [ 2, %init.cleanup ]
 167   %free.memory = call ptr @llvm.coro.free(token %id, ptr %begin)
 168   %free = icmp ne ptr %free.memory, null
 169   br i1 %free, label %coro.free, label %after.coro.free
 170
 171 coro.free:                                        ; preds = %cleanup
 172   call void @delete(ptr %free.memory)
 173   br label %after.coro.free
 174
 175 after.coro.free:                                  ; preds = %coro.free, %cleanup
 176   switch i32 %cleanup.dest.slot.0, label %unreachable [
 177     i32 0, label %cleanup.cont
 178     i32 2, label %coro.ret
 179   ]
 180
 181 cleanup.cont:                                     ; preds = %after.coro.free
 182   br label %coro.ret
 183
 184 coro.ret:                                         ; preds = %cleanup.cont, %after.coro.free, %final.suspend, %await.suspend, %init.suspend
 185   %end = call i1 @llvm.coro.end(ptr null, i1 false, token none)
 186   ret void
 187
 188 unreachable:                                      ; preds = %after.coro.free
 189   unreachable
 190 }
 191
 192 declare void @llvm.dbg.declare(metadata, metadata, metadata)
 193 declare token @llvm.coro.id(i32, ptr readnone, ptr nocapture readonly, ptr)
 194 declare i1 @llvm.coro.alloc(token)
 195 declare i64 @llvm.coro.size.i64()
 196 declare token @llvm.coro.save(ptr)
 197 declare ptr @llvm.coro.begin(token, ptr writeonly)
 198 declare i8 @llvm.coro.suspend(token, i1)
 199 declare ptr @llvm.coro.free(token, ptr nocapture readonly)
 200 declare i1 @llvm.coro.end(ptr, i1, token)
 201
 202 declare ptr @new(i64)
 203 declare void @delete(ptr)
 204 declare i1 @await_ready()
 205 declare void @await_suspend()
 206 declare void @await_resume()
 207 declare void @print(i32)
 208 declare ptr @from_address(ptr)
 209 declare void @return_void()
 210 declare void @final_suspend()
 211
 212 declare void @llvm.memset.p0.i64(ptr nocapture writeonly, i8, i64, i1 immarg)
 213
 214 !llvm.dbg.cu = !{!0}
 215 !llvm.linker.options = !{}
 216 !llvm.module.flags = !{!3, !4}
 217 !llvm.ident = !{!5}
 218
 219 !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)
 220 !1 = !DIFile(filename: "repro.cpp", directory: ".")
 221 !2 = !{}
 222 !3 = !{i32 7, !"Dwarf Version", i32 4}
 223 !4 = !{i32 2, !"Debug Info Version", i32 3}
 224 !5 = !{!"clang version 11.0.0"}
 225 !6 = !DILocalVariable(name: "i", scope: !7, file: !1, line: 24, type: !10)
 226 !7 = distinct !DILexicalBlock(scope: !8, file: !1, line: 23, column: 12)
 227 !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)
 228 !9 = !DISubroutineType(types: !2)
 229 !10 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
 230 !11 = !DILocation(line: 24, column: 7, scope: !7)
 231 !12 = !DILocalVariable(name: "j", scope: !7, file: !1, line: 32, type: !10)
 232 !13 = !DILocation(line: 32, column: 7, scope: !7)
 233 !14 = !DILocalVariable(name: "x", scope: !22, file: !1, line: 34, type: !15)
 234 !15 = !DICompositeType(tag: DW_TAG_array_type, baseType: !10, size: 320, elements: !16)
 235 !16 = !{!17}
 236 !17 = !DISubrange(count: 10)
 237 !18 = !DILocation(line: 42, column: 3, scope: !7)
 238 !19 = !DILocation(line: 42, column: 8, scope: !7)
 239 !20 = !DILocation(line: 43, column: 3, scope: !7)
 240 !21 = !DILocation(line: 43, column: 8, scope: !7)
 241 !22 = distinct !DILexicalBlock(scope: !8, file: !1, line: 23, column: 12)