mirror of
https://github.com/golang/go
synced 2024-11-17 09:54:46 -07:00
a9831633be
The new escape analysis implementation tries to emit debugging diagnostics that are compatible with the existing implementation, but there's a handful of cases that are easier to handle by updating the test expectations instead. For regress tests that need updating, the original file is copied to oldescapeXXX.go.go with -newescape=false added to the //errorcheck line, while the file is updated in place with -newescape=true and new test requirements. Notable test changes: 1) escape_because.go looks for a lot of detailed internal debugging messages that are fairly particular to how esc.go works and that I haven't attempted to port over to escape.go yet. 2) There are a lot of "leaking param: x to result ~r1 level=-1" messages for code like func(p *int) *T { return &T{p} } that were simply wrong. Here &T must be heap allocated unconditionally (because it's being returned); and since p is stored into it, p escapes unconditionally too. esc.go incorrectly reports that p escapes conditionally only if the returned pointer escaped. 3) esc.go used to print each "leaking param" analysis result as it discovered them, which could lead to redundant messages (e.g., that a param leaks at level=0 and level=1). escape.go instead prints everything at the end, once it knows the shortest path to each sink. 4) esc.go didn't precisely model direct-interface types, resulting in some values unnecessarily escaping to the heap when stored into non-escaping interface values. 5) For functions written in assembly, esc.go only printed "does not escape" messages, whereas escape.go prints "does not escape" or "leaking param" as appropriate, consistent with the behavior for functions written in Go. 6) 12 tests included "BAD" annotations identifying cases where esc.go was unnecessarily heap allocating something. These are all fixed by escape.go. Updates #23109. Change-Id: Iabc9eb14c94c9cadde3b183478d1fd54f013502f Reviewed-on: https://go-review.googlesource.com/c/go/+/170447 Run-TryBot: Matthew Dempsky <mdempsky@google.com> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: David Chase <drchase@google.com>
175 lines
4.0 KiB
Go
175 lines
4.0 KiB
Go
// errorcheck -0 -m -l -newescape=true
|
|
|
|
// Copyright 2015 The Go Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
// Test escape analysis through ... parameters.
|
|
|
|
package foo
|
|
|
|
func FooN(vals ...*int) (s int) { // ERROR "FooN vals does not escape"
|
|
for _, v := range vals {
|
|
s += *v
|
|
}
|
|
return s
|
|
}
|
|
|
|
// Append forces heap allocation and copies entries in vals to heap, therefore they escape to heap.
|
|
func FooNx(x *int, vals ...*int) (s int) { // ERROR "leaking param: x" "leaking param content: vals"
|
|
vals = append(vals, x)
|
|
return FooN(vals...)
|
|
}
|
|
|
|
var sink []*int
|
|
|
|
func FooNy(x *int, vals ...*int) (s int) { // ERROR "leaking param: x" "leaking param: vals"
|
|
vals = append(vals, x)
|
|
sink = vals
|
|
return FooN(vals...)
|
|
}
|
|
|
|
func FooNz(vals ...*int) (s int) { // ERROR "leaking param: vals"
|
|
sink = vals
|
|
return FooN(vals...)
|
|
}
|
|
|
|
func TFooN() {
|
|
for i := 0; i < 1000; i++ {
|
|
var i, j int
|
|
FooN(&i, &j) // ERROR "TFooN ... argument does not escape"
|
|
}
|
|
}
|
|
|
|
func TFooNx() {
|
|
for i := 0; i < 1000; i++ {
|
|
var i, j, k int // ERROR "moved to heap: i" "moved to heap: j" "moved to heap: k"
|
|
FooNx(&k, &i, &j) // ERROR "TFooNx ... argument does not escape"
|
|
}
|
|
}
|
|
|
|
func TFooNy() {
|
|
for i := 0; i < 1000; i++ {
|
|
var i, j, k int // ERROR "moved to heap: i" "moved to heap: j" "moved to heap: k"
|
|
FooNy(&k, &i, &j) // ERROR "... argument escapes to heap"
|
|
}
|
|
}
|
|
|
|
func TFooNz() {
|
|
for i := 0; i < 1000; i++ {
|
|
var i, j int // ERROR "moved to heap: i" "moved to heap: j"
|
|
FooNz(&i, &j) // ERROR "... argument escapes to heap"
|
|
}
|
|
}
|
|
|
|
var isink *int32
|
|
|
|
func FooI(args ...interface{}) { // ERROR "leaking param content: args"
|
|
for i := 0; i < len(args); i++ {
|
|
switch x := args[i].(type) {
|
|
case nil:
|
|
println("is nil")
|
|
case int32:
|
|
println("is int32")
|
|
case *int32:
|
|
println("is *int32")
|
|
isink = x
|
|
case string:
|
|
println("is string")
|
|
}
|
|
}
|
|
}
|
|
|
|
func TFooI() {
|
|
a := int32(1) // ERROR "moved to heap: a"
|
|
b := "cat"
|
|
c := &a
|
|
FooI(a, b, c) // ERROR "a escapes to heap" "b escapes to heap" "c escapes to heap" "TFooI ... argument does not escape"
|
|
}
|
|
|
|
func FooJ(args ...interface{}) *int32 { // ERROR "leaking param: args to result ~r1 level=1"
|
|
for i := 0; i < len(args); i++ {
|
|
switch x := args[i].(type) {
|
|
case nil:
|
|
println("is nil")
|
|
case int32:
|
|
println("is int32")
|
|
case *int32:
|
|
println("is *int32")
|
|
return x
|
|
case string:
|
|
println("is string")
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func TFooJ1() {
|
|
a := int32(1)
|
|
b := "cat"
|
|
c := &a
|
|
FooJ(a, b, c) // ERROR "TFooJ1 a does not escape" "TFooJ1 b does not escape" "TFooJ1 c does not escape" "TFooJ1 ... argument does not escape"
|
|
}
|
|
|
|
func TFooJ2() {
|
|
a := int32(1) // ERROR "moved to heap: a"
|
|
b := "cat"
|
|
c := &a
|
|
isink = FooJ(a, b, c) // ERROR "a escapes to heap" "b escapes to heap" "c escapes to heap" "TFooJ2 ... argument does not escape"
|
|
}
|
|
|
|
type fakeSlice struct {
|
|
l int
|
|
a *[4]interface{}
|
|
}
|
|
|
|
func FooK(args fakeSlice) *int32 { // ERROR "leaking param: args to result ~r1 level=1"
|
|
for i := 0; i < args.l; i++ {
|
|
switch x := (*args.a)[i].(type) {
|
|
case nil:
|
|
println("is nil")
|
|
case int32:
|
|
println("is int32")
|
|
case *int32:
|
|
println("is *int32")
|
|
return x
|
|
case string:
|
|
println("is string")
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func TFooK2() {
|
|
a := int32(1) // ERROR "moved to heap: a"
|
|
b := "cat"
|
|
c := &a
|
|
fs := fakeSlice{3, &[4]interface{}{a, b, c, nil}} // ERROR "a escapes to heap" "b escapes to heap" "c escapes to heap" "TFooK2 &\[4\]interface {} literal does not escape"
|
|
isink = FooK(fs)
|
|
}
|
|
|
|
func FooL(args []interface{}) *int32 { // ERROR "leaking param: args to result ~r1 level=1"
|
|
for i := 0; i < len(args); i++ {
|
|
switch x := args[i].(type) {
|
|
case nil:
|
|
println("is nil")
|
|
case int32:
|
|
println("is int32")
|
|
case *int32:
|
|
println("is *int32")
|
|
return x
|
|
case string:
|
|
println("is string")
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func TFooL2() {
|
|
a := int32(1) // ERROR "moved to heap: a"
|
|
b := "cat"
|
|
c := &a
|
|
s := []interface{}{a, b, c} // ERROR "a escapes to heap" "b escapes to heap" "c escapes to heap" "TFooL2 \[\]interface {} literal does not escape"
|
|
isink = FooL(s)
|
|
}
|