add comment for goid.s

phuslu · Apr 22, 2024 · d1969fb · d1969fb
1 parent 8590a45
commit d1969fb
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/goid.s b/goid.s
@@ -1,5 +1,15 @@
 #include "textflag.h"
 
+// After go1.9, goid in "goroutine struct" has a stable offset.
+// See https://github.com/golang/go/blob/master/src/runtime/runtime2.go#L436
+//
+// This file exposes "goid()" function by
+//   1. get current "g" pointer,
+//   2. extract goid with a hardcoded offset.
+//      *) for GOARCH amd64/arm64, offset=152, size=8.
+//      *) for GOARCH arm/386, offset=80, size=4.
+//
+
 #ifdef GOARCH_amd64
 TEXT ·goid(SB),NOSPLIT,$0-8
 	MOVQ (TLS), R14