src/runtime/mklockrank.go

   1 // Copyright 2022 The Go Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style
   3 // license that can be found in the LICENSE file.
   4
   5 //go:build ignore
   6
   7 // mklockrank records the static rank graph of the locks in the
   8 // runtime and generates the rank checking structures in lockrank.go.
   9 package main
  10
  11 import (
  12         "bytes"
  13         "flag"
  14         "fmt"
  15         "go/format"
  16         "internal/dag"
  17         "io"
  18         "log"
  19         "os"
  20         "strings"
  21 )
  22
  23 // ranks describes the lock rank graph. See "go doc internal/dag" for
  24 // the syntax.
  25 //
  26 // "a < b" means a must be acquired before b if both are held
  27 // (or, if b is held, a cannot be acquired).
  28 //
  29 // "NONE < a" means no locks may be held when a is acquired.
  30 //
  31 // If a lock is not given a rank, then it is assumed to be a leaf
  32 // lock, which means no other lock can be acquired while it is held.
  33 // Therefore, leaf locks do not need to be given an explicit rank.
  34 //
  35 // Ranks in all caps are pseudo-nodes that help define order, but do
  36 // not actually define a rank.
  37 //
  38 // TODO: It's often hard to correlate rank names to locks. Change
  39 // these to be more consistent with the locks they label.
  40 const ranks = `
  41 # Sysmon
  42 NONE
  43 < sysmon
  44 < scavenge, forcegc;
  45
  46 # Defer
  47 NONE < defer;
  48
  49 # GC
  50 NONE <
  51   sweepWaiters,
  52   assistQueue,
  53   sweep;
  54
  55 # Scheduler, timers, netpoll
  56 NONE < pollDesc, cpuprof;
  57 assistQueue,
  58   cpuprof,
  59   forcegc,
  60   pollDesc, # pollDesc can interact with timers, which can lock sched.
  61   scavenge,
  62   sweep,
  63   sweepWaiters
  64 < sched;
  65 sched < allg, allp;
  66 allp < timers;
  67 timers < netpollInit;
  68
  69 # Channels
  70 scavenge, sweep < hchan;
  71 NONE < notifyList;
  72 hchan, notifyList < sudog;
  73
  74 # RWMutex
  75 NONE < rwmutexW;
  76 rwmutexW, sysmon < rwmutexR;
  77
  78 # Semaphores
  79 NONE < root;
  80
  81 # Itabs
  82 NONE
  83 < itab
  84 < reflectOffs;
  85
  86 # Tracing without a P uses a global trace buffer.
  87 scavenge
  88 # Above TRACEGLOBAL can emit a trace event without a P.
  89 < TRACEGLOBAL
  90 # Below TRACEGLOBAL manages the global tracing buffer.
  91 # Note that traceBuf eventually chains to MALLOC, but we never get that far
  92 # in the situation where there's no P.
  93 < traceBuf;
  94 # Starting/stopping tracing traces strings.
  95 traceBuf < traceStrings;
  96
  97 # Malloc
  98 allg,
  99   hchan,
 100   notifyList,
 101   reflectOffs,
 102   timers,
 103   traceStrings
 104 # Above MALLOC are things that can allocate memory.
 105 < MALLOC
 106 # Below MALLOC is the malloc implementation.
 107 < fin,
 108   gcBitsArenas,
 109   mheapSpecial,
 110   mspanSpecial,
 111   spanSetSpine,
 112   MPROF;
 113
 114 # Memory profiling
 115 MPROF < profInsert, profBlock, profMemActive;
 116 profMemActive < profMemFuture;
 117
 118 # Stack allocation and copying
 119 gcBitsArenas,
 120   netpollInit,
 121   profBlock,
 122   profInsert,
 123   profMemFuture,
 124   spanSetSpine,
 125   fin,
 126   root
 127 # Anything that can grow the stack can acquire STACKGROW.
 128 # (Most higher layers imply STACKGROW, like MALLOC.)
 129 < STACKGROW
 130 # Below STACKGROW is the stack allocator/copying implementation.
 131 < gscan;
 132 gscan, rwmutexR < stackpool;
 133 gscan < stackLarge;
 134 # Generally, hchan must be acquired before gscan. But in one case,
 135 # where we suspend a G and then shrink its stack, syncadjustsudogs
 136 # can acquire hchan locks while holding gscan. To allow this case,
 137 # we use hchanLeaf instead of hchan.
 138 gscan < hchanLeaf;
 139
 140 # Write barrier
 141 defer,
 142   gscan,
 143   mspanSpecial,
 144   sudog
 145 # Anything that can have write barriers can acquire WB.
 146 # Above WB, we can have write barriers.
 147 < WB
 148 # Below WB is the write barrier implementation.
 149 < wbufSpans;
 150
 151 # Span allocator
 152 stackLarge,
 153   stackpool,
 154   wbufSpans
 155 # Above mheap is anything that can call the span allocator.
 156 < mheap;
 157 # Below mheap is the span allocator implementation.
 158 mheap, mheapSpecial < globalAlloc;
 159
 160 # Execution tracer events (with a P)
 161 hchan,
 162   root,
 163   sched,
 164   traceStrings,
 165   notifyList,
 166   fin
 167 # Above TRACE is anything that can create a trace event
 168 < TRACE
 169 < trace
 170 < traceStackTab;
 171
 172 # panic is handled specially. It is implicitly below all other locks.
 173 NONE < panic;
 174 # deadlock is not acquired while holding panic, but it also needs to be
 175 # below all other locks.
 176 panic < deadlock;
 177 `
 178
 179 // cyclicRanks lists lock ranks that allow multiple locks of the same
 180 // rank to be acquired simultaneously. The runtime enforces ordering
 181 // within these ranks using a separate mechanism.
 182 var cyclicRanks = map[string]bool{
 183         // Multiple timers are locked simultaneously in destroy().
 184         "timers": true,
 185         // Multiple hchans are acquired in hchan.sortkey() order in
 186         // select.
 187         "hchan": true,
 188         // Multiple hchanLeafs are acquired in hchan.sortkey() order in
 189         // syncadjustsudogs().
 190         "hchanLeaf": true,
 191         // The point of the deadlock lock is to deadlock.
 192         "deadlock": true,
 193 }
 194
 195 func main() {
 196         flagO := flag.String("o", "", "write to `file` instead of stdout")
 197         flagDot := flag.Bool("dot", false, "emit graphviz output instead of Go")
 198         flag.Parse()
 199         if flag.NArg() != 0 {
 200                 fmt.Fprintf(os.Stderr, "too many arguments")
 201                 os.Exit(2)
 202         }
 203
 204         g, err := dag.Parse(ranks)
 205         if err != nil {
 206                 log.Fatal(err)
 207         }
 208
 209         var out []byte
 210         if *flagDot {
 211                 var b bytes.Buffer
 212                 g.TransitiveReduction()
 213                 // Add cyclic edges for visualization.
 214                 for k := range cyclicRanks {
 215                         g.AddEdge(k, k)
 216                 }
 217                 // Reverse the graph. It's much easier to read this as
 218                 // a "<" partial order than a ">" partial order. This
 219                 // ways, locks are acquired from the top going down
 220                 // and time moves forward over the edges instead of
 221                 // backward.
 222                 g.Transpose()
 223                 generateDot(&b, g)
 224                 out = b.Bytes()
 225         } else {
 226                 var b bytes.Buffer
 227                 generateGo(&b, g)
 228                 out, err = format.Source(b.Bytes())
 229                 if err != nil {
 230                         log.Fatal(err)
 231                 }
 232         }
 233
 234         if *flagO != "" {
 235                 err = os.WriteFile(*flagO, out, 0666)
 236         } else {
 237                 _, err = os.Stdout.Write(out)
 238         }
 239         if err != nil {
 240                 log.Fatal(err)
 241         }
 242 }
 243
 244 func generateGo(w io.Writer, g *dag.Graph) {
 245         fmt.Fprintf(w, `// Code generated by mklockrank.go; DO NOT EDIT.
 246
 247 package runtime
 248
 249 type lockRank int
 250
 251 `)
 252
 253         // Create numeric ranks.
 254         topo := g.Topo()
 255         for i, j := 0, len(topo)-1; i < j; i, j = i+1, j-1 {
 256                 topo[i], topo[j] = topo[j], topo[i]
 257         }
 258         fmt.Fprintf(w, `
 259 // Constants representing the ranks of all non-leaf runtime locks, in rank order.
 260 // Locks with lower rank must be taken before locks with higher rank,
 261 // in addition to satisfying the partial order in lockPartialOrder.
 262 // A few ranks allow self-cycles, which are specified in lockPartialOrder.
 263 const (
 264         lockRankUnknown lockRank = iota
 265
 266 `)
 267         for _, rank := range topo {
 268                 if isPseudo(rank) {
 269                         fmt.Fprintf(w, "\t// %s\n", rank)
 270                 } else {
 271                         fmt.Fprintf(w, "\t%s\n", cname(rank))
 272                 }
 273         }
 274         fmt.Fprintf(w, `)
 275
 276 // lockRankLeafRank is the rank of lock that does not have a declared rank,
 277 // and hence is a leaf lock.
 278 const lockRankLeafRank lockRank = 1000
 279 `)
 280
 281         // Create string table.
 282         fmt.Fprintf(w, `
 283 // lockNames gives the names associated with each of the above ranks.
 284 var lockNames = []string{
 285 `)
 286         for _, rank := range topo {
 287                 if !isPseudo(rank) {
 288                         fmt.Fprintf(w, "\t%s: %q,\n", cname(rank), rank)
 289                 }
 290         }
 291         fmt.Fprintf(w, `}
 292
 293 func (rank lockRank) String() string {
 294         if rank == 0 {
 295                 return "UNKNOWN"
 296         }
 297         if rank == lockRankLeafRank {
 298                 return "LEAF"
 299         }
 300         if rank < 0 || int(rank) >= len(lockNames) {
 301                 return "BAD RANK"
 302         }
 303         return lockNames[rank]
 304 }
 305 `)
 306
 307         // Create partial order structure.
 308         fmt.Fprintf(w, `
 309 // lockPartialOrder is the transitive closure of the lock rank graph.
 310 // An entry for rank X lists all of the ranks that can already be held
 311 // when rank X is acquired.
 312 //
 313 // Lock ranks that allow self-cycles list themselves.
 314 var lockPartialOrder [][]lockRank = [][]lockRank{
 315 `)
 316         for _, rank := range topo {
 317                 if isPseudo(rank) {
 318                         continue
 319                 }
 320                 list := []string{}
 321                 for _, before := range g.Edges(rank) {
 322                         if !isPseudo(before) {
 323                                 list = append(list, cname(before))
 324                         }
 325                 }
 326                 if cyclicRanks[rank] {
 327                         list = append(list, cname(rank))
 328                 }
 329
 330                 fmt.Fprintf(w, "\t%s: {%s},\n", cname(rank), strings.Join(list, ", "))
 331         }
 332         fmt.Fprintf(w, "}\n")
 333 }
 334
 335 // cname returns the Go const name for the given lock rank label.
 336 func cname(label string) string {
 337         return "lockRank" + strings.ToUpper(label[:1]) + label[1:]
 338 }
 339
 340 func isPseudo(label string) bool {
 341         return strings.ToUpper(label) == label
 342 }
 343
 344 // generateDot emits a Graphviz dot representation of g to w.
 345 func generateDot(w io.Writer, g *dag.Graph) {
 346         fmt.Fprintf(w, "digraph g {\n")
 347
 348         // Define all nodes.
 349         for _, node := range g.Nodes {
 350                 fmt.Fprintf(w, "%q;\n", node)
 351         }
 352
 353         // Create edges.
 354         for _, node := range g.Nodes {
 355                 for _, to := range g.Edges(node) {
 356                         fmt.Fprintf(w, "%q -> %q;\n", node, to)
 357                 }
 358         }
 359
 360         fmt.Fprintf(w, "}\n")
 361 }