1
0
mirror of https://github.com/golang/go synced 2024-11-06 05:36:13 -07:00

runtime: document when cgo traceback function is called

Fixes #24518.

Change-Id: I99c79c5a2ab9dbe7f0d257c263da9d2b5d1d55c4
Reviewed-on: https://go-review.googlesource.com/121917
Reviewed-by: Ian Lance Taylor <iant@golang.org>
This commit is contained in:
Nikhil Benesch 2018-07-02 11:29:11 -04:00 committed by Ian Lance Taylor
parent 33f6b08ffe
commit 0e0cd70ecf

View File

@ -1115,6 +1115,13 @@ func isSystemGoroutine(gp *g) bool {
// to the symbolizer function, return the file/line of the call
// instruction. No additional subtraction is required or appropriate.
//
// On all platforms, the traceback function is invoked when a call from
// Go to C to Go requests a stack trace. On linux/amd64, linux/ppc64le,
// and freebsd/amd64, the traceback function is also invoked when a
// signal is received by a thread that is executing a cgo call. The
// traceback function should not make assumptions about when it is
// called, as future versions of Go may make additional calls.
//
// The symbolizer function will be called with a single argument, a
// pointer to a struct:
//