mirror of
https://github.com/golang/go
synced 2024-11-23 13:50:06 -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>
48 lines
1.4 KiB
Go
48 lines
1.4 KiB
Go
// errorcheck -0 -N -m -l -newescape=true
|
|
|
|
// Copyright 2016 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.
|
|
|
|
// The escape analyzer needs to run till its root set settles
|
|
// (this is not that often, it turns out).
|
|
// This test is likely to become stale because the leak depends
|
|
// on a spurious-escape bug -- return an interface as a named
|
|
// output parameter appears to cause the called closure to escape,
|
|
// where returning it as a regular type does not.
|
|
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
)
|
|
|
|
type closure func(i, j int) ent
|
|
|
|
type ent int
|
|
|
|
func (e ent) String() string {
|
|
return fmt.Sprintf("%d", int(e)) // ERROR "ent.String ... argument does not escape$" "int\(e\) escapes to heap$"
|
|
}
|
|
|
|
//go:noinline
|
|
func foo(ops closure, j int) (err fmt.Stringer) { // ERROR "foo ops does not escape"
|
|
enqueue := func(i int) fmt.Stringer { // ERROR "foo func literal does not escape"
|
|
return ops(i, j) // ERROR "ops\(i, j\) escapes to heap$"
|
|
}
|
|
err = enqueue(4)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return // return result of enqueue, a fmt.Stringer
|
|
}
|
|
|
|
func main() {
|
|
// 3 identical functions, to get different escape behavior.
|
|
f := func(i, j int) ent { // ERROR "main func literal does not escape"
|
|
return ent(i + j)
|
|
}
|
|
i := foo(f, 3).(ent)
|
|
fmt.Printf("foo(f,3)=%d\n", int(i)) // ERROR "int\(i\) escapes to heap$" "main ... argument does not escape$"
|
|
}
|