runtime: add note that Callers never returns an entry PC

The presence of a pc > entry check in CallersFrame implies we might
actually see pc == entry, when in reality Callers will never return such
a PC. This check is actually just a safety check for avoid reporting
completely nonsensical from bad input.

all.bash reports two violations to this invariant:

TestCallersFromWrapper, which explicitly constructs a CallersFrame input
with an entry PC.

runtime/pprof.printStackRecord, which passes pprof stacks to
CallersFrame (technically not a valid use of CallersFrames!).
runtime/pprof.(*Profile).Add can add the entry PC of
runtime/pprof.lostProfileEvent to samples.

(CPU profiles do lostProfileEvent + 1. I will send a second CL to fix
Add.)

Change-Id: Iac2a2f0c15117d4a383bd84cddf0413b2d7dd3ef
Reviewed-on: https://go-review.googlesource.com/c/go/+/634315
Auto-Submit: Michael Pratt <mpratt@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Michael Knyszek <mknyszek@google.com>

diff --git a/src/runtime/symtab.go b/src/runtime/symtab.go
index ea048832c74d8a20164cdfb435ab2d3deae72804..c78b044264742d97ea9c15343787f03dad2215ba 100644 (file)
--- a/src/runtime/symtab.go
+++ b/src/runtime/symtab.go
@@ -118,11 +118,16 @@ func (ci *Frames) Next() (frame Frame, more bool) {
                }
                f := funcInfo._Func()
                entry := f.Entry()
+               // We store the pc of the start of the instruction following
+               // the instruction in question (the call or the inline mark).
+               // This is done for historical reasons, and to make FuncForPC
+               // work correctly for entries in the result of runtime.Callers.
+               // Decrement to get back to the instruction we care about.
+               //
+               // It is not possible to get pc == entry from runtime.Callers,
+               // but if the caller does provide one, provide best-effort
+               // results by avoiding backing out of the function entirely.
                if pc > entry {
-                       // We store the pc of the start of the instruction following
-                       // the instruction in question (the call or the inline mark).
-                       // This is done for historical reasons, and to make FuncForPC
-                       // work correctly for entries in the result of runtime.Callers.
                        pc--
                }
                // It's important that interpret pc non-strictly as cgoTraceback may