From: Ian Lance Taylor <iant@golang.org>
Date: Wed, 7 Apr 2021 22:22:53 +0000 (-0700)
Subject: runtime/cgo: clarify Handle documentation
X-Git-Tag: go1.17beta1~766
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=7e583806d8135a59866ff329cc19a0bc4425aa80;p=gostls13.git

runtime/cgo: clarify Handle documentation

Fixes #45427

Change-Id: Ic67630a5f39d8789a4a30c6b4ee30946bc50382e
Reviewed-on: https://go-review.googlesource.com/c/go/+/308230
Trust: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Ainar Garipov <gugl.zadolbal@gmail.com>
Reviewed-by: Changkun Ou <euryugasaki@gmail.com>
Reviewed-by: Emmanuel Odeke <emmanuel@orijtech.com>
---

diff --git a/src/runtime/cgo/handle.go b/src/runtime/cgo/handle.go
index a798ba9064..720acca802 100644
--- a/src/runtime/cgo/handle.go
+++ b/src/runtime/cgo/handle.go
@@ -9,50 +9,56 @@ import (
 	"sync/atomic"
 )
 
-// Handle provides a safe representation of Go values to pass between
-// Go and C. The zero value of a handle is not a valid handle, and thus
-// is safe to use as a sentinel in C APIs.
+// Handle provides a way to pass values that contain Go pointers
+// (pointers to memory allocated by Go) between Go and C without
+// breaking the cgo pointer passing rules. A Handle is an integer
+// value that can represent any Go value. A Handle can be passed
+// through C and back to Go, and Go code can use the Handle to
+// retrieve the original Go value.
 //
 // The underlying type of Handle is guaranteed to fit in an integer type
-// that is large enough to hold the bit pattern of any pointer.
+// that is large enough to hold the bit pattern of any pointer. The zero
+// value of a Handle is not valid, and thus is safe to use as a sentinel
+// in C APIs.
+//
 // For instance, on the Go side:
 //
-// 	package main
+//	package main
 //
-// 	/*
-// 	#include <stdint.h> // for uintptr_t
+//	/*
+//	#include <stdint.h> // for uintptr_t
 //
-// 	extern void MyGoPrint(uintptr_t handle);
-// 	void myprint(uintptr_t handle);
-// 	*/
-// 	import "C"
-// 	import "runtime/cgo"
+//	extern void MyGoPrint(uintptr_t handle);
+//	void myprint(uintptr_t handle);
+//	*/
+//	import "C"
+//	import "runtime/cgo"
 //
-// 	//export MyGoPrint
-// 	func MyGoPrint(handle C.uintptr_t) {
-// 		h := cgo.Handle(handle)
-// 		val := h.Value().(int)
-// 		println(val)
-// 		h.Delete()
-// 	}
+//	//export MyGoPrint
+//	func MyGoPrint(handle C.uintptr_t) {
+//		h := cgo.Handle(handle)
+//		val := h.Value().(string)
+//		println(val)
+//		h.Delete()
+//	}
 //
-// 	func main() {
-// 		val := 42
-// 		C.myprint(C.uintptr_t(cgo.NewHandle(val)))
-// 		// Output: 42
-// 	}
+//	func main() {
+//		val := "hello Go"
+//		C.myprint(C.uintptr_t(cgo.NewHandle(val)))
+//		// Output: hello Go
+//	}
 //
 // and on the C side:
 //
-// 	#include <stdint.h> // for uintptr_t
+//	#include <stdint.h> // for uintptr_t
 //
-// 	// A Go function
-// 	extern void MyGoPrint(uintptr_t handle);
+//	// A Go function
+//	extern void MyGoPrint(uintptr_t handle);
 //
-// 	// A C function
-// 	void myprint(uintptr_t handle) {
-// 	    MyGoPrint(handle);
-// 	}
+//	// A C function
+//	void myprint(uintptr_t handle) {
+//	    MyGoPrint(handle);
+//	}
 type Handle uintptr
 
 // NewHandle returns a handle for a given value.