Files
swift-mirror/test/SILGen/sil_locations.swift
Adrian Prantl 82a26a59d8 Emit line table entries for closure setup instructions.
Currently the Swift compiler makes these instructions with SILLocations marked
as autgenerated. While this allows for somewhat smoother stepping in some cases,
it can also make some debugging tasks harder due to missing source location
information, for example, when attributing memory allocations.

This patch makes these locations available again, based on that a debug info
consumer could consider filtering them out by recognizing that a source location
is on the opening `{` of a closure, but inside the scope of the function the
closure is defined in.

rdar://127095833
2024-04-29 12:51:28 -07:00

446 lines
13 KiB
Swift

// RUN: %target-swift-emit-silgen -module-name sil_locations -Xllvm -sil-print-debuginfo -emit-verbose-sil %s | %FileCheck %s
// FIXME: Not sure if this an ideal source info for the branch -
// it points to if, not the last instruction in the block.
func ifexpr() -> Int {
var x : Int = 0
if true {
x+=1
}
return x
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations6ifexprSiyF
// CHECK: apply {{.*}}, loc "{{.*}}":[[@LINE-5]]:6
// CHECK: cond_br {{%.*}}, [[TRUE_BB:bb[0-9]+]], [[FALSE_BB:bb[0-9]+]], loc "{{.*}}":[[@LINE-6]]:6
// CHECK: [[TRUE_BB]]:
// CHECK: br [[CONT_BB:bb[0-9]+]], loc "{{.*}}":[[@LINE-6]]:3
// CHECK: [[CONT_BB]]:
// CHECK: return {{.*}}, loc "{{.*}}":[[@LINE-7]]:3, {{.*}}:return
}
func ifelseexpr() -> Int {
var x : Int = 0
if true {
x+=1
} else {
x-=1
}
return x
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations10ifelseexprSiyF
// CHECK: cond_br {{%.*}}, [[TRUE_BB:bb[0-9]+]], [[FALSE_BB:bb[0-9]+]], loc "{{.*}}":[[@LINE-7]]:6
// CHECK: [[TRUE_BB]]:
// CHECK: br bb{{[0-9]+}}, loc "{{.*}}":[[@LINE-7]]:3
// CHECK: [[FALSE_BB]]:
// CHECK: br bb{{[0-9]+}}, loc "{{.*}}":[[@LINE-7]]:3
// CHECK: return {{.*}}, loc "{{.*}}":[[@LINE-7]]:3, {{.*}}:return
}
// The source locations are handled differently here - since
// the return is unified, we keep the location of the return(not the if)
// in the branch.
func ifexpr_return() -> Int {
if true {
return 5
}
return 6
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations13ifexpr_returnSiyF
// CHECK: apply {{.*}}, loc "{{.*}}":[[@LINE-5]]:6
// CHECK: cond_br {{%.*}}, [[TRUE_BB:bb[0-9]+]], [[FALSE_BB:bb[0-9]+]], loc "{{.*}}":[[@LINE-6]]:6
// CHECK: [[TRUE_BB]]:
// CHECK: br bb{{[0-9]+}}({{%.*}}), loc "{{.*}}":[[@LINE-7]]:5, {{.*}}:return
// CHECK: [[FALSE_BB]]:
// CHECK: br bb{{[0-9]+}}({{%.*}}), loc "{{.*}}":[[@LINE-7]]:3, {{.*}}:return
// CHECK: return {{.*}}, loc "{{.*}}":[[@LINE+1]]:1, {{.*}}:cleanup
}
func ifexpr_rval() -> Int {
var x = true ? 5 : 6
return x
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations11ifexpr_rvalSiyF
// CHECK: apply {{.*}}, loc "{{.*}}":[[@LINE-3]]:11
// CHECK: cond_br {{%.*}}, [[TRUE_BB:bb[0-9]+]], [[FALSE_BB:bb[0-9]+]], loc "{{.*}}":[[@LINE-4]]:11
// CHECK: [[TRUE_BB]]:
// CHECK: br bb{{[0-9]+}}({{%.*}}), loc "{{.*}}":[[@LINE-6]]:18
// CHECK: [[FALSE_BB]]:
// CHECK: br bb{{[0-9]+}}({{%.*}}), loc "{{.*}}":[[@LINE-8]]:22
}
// --- Test function calls.
func simpleDirectCallTest(_ i: Int) -> Int {
return simpleDirectCallTest(i)
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations20simpleDirectCallTestyS2iF
// CHECK: function_ref @$s13sil_locations20simpleDirectCallTestyS2iF : {{.*}}, loc "{{.*}}":[[@LINE-2]]:10
// CHECK: {{%.*}} apply {{%.*}} line:[[@LINE-3]]:10
}
func templateTest<T>(_ value: T) -> T {
return value
}
func useTemplateTest() -> Int {
return templateTest(5);
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations15useTemplateTestSiyF
// CHECK: function_ref @$sSi2{{[_0-9a-zA-Z]*}}fC :{{.*}}, loc "{{.*}}":[[@LINE-2]]
}
func foo(_ x: Int) -> Int {
func bar(_ y: Int) -> Int {
return x + y
}
return bar(1)
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations3foo{{[_0-9a-zA-Z]*}}F
// CHECK: [[CLOSURE:%[0-9]+]] = function_ref {{.*}}, loc "{{.*}}":[[@LINE-2]]:10
// CHECK: apply [[CLOSURE:%[0-9]+]]
}
class LocationClass {
func mem() {}
}
func testMethodCall() {
var l: LocationClass
l.mem();
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations14testMethodCallyyF
// CHECK: class_method {{.[0-9]+}} : $LocationClass, #LocationClass.mem : {{.*}}, loc "{{.*}}":[[@LINE-3]]:5
}
func multipleReturnsImplicitAndExplicit() {
var x = 5+3
if x > 10 {
return
}
x += 1
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations34multipleReturnsImplicitAndExplicityyF
// CHECK: cond_br
// CHECK: br bb{{[0-9]+}}, loc "{{.*}}":[[@LINE-5]]:5, {{.*}}:return
// CHECK: br bb{{[0-9]+}}, loc "{{.*}}":[[@LINE+2]]:1, {{.*}}:imp_return
// CHECK: return {{.*}}, loc "{{.*}}":[[@LINE+1]]:1, {{.*}}:cleanup
}
func simplifiedImplicitReturn() -> () {
var y = 0
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations24simplifiedImplicitReturnyyF
// CHECK: return {{.*}}, loc "{{.*}}":[[@LINE+1]]:1, {{.*}}:imp_return
}
func switchfoo() -> Int { return 0 }
func switchbar() -> Int { return 0 }
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations10testSwitchyyF
func testSwitch() {
var x:Int
x = 0
switch (switchfoo(), switchbar()) {
// CHECK: store {{.*}}, loc "{{.*}}":[[@LINE-1]]
case (1,2):
// CHECK: integer_literal $Builtin.IntLiteral, 2, loc "{{.*}}":[[@LINE-3]]:10
// FIXME: Location info is missing.
// CHECK: cond_br
//
var z: Int = 200
// CHECK: [[VAR_Z:%[0-9]+]] = alloc_box ${ var Int }, var, name "z"{{.*}}line:[[@LINE-1]]:9
// CHECK: integer_literal $Builtin.IntLiteral, 200, loc "{{.*}}":[[@LINE-2]]:18
x = z
// CHECK: destroy_value [[VAR_Z]]{{.*}}, loc "{{.*}}":[[@LINE-1]]:9, {{.*}}:cleanup
case (3, let y):
x += 1
default:
()
}
}
func testIf() {
if true {
var y:Int
} else {
var x:Int
}
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations6testIfyyF
//
// FIXME: Missing location info here.
// CHECK: function_ref
// CHECK: apply
//
//
//
// CHECK: br {{.*}}, loc "{{.*}}":[[@LINE-13]]:6
}
func testFor() {
for i in 0..<10 {
var y: Int = 300
y+=1
if true {
break
}
y-=1
continue
}
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations7testForyyF
// CHECK: [[VAR_Y_IN_FOR:%[0-9]+]] = alloc_box ${ var Int }, var, name "y", loc "{{.*}}":[[@LINE-10]]:9
// CHECK: integer_literal $Builtin.IntLiteral, 300, loc "{{.*}}":[[@LINE-11]]:18
// CHECK: destroy_value [[VAR_Y_IN_FOR]] : ${ var Int }
// CHECK: br bb{{.*}}, loc "{{.*}}":[[@LINE-10]]:7
// CHECK: destroy_value [[VAR_Y_IN_FOR]] : ${ var Int }
// CHECK: br bb{{.*}}, loc "{{.*}}":[[@LINE-9]]:5
}
func testTuples() {
var t = (2,3)
var tt = (2, (4,5))
var d = "foo"
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations10testTuplesyyF
// CHECK: tuple_element_addr {{.*}}, loc "{{.*}}":[[@LINE-4]]:11
// CHECK: integer_literal $Builtin.IntLiteral, 2, loc "{{.*}}":[[@LINE-5]]:12
// CHECK: integer_literal $Builtin.IntLiteral, 3, loc "{{.*}}":[[@LINE-6]]:14
// CHECK: tuple_element_addr {{.*}}, loc "{{.*}}":[[@LINE-6]]:12
// CHECK: tuple_element_addr {{.*}}, loc "{{.*}}":[[@LINE-7]]:16
}
// Test tuple imploding/exploding.
protocol Ordinable {
func ord() -> Int
}
func b<T : Ordinable>(_ seq: T) -> (Int) -> Int {
return {i in i + seq.ord() }
}
func captures_tuple<T, U>(x: (T, U)) -> () -> (T, U) {
return {x}
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations14captures_tuple{{[_0-9a-zA-Z]*}}F
// CHECK: tuple_element_addr {{.*}}, loc "{{.*}}":[[@LINE-3]]:27
// CHECK: copy_addr {{.*}}, loc "{{.*}}":[[@LINE-4]]:27
// CHECK: function_ref {{.*}}, loc "{{.*}}":[[@LINE-4]]:10
// CHECK-LABEL: sil private [ossa] @$s13sil_locations14captures_tuple{{.*}}fU_
// CHECK: copy_addr {{.*}}, loc "{{.*}}":[[@LINE-7]]:11
}
func interpolated_string(_ x: Int, y: String) -> String {
return "The \(x) Million Dollar \(y)"
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations19interpolated_string{{[_0-9a-zA-Z]*}}F
// CHECK: function_ref @$ss26DefaultStringInterpolationV15literalCapacity18interpolationCountABSi_SitcfC
// CHECK-NEXT: apply{{.*}}, loc "{{.*}}":[[@LINE-3]]:10
// CHECK: string_literal utf8 "The ", loc "{{.*}}":[[@LINE-5]]:10
// CHECK: function_ref @$ss26DefaultStringInterpolationV13appendLiteralyySSF
// CHECK-NEXT: apply{{.*}}, loc "{{.*}}":[[@LINE-7]]:11
// CHECK: store %0 to{{.*}}, loc "{{.*}}":[[@LINE-9]]:17
// CHECK: function_ref @$ss26DefaultStringInterpolationV06appendC0yyxs06CustomB11ConvertibleRzlF
// CHECK-NEXT: apply{{.*}}, loc "{{.*}}":[[@LINE-11]]:16
// CHECK: string_literal utf8 " Million Dollar ", loc "{{.*}}":[[@LINE-13]]:19
// CHECK: function_ref @$ss26DefaultStringInterpolationV13appendLiteralyySSF
// CHECK-NEXT: apply{{.*}}, loc "{{.*}}":[[@LINE-15]]:19
// CHECK: store_borrow %1 to {{.*}}, loc "{{.*}}":[[@LINE-17]]:37
// CHECK: function_ref @$ss26DefaultStringInterpolationV06appendC0yyxs06CustomB11ConvertibleRzs20TextOutputStreamableRzlF
// CHECK-NEXT: apply{{.*}}, loc "{{.*}}":[[@LINE-19]]:36
// CHECK: function_ref @$sSS19stringInterpolationSSs013DefaultStringB0V_tcfC
// CHECK-NEXT: apply{{.*}}, loc "{{.*}}":[[@LINE-22]]:10
}
func int(_ x: Int) {}
func tuple() -> (Int, Float) { return (1, 1.0) }
func tuple_element(_ x: (Int, Float)) {
int(tuple().0)
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations13tuple_element{{[_0-9a-zA-Z]*}}F
// CHECK: apply {{.*}} line:[[@LINE-3]]:7
// CHECK: destructure_tuple {{.*}}line:[[@LINE-4]]:7
// CHECK: apply {{.*}} line:[[@LINE-5]]:3
}
func containers() -> ([Int], Dictionary<String, Int>) {
return ([1, 2, 3], ["Ankeny": 101, "Burnside": 102, "Couch": 103])
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations10containers{{[_0-9a-zA-Z]*}}F
// CHECK: string_literal utf8 "Ankeny", loc "{{.*}}":[[@LINE-3]]:23
// CHECK: integer_literal $Builtin.IntLiteral, 101, loc "{{.*}}":[[@LINE-5]]:33
// CHECK: integer_literal $Builtin.IntLiteral, 102, loc "{{.*}}":[[@LINE-6]]:50
// CHECK: apply {{%.*}}<String, Int>({{%.*}}, {{%.*}}) : {{.*}}, loc "{{.*}}":[[@LINE-8]]:22
}
func a() {}
func b() -> Int { return 0 }
protocol P { func p() }
struct X : P { func p() {} }
func test_isa_2(_ p: P) {
switch (p, b()) {
case (is X, b()):
a()
case _:
a()
}
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations10test_isa_2{{[_0-9a-zA-Z]*}}F
// CHECK: alloc_stack $(any P, Int), loc "{{.*}}":[[@LINE-10]]:10
// CHECK: tuple_element_addr{{.*}} $*(any P, Int), 0, loc "{{.*}}":[[@LINE-11]]:10
// CHECK: tuple_element_addr{{.*}} $*(any P, Int), 1, loc "{{.*}}":[[@LINE-12]]:10
// CHECK: load {{.*}}, loc "{{.*}}":[[@LINE-12]]:8
//
// CHECK: checked_cast_addr_br {{.*}}, loc "{{.*}}":[[@LINE-14]]:9
// CHECK: load {{.*}}, loc "{{.*}}":[[@LINE-15]]:9
}
func runcibleWhy() {}
protocol Runcible {
func runce()
}
enum SinglePayloadAddressOnly {
case x(Runcible)
case y
}
func printSinglePayloadAddressOnly(_ v:SinglePayloadAddressOnly) {
switch v {
case .x(let runcible):
runcible.runce()
case .y:
runcibleWhy()
}
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations29printSinglePayloadAddressOnly{{[_0-9a-zA-Z]*}}F
// CHECK: bb0
// CHECK: switch_enum_addr {{.*}} [[FALSE_BB:bb[0-9]+]], {{.*}}line:[[@LINE-10]]:3
// CHECK: [[FALSE_BB]]:
}
func testStringForEachStmt() {
var i = 0
for index in 1..<20 {
i += 1
if i == 15 {
break
}
}
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations21testStringForEachStmtyyF
// CHECK: br {{.*}} line:[[@LINE-8]]:3
// CHECK: switch_enum {{.*}} line:[[@LINE-9]]:3
// CHECK: cond_br {{.*}} line:[[@LINE-8]]:10
// Break branch:
// CHECK: br {{.*}} line:[[@LINE-9]]:7
// Looping back branch:
// CHECK: br {{.*}} line:[[@LINE-9]]:3
// Condition is false branch:
// CHECK: br {{.*}} line:[[@LINE-16]]:3
}
func testForStmt() {
var m = 0
for i in 0..<10 {
m += 1
if m == 15 {
break
} else {
continue
}
}
}
func testRepeatWhile() {
var m = 0
repeat {
m += 1
} while (m < 200)
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations15testRepeatWhileyyF
// CHECK: br {{.*}} line:[[@LINE-6]]:3
// CHECK: cond_br {{.*}} line:[[@LINE-5]]:14
// Loop back branch:
// CHECK: br {{.*}} line:[[@LINE-7]]:14
}
func testWhile() {
var m = 0
while m < 100 {
m += 1
if m > 5 {
break
}
m += 1
}
// CHECK-LABEL: sil hidden [ossa] @$s13sil_locations9testWhileyyF
// CHECK: br {{.*}} line:[[@LINE-9]]:3
// While loop conditional branch:
// CHECK: cond_br {{.*}} line:[[@LINE-11]]:11
// If stmt condition branch:
// CHECK: cond_br {{.*}} line:[[@LINE-11]]:10
// Break branch:
// CHECK: br {{.*}} line:[[@LINE-12]]:7
// Looping back branch:
// CHECK: br {{.*}} line:[[@LINE-11]]:3
}
// Check that the sil location of keypath getter/setter functions is
// marked as autogenerated.
struct Struct {
var structProperty: InnerStruct {
get { InnerStruct() }
set(newStruct) { }
}
struct InnerStruct {}
}
func testKeyPathGetterSetterAutogen() -> Struct.InnerStruct {
let kp = \Struct.structProperty
var s = Struct()
let innerS = Struct.InnerStruct()
s[keyPath: kp] = innerS
return s[keyPath: kp]
// Autogenerated keypath getter
// CHECK-LABEL: sil shared [thunk] [ossa] @$s13sil_locations6StructV14structProperty{{[_0-9a-zA-Z]*}}TK
// CHECK: load {{.*}} loc * "<compiler-generated>":0:0{{.*}}<invalid loc>:auto_gen
// Autogenerated keypath setter
// CHECK-LABEL: sil shared [thunk] [ossa] @$s13sil_locations6StructV14structProperty{{[_0-9a-zA-Z]*}}Tk
// CHECK: load {{.*}} loc * "<compiler-generated>":0:0{{.*}}<invalid loc>:auto_gen
}