basic.ll

; RUN: %swift-llvm-opt -passes=swift-llvm-arc-optimize %s | %FileCheck %s

; Use this testfile to check if the `swift-frontend -swift-dependency-tool` option works.
; RUN: %swift_frontend_plain -swift-llvm-opt -passes=swift-llvm-arc-optimize %s | %FileCheck %s

targetdatalayout = "e-p:64:64:64-S128-i1:8:8-i8:8:8-i16:16:16-i32:32:32-i64:64:64-f16:16:16-f32:32:32-f64:64:64-f128:128:128-v64:64:64-v128:128:128-a0:0:64-s0:64:64-f80:128:128-n8:16:32:64"
targettriple = "x86_64-apple-macosx10.9"

%swift.refcounted = type { ptr, i64 }
%swift.heapmetadata = type { ptr, ptr }
%objc_object = typeopaque
%swift.bridge = typeopaque

declareptr@swift_unknownObjectRetain(ptrreturned)
declarevoid@swift_unknownObjectRelease(ptr)
declareptr@llvm.objc.retain(ptr)
declarevoid@llvm.objc.release(ptr)
declareptr@swift_allocObject(ptr , i64, i64) nounwind
declarevoid@swift_release(ptrnocapture)
declareptr@swift_retain(ptrreturned) nounwind
declareptr@swift_bridgeObjectRetain(ptr)
declarevoid@swift_bridgeObjectRelease(ptr)
declareptr@swift_retainUnowned(ptrreturned)

declarevoid@user(ptr) nounwind
declarevoid@user_objc(ptr) nounwind
declarevoid@unknown_func()

defineprivatevoid@__swift_fixLifetime(ptr) noinlinenounwind {
entry:
retvoid
}

; CHECK-LABEL: @trivial_objc_canonicalization(
; CHECK-NEXT: entry:
; CHECK-NEXT: [[RET1:%.+]] = tail call ptr @llvm.objc.retain(ptr [[RET0:%.+]])
; CHECK-NEXT: call void @user_objc(ptr [[RET0:%.+]])
; CHECK-NEXT: ret void

definevoid@trivial_objc_canonicalization(ptr%O) {
entry:
%0 = tailcallptr@llvm.objc.retain(ptr%O)
callvoid@user_objc(ptr%0) nounwind
retvoid
}

; CHECK-LABEL: @trivial_retain_release(
; CHECK-NEXT: entry:
; CHECK-NEXT: call void @user
; CHECK-NEXT: ret void

definevoid@trivial_retain_release(ptr%P, ptr%O, ptr%B) {
entry:
tailcallptr@swift_retain(ptr%P)
tailcallvoid@swift_release(ptr%P) nounwind
tailcallptr@swift_unknownObjectRetain(ptr%P)
tailcallvoid@swift_unknownObjectRelease(ptr%P)
tailcallptr@llvm.objc.retain(ptr%O)
tailcallvoid@llvm.objc.release(ptr%O)
%v = tailcallptr@swift_bridgeObjectRetain(ptr%B)
tailcallvoid@swift_bridgeObjectRelease(ptr%v)
callvoid@user(ptr%P) nounwind
retvoid
}

; CHECK-LABEL: @trivial_retain_release_with_rcidentity(
; CHECK-NEXT: entry:
; CHECK-NEXT: call void @user
; CHECK-NEXT: ret void

definevoid@trivial_retain_release_with_rcidentity(ptr%P, ptr%O, ptr%B) {
entry:
tailcallptr@swift_retain(ptr%P)
tailcallvoid@swift_release(ptr%P) nounwind
tailcallptr@swift_unknownObjectRetain(ptr%P)
tailcallvoid@swift_unknownObjectRelease(ptr%P)
tailcallptr@llvm.objc.retain(ptr%O)
tailcallvoid@llvm.objc.release(ptr%O)
callvoid@user(ptr%P) nounwind
retvoid
}

; retain_motion1 - This shows motion of a retain across operations that can't
; release an object. Release motion can't zap this.

; CHECK-LABEL: @retain_motion1(
; CHECK-NEXT: store i32
; CHECK-NEXT: ret void


definevoid@retain_motion1(ptr%A) {
tailcallptr@swift_retain(ptr%A)
storei3242, ptr%A
tailcallvoid@swift_release(ptr%A) nounwind
retvoid
}

; rdar://11583269 - Optimize out objc_retain/release(null)

; CHECK-LABEL: @objc_retain_release_null(
; CHECK-NEXT: entry:
; CHECK-NEXT: ret void

definevoid@objc_retain_release_null() {
entry:
tailcallvoid@llvm.objc.release(ptrnull) nounwind
tailcallptr@llvm.objc.retain(ptrnull)
retvoid
}

; CHECK-LABEL: @swiftunknown_retain_release_null(
; CHECK-NEXT: entry:
; CHECK-NEXT: ret void

definevoid@swiftunknown_retain_release_null() {
entry:
tailcallvoid@swift_unknownObjectRelease(ptrnull)
tailcallptr@swift_unknownObjectRetain(ptrnull) nounwind
retvoid
}

; rdar://11583269 - Useless objc_retain/release optimization.

; CHECK-LABEL: @objc_retain_release_opt(
; CHECK-NEXT: store i32 42
; CHECK-NEXT: ret void

definevoid@objc_retain_release_opt(ptr%P, ptr%IP) {
tailcallptr@llvm.objc.retain(ptr%P) nounwind
storei3242, ptr%IP
tailcallvoid@llvm.objc.release(ptr%P) nounwind
retvoid
}

; CHECK-LABEL: define{{( protected)?}} void @swift_fixLifetimeTest
; CHECK: swift_retain
; CHECK: swift_fixLifetime
; CHECK: swift_release
definevoid@swift_fixLifetimeTest(ptr%A) {
tailcallptr@swift_retain(ptr%A)
callvoid@user(ptr%A) nounwind
callvoid@__swift_fixLifetime(ptr%A)
tailcallvoid@swift_release(ptr%A) nounwind
retvoid
}

; CHECK-LABEL: @move_retain_across_unknown_retain
; CHECK-NOT: swift_retain
; CHECK: swift_unknownObjectRetain
; CHECK-NOT: swift_release
; CHECK: ret
definevoid@move_retain_across_unknown_retain(ptr%A, ptr%B) {
tailcallptr@swift_retain(ptr%A)
tailcallptr@swift_unknownObjectRetain(ptr%B)
tailcallvoid@swift_release(ptr%A) nounwind
retvoid
}

; CHECK-LABEL: @move_retain_across_objc_retain
; CHECK-NOT: swift_retain
; CHECK: llvm.objc.retain
; CHECK-NOT: swift_release
; CHECK: ret
definevoid@move_retain_across_objc_retain(ptr%A, ptr%B) {
tailcallptr@swift_retain(ptr%A)
tailcallptr@llvm.objc.retain(ptr%B)
tailcallvoid@swift_release(ptr%A) nounwind
retvoid
}

; CHECK-LABEL: @move_retain_across_load
; CHECK-NOT: swift_retain
; CHECK-NOT: swift_release
; CHECK: ret
definei32@move_retain_across_load(ptr%A, ptr%ptr) {
tailcallptr@swift_retain(ptr%A)
%val = loadi32, ptr%ptr
tailcallvoid@swift_release(ptr%A) nounwind
reti32%val
}

; CHECK-LABEL: @move_retain_but_not_release_across_objc_fix_lifetime
; CHECK: call void @__swift_fixLifetime
; CHECK-NEXT: tail call ptr @swift_retain
; CHECK-NEXT: call void @user
; CHECK-NEXT: call void @__swift_fixLifetime
; CHECK-NEXT: call void @swift_release
; CHECK-NEXT: ret
definevoid@move_retain_but_not_release_across_objc_fix_lifetime(ptr%A) {
tailcallptr@swift_retain(ptr%A)
callvoid@__swift_fixLifetime(ptr%A) nounwind
callvoid@user(ptr%A) nounwind
callvoid@__swift_fixLifetime(ptr%A) nounwind
tailcallvoid@swift_release(ptr%A) nounwind
retvoid
}

; CHECK-LABEL: @optimize_retain_unowned
; CHECK-NEXT: load
; CHECK-NEXT: add
; CHECK-NEXT: load
; CHECK-NEXT: call void @swift_checkUnowned
; CHECK-NEXT: ret
definevoid@optimize_retain_unowned(ptr%A) {
tailcallptr@swift_retainUnowned(ptr%A)

; loads from the %A and speculatively executable instructions
%L1 = loadi64, ptr%A, align8
%R1 = addi64%L1, 1
%L2 = loadi64, ptr%A, align8

tailcallvoid@swift_release(ptr%A)
retvoid
}

; CHECK-LABEL: @dont_optimize_retain_unowned
; CHECK-NEXT: call ptr @swift_retainUnowned
; CHECK-NEXT: load
; CHECK-NEXT: load
; CHECK-NEXT: call void @swift_release
; CHECK-NEXT: ret
definevoid@dont_optimize_retain_unowned(ptr%A) {
tailcallptr@swift_retainUnowned(ptr%A)

%L1 = loadptr, ptr%A, align8
; Use of a potential garbage address from a load of %A.
%L2 = loadi64, ptr%L1, align8

tailcallvoid@swift_release(ptr%A)
retvoid
}

; CHECK-LABEL: @dont_optimize_retain_unowned2
; CHECK-NEXT: call ptr @swift_retainUnowned
; CHECK-NEXT: store
; CHECK-NEXT: call void @swift_release
; CHECK-NEXT: ret
definevoid@dont_optimize_retain_unowned2(ptr%A, ptr%B) {
tailcallptr@swift_retainUnowned(ptr%A)

; store to an unknown address
storei3242, ptr%B

tailcallvoid@swift_release(ptr%A)
retvoid
}

; CHECK-LABEL: @dont_optimize_retain_unowned3
; CHECK-NEXT: call ptr @swift_retainUnowned
; CHECK-NEXT: call void @unknown_func
; CHECK-NEXT: call void @swift_release
; CHECK-NEXT: ret
definevoid@dont_optimize_retain_unowned3(ptr%A) {
tailcallptr@swift_retainUnowned(ptr%A)

; call of an unknown function
callvoid@unknown_func()

tailcallvoid@swift_release(ptr%A)
retvoid
}

; CHECK-LABEL: @dont_optimize_retain_unowned4
; CHECK-NEXT: call ptr @swift_retainUnowned
; CHECK-NEXT: call ptr @swift_retain
; CHECK-NEXT: call void @swift_release
; CHECK-NEXT: ret
definevoid@dont_optimize_retain_unowned4(ptr%A, ptr%B) {
tailcallptr@swift_retainUnowned(ptr%A)

; retain of an unknown reference (%B could be equal to %A)
tailcallptr@swift_retain(ptr%B)

tailcallvoid@swift_release(ptr%A)
retvoid
}

; CHECK-LABEL: @remove_redundant_check_unowned
; CHECK-NEXT: load
; CHECK-NEXT: call void @swift_checkUnowned
; CHECK-NEXT: load
; CHECK-NEXT: store
; CHECK-NEXT: load
; CHECK-NEXT: ret
definevoid@remove_redundant_check_unowned(ptr%A, ptr%B, ptr%C) {
tailcallptr@swift_retainUnowned(ptr%A)
%L1 = loadi64, ptr%A, align8
tailcallvoid@swift_release(ptr%A)

; Instructions which cannot do a release.
%L2 = loadi64, ptr%C, align8
storei6442, ptr%C

tailcallptr@swift_retainUnowned(ptr%A)
%L3 = loadi64, ptr%A, align8
tailcallvoid@swift_release(ptr%A)
retvoid
}

; CHECK-LABEL: @dont_remove_redundant_check_unowned
; CHECK-NEXT: load
; CHECK-NEXT: call void @swift_checkUnowned
; CHECK-NEXT: call void @unknown_func
; CHECK-NEXT: load
; CHECK-NEXT: call void @swift_checkUnowned
; CHECK-NEXT: ret
definevoid@dont_remove_redundant_check_unowned(ptr%A, ptr%B, ptr%C) {
tailcallptr@swift_retainUnowned(ptr%A)
%L1 = loadi64, ptr%A, align8
tailcallvoid@swift_release(ptr%A)

; Could do a release of %A
callvoid@unknown_func()

tailcallptr@swift_retainUnowned(ptr%A)
%L3 = loadi64, ptr%A, align8
tailcallvoid@swift_release(ptr%A)
retvoid
}

; CHECK-LABEL: @unknown_retain_promotion
; CHECK-NEXT: swift_retain
; CHECK-NEXT: swift_retain
; CHECK-NEXT: swift_retain
; CHECK-NEXT: ret
definevoid@unknown_retain_promotion(ptr%A) {
tailcallptr@swift_unknownObjectRetain(ptr%A)
tailcallptr@swift_unknownObjectRetain(ptr%A)
tailcallptr@swift_retain(ptr%A)
retvoid
}

; CHECK-LABEL: @unknown_release_promotion
; CHECK-NEXT: swift_release
; CHECK-NEXT: swift_release
; CHECK-NEXT: swift_release
; CHECK-NEXT: ret
definevoid@unknown_release_promotion(ptr%A) {
tailcallvoid@swift_unknownObjectRelease(ptr%A)
tailcallvoid@swift_unknownObjectRelease(ptr%A)
tailcallvoid@swift_release(ptr%A)
retvoid
}

; CHECK-LABEL: @unknown_retain_nopromotion
; CHECK: bb1
; CHECK-NOT: swift_retain
; CHECK: ret
definevoid@unknown_retain_nopromotion(ptr%A) {
tailcallptr@swift_retain(ptr%A)
brlabel%bb1
bb1:
tailcallptr@swift_unknownObjectRetain(ptr%A)
retvoid
}

; CHECK-LABEL: @releasemotion_forwarding
; CHECK-NOT: swift_retain
; CHECK-NOT: swift_release
; CHECK: call void @user(ptr %P)
; CHECK: ret
definevoid@releasemotion_forwarding(ptr%P, ptr%O, ptr%B) {
entry:
%res = tailcallptr@swift_retain(ptr%P)
tailcallvoid@swift_release(ptr%res) nounwind
callvoid@user(ptr%res) nounwind
retvoid
}

; CHECK-LABEL: @retainmotion_forwarding
; CHECK: store ptr %P, ptr %R, align 4
; CHECK-NOT: swift_retain
; CHECK-NOT: swift_release
; CHECK: ret
definevoid@retainmotion_forwarding(ptr%P, ptr%R, ptr%B) {
entry:
%res = tailcallptr@swift_retain(ptr%P)
storeptr%res, ptr%R, align4
callvoid@swift_bridgeObjectRelease(ptr%B)
tailcallvoid@swift_release(ptr%res) nounwind
retvoid
}

; CHECK-LABEL: @unknownreleasemotion_forwarding
; CHECK-NOT: swift_unknownObjectRetain
; CHECK-NOT: swift_unknownObjectRelease
; CHECK: call void @user(ptr %P)
; CHECK: ret
definevoid@unknownreleasemotion_forwarding(ptr%P, ptr%O, ptr%B) {
entry:
%res = tailcallptr@swift_unknownObjectRetain(ptr%P)
tailcallvoid@swift_unknownObjectRelease(ptr%res) nounwind
callvoid@user(ptr%res) nounwind
retvoid
}

; CHECK-LABEL: @unknownretainmotion_forwarding
; CHECK: store ptr %P, ptr %R, align 4
; CHECK-NOT: swift_unknownObjectRetain
; CHECK-NOT: swift_unknownObjectRelease
; CHECK: ret
definevoid@unknownretainmotion_forwarding(ptr%P, ptr%R, ptr%B) {
entry:
%res = tailcallptr@swift_unknownObjectRetain(ptr%P)
storeptr%res, ptr%R, align4
callvoid@swift_bridgeObjectRelease(ptr%B)
tailcallvoid@swift_unknownObjectRelease(ptr%res) nounwind
retvoid
}

!llvm.dbg.cu = !{!1}
!llvm.module.flags = !{!4}

!0 = !DILocation(line: 0, scope: !3)
!1 = distinct !DICompileUnit(language: DW_LANG_Swift, file: !2)
!2 = !DIFile(filename: "basic.swift", directory: "")
!3 = distinct !DISubprogram(name: "_", scope: !1, file: !2, type: !DISubroutineType(types: !{}))
!4 = !{i321, !"Debug Info Version", i323}