aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRuss Cox <rsc@golang.org>2016-10-20 22:22:25 -0400
committerRuss Cox <rsc@golang.org>2016-10-24 18:11:55 +0000
commit2a3db5c0175e26ba99adca90e5bab6cb4e85cc2d (patch)
treeeadfbc4ca53d7df020a362ab9ea8ed777b93c556
parenta6141ebd3f33c1f4330a0ce3507f686b7fd64489 (diff)
downloadgo-2a3db5c0175e26ba99adca90e5bab6cb4e85cc2d.tar.xz
cmd/cgo: document C.malloc behavior
Fixes #16309. Change-Id: Ifcd28b0746e1af30e2519a7b118485aecfb12396 Reviewed-on: https://go-review.googlesource.com/31811 Run-TryBot: Russ Cox <rsc@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Ian Lance Taylor <iant@golang.org>
-rw-r--r--src/cmd/cgo/doc.go7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/cmd/cgo/doc.go b/src/cmd/cgo/doc.go
index e6f9173aaf..e5d288167e 100644
--- a/src/cmd/cgo/doc.go
+++ b/src/cmd/cgo/doc.go
@@ -216,6 +216,13 @@ by making copies of the data. In pseudo-Go definitions:
// C data with explicit length to Go []byte
func C.GoBytes(unsafe.Pointer, C.int) []byte
+As a special case, C.malloc does not call the C library malloc directly
+but instead calls a Go helper function that wraps the C library malloc
+but guarantees never to return nil. If C's malloc indicates out of memory,
+the helper function crashes the program, like when Go itself runs out
+of memory. Because C.malloc cannot fail, it has no two-result form
+that returns errno.
+
C references to Go
Go functions can be exported for use by C code in the following way: