]> Cypherpunks repositories - gostls13.git/commitdiff
doc: document runtimecontentionstacks
authorMichael Pratt <mpratt@google.com>
Mon, 4 Dec 2023 20:43:41 +0000 (15:43 -0500)
committerGopher Robot <gobot@golang.org>
Wed, 6 Dec 2023 21:50:28 +0000 (21:50 +0000)
For #57071.

Change-Id: Ic1645af57aa589917c67154a5e4ad0b4edd7ba90
Reviewed-on: https://go-review.googlesource.com/c/go/+/547058
Reviewed-by: Michael Knyszek <mknyszek@google.com>
Reviewed-by: Rhys Hiltner <rhys@justin.tv>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Michael Pratt <mpratt@google.com>

doc/godebug.md

index f7baea30b2d516af4e0ea2fc999545f72d7f63dd..9710940118701c9b89d139784462b052053aff43 100644 (file)
@@ -178,6 +178,13 @@ should adjust their Linux configuration according to the recommendations in the
 [GC guide](/doc/gc-guide#Linux_transparent_huge_pages), or switch to a Linux
 distribution that disables transparent huge pages altogether.
 
+Go 1.22 added contention on runtime-internal locks to the [`mutex`
+profile](/pkg/runtime/pprof#Profile). Contention on these locks is always
+reported at `runtime._LostContendedRuntimeLock`. Complete stack traces of
+runtime locks can be enabled with the [`runtimecontentionstacks`
+setting](/pkg/runtime#hdr-Environment_Variable). These stack traces have
+non-standard semantics, see setting documentation for details.
+
 ### Go 1.21
 
 Go 1.21 made it a run-time error to call `panic` with a nil interface value,