Skip to content

runtime: strongly encourage using CallersFrames over FuncForPC with Callers result #19426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
cespare opened this issue Mar 6, 2017 · 4 comments
Closed

runtime: strongly encourage using CallersFrames over FuncForPC with Callers result #19426

cespare opened this issue Mar 6, 2017 · 4 comments
Labels
FrozenDueToAge
Milestone
Go1.9

Comments

@cespare
Copy link
Contributor

cespare commented Mar 6, 2017

Go 1.7 introduced the CallersFrames API:

The new function CallersFrames translates a PC slice obtained from Callers into a sequence of frames corresponding to the call stack. This new API should be preferred instead of direct use of FuncForPC, because the frame sequence can more accurately describe call stacks with inlined function calls.

I understand that in Go 1.9, mid-stack inlining will make the results significantly worse for callers that are still using FuncForPC instead of CallersFrames. However, in the runtime documentation I don't see anything to steer the user towards one or the other.

Should we mark Func and FuncForPC as deprecated? Is there some situation to use them instead of CallersFrames?

@ianlancetaylor @aclements @davidlazar
@cespare cespare added this to the Go1.9 milestone Mar 6, 2017
@cespare
Copy link
Contributor Author

cespare commented Mar 6, 2017

(I guess that the Callers doc itself does say "To easily look up file/line information for the call sequence, use Frames.")

@aclements
Copy link
Member

Yes, the documentation should definitely steer people more strongly in the right direction than it does now. Thanks for creating an issue to track this.

@aclements aclements self-assigned this Mar 6, 2017
@gopherbot
Copy link
Contributor

CL https://golang.org/cl/37726 mentions this issue.

@ianlancetaylor
Copy link
Member

FuncForPC should not in general be used with values returned by Callers or Caller, but it is still meaningful and has no replacement for other uses. For example, the use in funcName and methodName in reflect/value.go is entirely legitimate.

@cespare cespare changed the title runtime: deprecate Func/FuncForPC runtime: strongly encourage using CallersFrames over FuncForPC with Callers result Mar 6, 2017
@akshayjshah akshayjshah mentioned this issue Mar 7, 2017
Closed
@alfred-landrum alfred-landrum mentioned this issue Mar 8, 2017
Closed
@shogo82148 shogo82148 mentioned this issue May 28, 2017
Closed
@achille-roussel achille-roussel mentioned this issue Aug 22, 2017
Merged
@mageddo mageddo mentioned this issue Oct 20, 2017
Closed
This was referenced Dec 23, 2017
Merged
Closed
@golang golang locked and limited conversation to collaborators Mar 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge
Projects
None yet
Milestone
Go1.9
Development

No branches or pull requests
4 participants
@cespare @aclements @ianlancetaylor @gopherbot