Source file src/runtime/runtime2.go

     1  // Copyright 2009 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  package runtime
     6  
     7  import (
     8  	"internal/abi"
     9  	"internal/chacha8rand"
    10  	"internal/goarch"
    11  	"internal/runtime/atomic"
    12  	"internal/runtime/sys"
    13  	"unsafe"
    14  )
    15  
    16  // defined constants
    17  const (
    18  	// G status
    19  	//
    20  	// Beyond indicating the general state of a G, the G status
    21  	// acts like a lock on the goroutine's stack (and hence its
    22  	// ability to execute user code).
    23  	//
    24  	// If you add to this list, add to the list
    25  	// of "okay during garbage collection" status
    26  	// in mgcmark.go too.
    27  	//
    28  	// TODO(austin): The _Gscan bit could be much lighter-weight.
    29  	// For example, we could choose not to run _Gscanrunnable
    30  	// goroutines found in the run queue, rather than CAS-looping
    31  	// until they become _Grunnable. And transitions like
    32  	// _Gscanwaiting -> _Gscanrunnable are actually okay because
    33  	// they don't affect stack ownership.
    34  
    35  	// _Gidle means this goroutine was just allocated and has not
    36  	// yet been initialized.
    37  	_Gidle = iota // 0
    38  
    39  	// _Grunnable means this goroutine is on a run queue. It is
    40  	// not currently executing user code. The stack is not owned.
    41  	_Grunnable // 1
    42  
    43  	// _Grunning means this goroutine may execute user code. The
    44  	// stack is owned by this goroutine. It is not on a run queue.
    45  	// It is assigned an M and a P (g.m and g.m.p are valid).
    46  	_Grunning // 2
    47  
    48  	// _Gsyscall means this goroutine is executing a system call.
    49  	// It is not executing user code. The stack is owned by this
    50  	// goroutine. It is not on a run queue. It is assigned an M.
    51  	_Gsyscall // 3
    52  
    53  	// _Gwaiting means this goroutine is blocked in the runtime.
    54  	// It is not executing user code. It is not on a run queue,
    55  	// but should be recorded somewhere (e.g., a channel wait
    56  	// queue) so it can be ready()d when necessary. The stack is
    57  	// not owned *except* that a channel operation may read or
    58  	// write parts of the stack under the appropriate channel
    59  	// lock. Otherwise, it is not safe to access the stack after a
    60  	// goroutine enters _Gwaiting (e.g., it may get moved).
    61  	_Gwaiting // 4
    62  
    63  	// _Gmoribund_unused is currently unused, but hardcoded in gdb
    64  	// scripts.
    65  	_Gmoribund_unused // 5
    66  
    67  	// _Gdead means this goroutine is currently unused. It may be
    68  	// just exited, on a free list, or just being initialized. It
    69  	// is not executing user code. It may or may not have a stack
    70  	// allocated. The G and its stack (if any) are owned by the M
    71  	// that is exiting the G or that obtained the G from the free
    72  	// list.
    73  	_Gdead // 6
    74  
    75  	// _Genqueue_unused is currently unused.
    76  	_Genqueue_unused // 7
    77  
    78  	// _Gcopystack means this goroutine's stack is being moved. It
    79  	// is not executing user code and is not on a run queue. The
    80  	// stack is owned by the goroutine that put it in _Gcopystack.
    81  	_Gcopystack // 8
    82  
    83  	// _Gpreempted means this goroutine stopped itself for a
    84  	// suspendG preemption. It is like _Gwaiting, but nothing is
    85  	// yet responsible for ready()ing it. Some suspendG must CAS
    86  	// the status to _Gwaiting to take responsibility for
    87  	// ready()ing this G.
    88  	_Gpreempted // 9
    89  
    90  	// _Gscan combined with one of the above states other than
    91  	// _Grunning indicates that GC is scanning the stack. The
    92  	// goroutine is not executing user code and the stack is owned
    93  	// by the goroutine that set the _Gscan bit.
    94  	//
    95  	// _Gscanrunning is different: it is used to briefly block
    96  	// state transitions while GC signals the G to scan its own
    97  	// stack. This is otherwise like _Grunning.
    98  	//
    99  	// atomicstatus&~Gscan gives the state the goroutine will
   100  	// return to when the scan completes.
   101  	_Gscan          = 0x1000
   102  	_Gscanrunnable  = _Gscan + _Grunnable  // 0x1001
   103  	_Gscanrunning   = _Gscan + _Grunning   // 0x1002
   104  	_Gscansyscall   = _Gscan + _Gsyscall   // 0x1003
   105  	_Gscanwaiting   = _Gscan + _Gwaiting   // 0x1004
   106  	_Gscanpreempted = _Gscan + _Gpreempted // 0x1009
   107  )
   108  
   109  const (
   110  	// P status
   111  
   112  	// _Pidle means a P is not being used to run user code or the
   113  	// scheduler. Typically, it's on the idle P list and available
   114  	// to the scheduler, but it may just be transitioning between
   115  	// other states.
   116  	//
   117  	// The P is owned by the idle list or by whatever is
   118  	// transitioning its state. Its run queue is empty.
   119  	_Pidle = iota
   120  
   121  	// _Prunning means a P is owned by an M and is being used to
   122  	// run user code or the scheduler. Only the M that owns this P
   123  	// is allowed to change the P's status from _Prunning. The M
   124  	// may transition the P to _Pidle (if it has no more work to
   125  	// do), _Psyscall (when entering a syscall), or _Pgcstop (to
   126  	// halt for the GC). The M may also hand ownership of the P
   127  	// off directly to another M (e.g., to schedule a locked G).
   128  	_Prunning
   129  
   130  	// _Psyscall means a P is not running user code. It has
   131  	// affinity to an M in a syscall but is not owned by it and
   132  	// may be stolen by another M. This is similar to _Pidle but
   133  	// uses lightweight transitions and maintains M affinity.
   134  	//
   135  	// Leaving _Psyscall must be done with a CAS, either to steal
   136  	// or retake the P. Note that there's an ABA hazard: even if
   137  	// an M successfully CASes its original P back to _Prunning
   138  	// after a syscall, it must understand the P may have been
   139  	// used by another M in the interim.
   140  	_Psyscall
   141  
   142  	// _Pgcstop means a P is halted for STW and owned by the M
   143  	// that stopped the world. The M that stopped the world
   144  	// continues to use its P, even in _Pgcstop. Transitioning
   145  	// from _Prunning to _Pgcstop causes an M to release its P and
   146  	// park.
   147  	//
   148  	// The P retains its run queue and startTheWorld will restart
   149  	// the scheduler on Ps with non-empty run queues.
   150  	_Pgcstop
   151  
   152  	// _Pdead means a P is no longer used (GOMAXPROCS shrank). We
   153  	// reuse Ps if GOMAXPROCS increases. A dead P is mostly
   154  	// stripped of its resources, though a few things remain
   155  	// (e.g., trace buffers).
   156  	_Pdead
   157  )
   158  
   159  // Mutual exclusion locks.  In the uncontended case,
   160  // as fast as spin locks (just a few user-level instructions),
   161  // but on the contention path they sleep in the kernel.
   162  // A zeroed Mutex is unlocked (no need to initialize each lock).
   163  // Initialization is helpful for static lock ranking, but not required.
   164  type mutex struct {
   165  	// Empty struct if lock ranking is disabled, otherwise includes the lock rank
   166  	lockRankStruct
   167  	// Futex-based impl treats it as uint32 key,
   168  	// while sema-based impl as M* waitm.
   169  	// Used to be a union, but unions break precise GC.
   170  	key uintptr
   171  }
   172  
   173  type funcval struct {
   174  	fn uintptr
   175  	// variable-size, fn-specific data here
   176  }
   177  
   178  type iface struct {
   179  	tab  *itab
   180  	data unsafe.Pointer
   181  }
   182  
   183  type eface struct {
   184  	_type *_type
   185  	data  unsafe.Pointer
   186  }
   187  
   188  func efaceOf(ep *any) *eface {
   189  	return (*eface)(unsafe.Pointer(ep))
   190  }
   191  
   192  // The guintptr, muintptr, and puintptr are all used to bypass write barriers.
   193  // It is particularly important to avoid write barriers when the current P has
   194  // been released, because the GC thinks the world is stopped, and an
   195  // unexpected write barrier would not be synchronized with the GC,
   196  // which can lead to a half-executed write barrier that has marked the object
   197  // but not queued it. If the GC skips the object and completes before the
   198  // queuing can occur, it will incorrectly free the object.
   199  //
   200  // We tried using special assignment functions invoked only when not
   201  // holding a running P, but then some updates to a particular memory
   202  // word went through write barriers and some did not. This breaks the
   203  // write barrier shadow checking mode, and it is also scary: better to have
   204  // a word that is completely ignored by the GC than to have one for which
   205  // only a few updates are ignored.
   206  //
   207  // Gs and Ps are always reachable via true pointers in the
   208  // allgs and allp lists or (during allocation before they reach those lists)
   209  // from stack variables.
   210  //
   211  // Ms are always reachable via true pointers either from allm or
   212  // freem. Unlike Gs and Ps we do free Ms, so it's important that
   213  // nothing ever hold an muintptr across a safe point.
   214  
   215  // A guintptr holds a goroutine pointer, but typed as a uintptr
   216  // to bypass write barriers. It is used in the Gobuf goroutine state
   217  // and in scheduling lists that are manipulated without a P.
   218  //
   219  // The Gobuf.g goroutine pointer is almost always updated by assembly code.
   220  // In one of the few places it is updated by Go code - func save - it must be
   221  // treated as a uintptr to avoid a write barrier being emitted at a bad time.
   222  // Instead of figuring out how to emit the write barriers missing in the
   223  // assembly manipulation, we change the type of the field to uintptr,
   224  // so that it does not require write barriers at all.
   225  //
   226  // Goroutine structs are published in the allg list and never freed.
   227  // That will keep the goroutine structs from being collected.
   228  // There is never a time that Gobuf.g's contain the only references
   229  // to a goroutine: the publishing of the goroutine in allg comes first.
   230  // Goroutine pointers are also kept in non-GC-visible places like TLS,
   231  // so I can't see them ever moving. If we did want to start moving data
   232  // in the GC, we'd need to allocate the goroutine structs from an
   233  // alternate arena. Using guintptr doesn't make that problem any worse.
   234  // Note that pollDesc.rg, pollDesc.wg also store g in uintptr form,
   235  // so they would need to be updated too if g's start moving.
   236  type guintptr uintptr
   237  
   238  //go:nosplit
   239  func (gp guintptr) ptr() *g { return (*g)(unsafe.Pointer(gp)) }
   240  
   241  //go:nosplit
   242  func (gp *guintptr) set(g *g) { *gp = guintptr(unsafe.Pointer(g)) }
   243  
   244  //go:nosplit
   245  func (gp *guintptr) cas(old, new guintptr) bool {
   246  	return atomic.Casuintptr((*uintptr)(unsafe.Pointer(gp)), uintptr(old), uintptr(new))
   247  }
   248  
   249  //go:nosplit
   250  func (gp *g) guintptr() guintptr {
   251  	return guintptr(unsafe.Pointer(gp))
   252  }
   253  
   254  // setGNoWB performs *gp = new without a write barrier.
   255  // For times when it's impractical to use a guintptr.
   256  //
   257  //go:nosplit
   258  //go:nowritebarrier
   259  func setGNoWB(gp **g, new *g) {
   260  	(*guintptr)(unsafe.Pointer(gp)).set(new)
   261  }
   262  
   263  type puintptr uintptr
   264  
   265  //go:nosplit
   266  func (pp puintptr) ptr() *p { return (*p)(unsafe.Pointer(pp)) }
   267  
   268  //go:nosplit
   269  func (pp *puintptr) set(p *p) { *pp = puintptr(unsafe.Pointer(p)) }
   270  
   271  // muintptr is a *m that is not tracked by the garbage collector.
   272  //
   273  // Because we do free Ms, there are some additional constrains on
   274  // muintptrs:
   275  //
   276  //  1. Never hold an muintptr locally across a safe point.
   277  //
   278  //  2. Any muintptr in the heap must be owned by the M itself so it can
   279  //     ensure it is not in use when the last true *m is released.
   280  type muintptr uintptr
   281  
   282  //go:nosplit
   283  func (mp muintptr) ptr() *m { return (*m)(unsafe.Pointer(mp)) }
   284  
   285  //go:nosplit
   286  func (mp *muintptr) set(m *m) { *mp = muintptr(unsafe.Pointer(m)) }
   287  
   288  // setMNoWB performs *mp = new without a write barrier.
   289  // For times when it's impractical to use an muintptr.
   290  //
   291  //go:nosplit
   292  //go:nowritebarrier
   293  func setMNoWB(mp **m, new *m) {
   294  	(*muintptr)(unsafe.Pointer(mp)).set(new)
   295  }
   296  
   297  type gobuf struct {
   298  	// The offsets of sp, pc, and g are known to (hard-coded in) libmach.
   299  	//
   300  	// ctxt is unusual with respect to GC: it may be a
   301  	// heap-allocated funcval, so GC needs to track it, but it
   302  	// needs to be set and cleared from assembly, where it's
   303  	// difficult to have write barriers. However, ctxt is really a
   304  	// saved, live register, and we only ever exchange it between
   305  	// the real register and the gobuf. Hence, we treat it as a
   306  	// root during stack scanning, which means assembly that saves
   307  	// and restores it doesn't need write barriers. It's still
   308  	// typed as a pointer so that any other writes from Go get
   309  	// write barriers.
   310  	sp   uintptr
   311  	pc   uintptr
   312  	g    guintptr
   313  	ctxt unsafe.Pointer
   314  	lr   uintptr
   315  	bp   uintptr // for framepointer-enabled architectures
   316  }
   317  
   318  // sudog (pseudo-g) represents a g in a wait list, such as for sending/receiving
   319  // on a channel.
   320  //
   321  // sudog is necessary because the g ↔ synchronization object relation
   322  // is many-to-many. A g can be on many wait lists, so there may be
   323  // many sudogs for one g; and many gs may be waiting on the same
   324  // synchronization object, so there may be many sudogs for one object.
   325  //
   326  // sudogs are allocated from a special pool. Use acquireSudog and
   327  // releaseSudog to allocate and free them.
   328  type sudog struct {
   329  	// The following fields are protected by the hchan.lock of the
   330  	// channel this sudog is blocking on. shrinkstack depends on
   331  	// this for sudogs involved in channel ops.
   332  
   333  	g *g
   334  
   335  	next *sudog
   336  	prev *sudog
   337  	elem unsafe.Pointer // data element (may point to stack)
   338  
   339  	// The following fields are never accessed concurrently.
   340  	// For channels, waitlink is only accessed by g.
   341  	// For semaphores, all fields (including the ones above)
   342  	// are only accessed when holding a semaRoot lock.
   343  
   344  	acquiretime int64
   345  	releasetime int64
   346  	ticket      uint32
   347  
   348  	// isSelect indicates g is participating in a select, so
   349  	// g.selectDone must be CAS'd to win the wake-up race.
   350  	isSelect bool
   351  
   352  	// success indicates whether communication over channel c
   353  	// succeeded. It is true if the goroutine was awoken because a
   354  	// value was delivered over channel c, and false if awoken
   355  	// because c was closed.
   356  	success bool
   357  
   358  	// waiters is a count of semaRoot waiting list other than head of list,
   359  	// clamped to a uint16 to fit in unused space.
   360  	// Only meaningful at the head of the list.
   361  	// (If we wanted to be overly clever, we could store a high 16 bits
   362  	// in the second entry in the list.)
   363  	waiters uint16
   364  
   365  	parent   *sudog // semaRoot binary tree
   366  	waitlink *sudog // g.waiting list or semaRoot
   367  	waittail *sudog // semaRoot
   368  	c        *hchan // channel
   369  }
   370  
   371  type libcall struct {
   372  	fn   uintptr
   373  	n    uintptr // number of parameters
   374  	args uintptr // parameters
   375  	r1   uintptr // return values
   376  	r2   uintptr
   377  	err  uintptr // error number
   378  }
   379  
   380  // Stack describes a Go execution stack.
   381  // The bounds of the stack are exactly [lo, hi),
   382  // with no implicit data structures on either side.
   383  type stack struct {
   384  	lo uintptr
   385  	hi uintptr
   386  }
   387  
   388  // heldLockInfo gives info on a held lock and the rank of that lock
   389  type heldLockInfo struct {
   390  	lockAddr uintptr
   391  	rank     lockRank
   392  }
   393  
   394  type g struct {
   395  	// Stack parameters.
   396  	// stack describes the actual stack memory: [stack.lo, stack.hi).
   397  	// stackguard0 is the stack pointer compared in the Go stack growth prologue.
   398  	// It is stack.lo+StackGuard normally, but can be StackPreempt to trigger a preemption.
   399  	// stackguard1 is the stack pointer compared in the //go:systemstack stack growth prologue.
   400  	// It is stack.lo+StackGuard on g0 and gsignal stacks.
   401  	// It is ~0 on other goroutine stacks, to trigger a call to morestackc (and crash).
   402  	stack       stack   // offset known to runtime/cgo
   403  	stackguard0 uintptr // offset known to liblink
   404  	stackguard1 uintptr // offset known to liblink
   405  
   406  	_panic    *_panic // innermost panic - offset known to liblink
   407  	_defer    *_defer // innermost defer
   408  	m         *m      // current m; offset known to arm liblink
   409  	sched     gobuf
   410  	syscallsp uintptr // if status==Gsyscall, syscallsp = sched.sp to use during gc
   411  	syscallpc uintptr // if status==Gsyscall, syscallpc = sched.pc to use during gc
   412  	syscallbp uintptr // if status==Gsyscall, syscallbp = sched.bp to use in fpTraceback
   413  	stktopsp  uintptr // expected sp at top of stack, to check in traceback
   414  	// param is a generic pointer parameter field used to pass
   415  	// values in particular contexts where other storage for the
   416  	// parameter would be difficult to find. It is currently used
   417  	// in four ways:
   418  	// 1. When a channel operation wakes up a blocked goroutine, it sets param to
   419  	//    point to the sudog of the completed blocking operation.
   420  	// 2. By gcAssistAlloc1 to signal back to its caller that the goroutine completed
   421  	//    the GC cycle. It is unsafe to do so in any other way, because the goroutine's
   422  	//    stack may have moved in the meantime.
   423  	// 3. By debugCallWrap to pass parameters to a new goroutine because allocating a
   424  	//    closure in the runtime is forbidden.
   425  	// 4. When a panic is recovered and control returns to the respective frame,
   426  	//    param may point to a savedOpenDeferState.
   427  	param        unsafe.Pointer
   428  	atomicstatus atomic.Uint32
   429  	stackLock    uint32 // sigprof/scang lock; TODO: fold in to atomicstatus
   430  	goid         uint64
   431  	schedlink    guintptr
   432  	waitsince    int64      // approx time when the g become blocked
   433  	waitreason   waitReason // if status==Gwaiting
   434  
   435  	preempt       bool // preemption signal, duplicates stackguard0 = stackpreempt
   436  	preemptStop   bool // transition to _Gpreempted on preemption; otherwise, just deschedule
   437  	preemptShrink bool // shrink stack at synchronous safe point
   438  
   439  	// asyncSafePoint is set if g is stopped at an asynchronous
   440  	// safe point. This means there are frames on the stack
   441  	// without precise pointer information.
   442  	asyncSafePoint bool
   443  
   444  	paniconfault bool // panic (instead of crash) on unexpected fault address
   445  	gcscandone   bool // g has scanned stack; protected by _Gscan bit in status
   446  	throwsplit   bool // must not split stack
   447  	// activeStackChans indicates that there are unlocked channels
   448  	// pointing into this goroutine's stack. If true, stack
   449  	// copying needs to acquire channel locks to protect these
   450  	// areas of the stack.
   451  	activeStackChans bool
   452  	// parkingOnChan indicates that the goroutine is about to
   453  	// park on a chansend or chanrecv. Used to signal an unsafe point
   454  	// for stack shrinking.
   455  	parkingOnChan atomic.Bool
   456  	// inMarkAssist indicates whether the goroutine is in mark assist.
   457  	// Used by the execution tracer.
   458  	inMarkAssist bool
   459  	coroexit     bool // argument to coroswitch_m
   460  
   461  	raceignore      int8  // ignore race detection events
   462  	nocgocallback   bool  // whether disable callback from C
   463  	tracking        bool  // whether we're tracking this G for sched latency statistics
   464  	trackingSeq     uint8 // used to decide whether to track this G
   465  	trackingStamp   int64 // timestamp of when the G last started being tracked
   466  	runnableTime    int64 // the amount of time spent runnable, cleared when running, only used when tracking
   467  	lockedm         muintptr
   468  	fipsIndicator   uint8
   469  	syncSafePoint   bool // set if g is stopped at a synchronous safe point.
   470  	runningCleanups atomic.Bool
   471  	sig             uint32
   472  	writebuf        []byte
   473  	sigcode0        uintptr
   474  	sigcode1        uintptr
   475  	sigpc           uintptr
   476  	parentGoid      uint64          // goid of goroutine that created this goroutine
   477  	gopc            uintptr         // pc of go statement that created this goroutine
   478  	ancestors       *[]ancestorInfo // ancestor information goroutine(s) that created this goroutine (only used if debug.tracebackancestors)
   479  	startpc         uintptr         // pc of goroutine function
   480  	racectx         uintptr
   481  	waiting         *sudog         // sudog structures this g is waiting on (that have a valid elem ptr); in lock order
   482  	cgoCtxt         []uintptr      // cgo traceback context
   483  	labels          unsafe.Pointer // profiler labels
   484  	timer           *timer         // cached timer for time.Sleep
   485  	sleepWhen       int64          // when to sleep until
   486  	selectDone      atomic.Uint32  // are we participating in a select and did someone win the race?
   487  
   488  	// goroutineProfiled indicates the status of this goroutine's stack for the
   489  	// current in-progress goroutine profile
   490  	goroutineProfiled goroutineProfileStateHolder
   491  
   492  	coroarg *coro // argument during coroutine transfers
   493  	bubble  *synctestBubble
   494  
   495  	// Per-G tracer state.
   496  	trace gTraceState
   497  
   498  	// Per-G GC state
   499  
   500  	// gcAssistBytes is this G's GC assist credit in terms of
   501  	// bytes allocated. If this is positive, then the G has credit
   502  	// to allocate gcAssistBytes bytes without assisting. If this
   503  	// is negative, then the G must correct this by performing
   504  	// scan work. We track this in bytes to make it fast to update
   505  	// and check for debt in the malloc hot path. The assist ratio
   506  	// determines how this corresponds to scan work debt.
   507  	gcAssistBytes int64
   508  
   509  	// valgrindStackID is used to track what memory is used for stacks when a program is
   510  	// built with the "valgrind" build tag, otherwise it is unused.
   511  	valgrindStackID uintptr
   512  }
   513  
   514  // gTrackingPeriod is the number of transitions out of _Grunning between
   515  // latency tracking runs.
   516  const gTrackingPeriod = 8
   517  
   518  const (
   519  	// tlsSlots is the number of pointer-sized slots reserved for TLS on some platforms,
   520  	// like Windows.
   521  	tlsSlots = 6
   522  	tlsSize  = tlsSlots * goarch.PtrSize
   523  )
   524  
   525  // Values for m.freeWait.
   526  const (
   527  	freeMStack = 0 // M done, free stack and reference.
   528  	freeMRef   = 1 // M done, free reference.
   529  	freeMWait  = 2 // M still in use.
   530  )
   531  
   532  type m struct {
   533  	g0      *g     // goroutine with scheduling stack
   534  	morebuf gobuf  // gobuf arg to morestack
   535  	divmod  uint32 // div/mod denominator for arm - known to liblink (cmd/internal/obj/arm/obj5.go)
   536  
   537  	// Fields not known to debuggers.
   538  	procid          uint64            // for debuggers, but offset not hard-coded
   539  	gsignal         *g                // signal-handling g
   540  	goSigStack      gsignalStack      // Go-allocated signal handling stack
   541  	sigmask         sigset            // storage for saved signal mask
   542  	tls             [tlsSlots]uintptr // thread-local storage (for x86 extern register)
   543  	mstartfn        func()
   544  	curg            *g       // current running goroutine
   545  	caughtsig       guintptr // goroutine running during fatal signal
   546  	p               puintptr // attached p for executing go code (nil if not executing go code)
   547  	nextp           puintptr
   548  	oldp            puintptr // the p that was attached before executing a syscall
   549  	id              int64
   550  	mallocing       int32
   551  	throwing        throwType
   552  	preemptoff      string // if != "", keep curg running on this m
   553  	locks           int32
   554  	dying           int32
   555  	profilehz       int32
   556  	spinning        bool // m is out of work and is actively looking for work
   557  	blocked         bool // m is blocked on a note
   558  	newSigstack     bool // minit on C thread called sigaltstack
   559  	printlock       int8
   560  	incgo           bool          // m is executing a cgo call
   561  	isextra         bool          // m is an extra m
   562  	isExtraInC      bool          // m is an extra m that does not have any Go frames
   563  	isExtraInSig    bool          // m is an extra m in a signal handler
   564  	freeWait        atomic.Uint32 // Whether it is safe to free g0 and delete m (one of freeMRef, freeMStack, freeMWait)
   565  	needextram      bool
   566  	g0StackAccurate bool // whether the g0 stack has accurate bounds
   567  	traceback       uint8
   568  	allpSnapshot    []*p          // Snapshot of allp for use after dropping P in findRunnable, nil otherwise.
   569  	ncgocall        uint64        // number of cgo calls in total
   570  	ncgo            int32         // number of cgo calls currently in progress
   571  	cgoCallersUse   atomic.Uint32 // if non-zero, cgoCallers in use temporarily
   572  	cgoCallers      *cgoCallers   // cgo traceback if crashing in cgo call
   573  	park            note
   574  	alllink         *m // on allm
   575  	schedlink       muintptr
   576  	lockedg         guintptr
   577  	createstack     [32]uintptr // stack that created this thread, it's used for StackRecord.Stack0, so it must align with it.
   578  	lockedExt       uint32      // tracking for external LockOSThread
   579  	lockedInt       uint32      // tracking for internal lockOSThread
   580  	mWaitList       mWaitList   // list of runtime lock waiters
   581  
   582  	mLockProfile mLockProfile // fields relating to runtime.lock contention
   583  	profStack    []uintptr    // used for memory/block/mutex stack traces
   584  
   585  	// wait* are used to carry arguments from gopark into park_m, because
   586  	// there's no stack to put them on. That is their sole purpose.
   587  	waitunlockf          func(*g, unsafe.Pointer) bool
   588  	waitlock             unsafe.Pointer
   589  	waitTraceSkip        int
   590  	waitTraceBlockReason traceBlockReason
   591  
   592  	syscalltick uint32
   593  	freelink    *m // on sched.freem
   594  	trace       mTraceState
   595  
   596  	// these are here because they are too large to be on the stack
   597  	// of low-level NOSPLIT functions.
   598  	libcall    libcall
   599  	libcallpc  uintptr // for cpu profiler
   600  	libcallsp  uintptr
   601  	libcallg   guintptr
   602  	winsyscall winlibcall // stores syscall parameters on windows
   603  
   604  	vdsoSP uintptr // SP for traceback while in VDSO call (0 if not in call)
   605  	vdsoPC uintptr // PC for traceback while in VDSO call
   606  
   607  	// preemptGen counts the number of completed preemption
   608  	// signals. This is used to detect when a preemption is
   609  	// requested, but fails.
   610  	preemptGen atomic.Uint32
   611  
   612  	// Whether this is a pending preemption signal on this M.
   613  	signalPending atomic.Uint32
   614  
   615  	// pcvalue lookup cache
   616  	pcvalueCache pcvalueCache
   617  
   618  	dlogPerM
   619  
   620  	mOS
   621  
   622  	chacha8   chacha8rand.State
   623  	cheaprand uint64
   624  
   625  	// Up to 10 locks held by this m, maintained by the lock ranking code.
   626  	locksHeldLen int
   627  	locksHeld    [10]heldLockInfo
   628  }
   629  
   630  const mRedZoneSize = (16 << 3) * asanenabledBit // redZoneSize(2048)
   631  
   632  type mPadded struct {
   633  	m
   634  
   635  	// Size the runtime.m structure so it fits in the 2048-byte size class, and
   636  	// not in the next-smallest (1792-byte) size class. That leaves the 11 low
   637  	// bits of muintptr values available for flags, as required by
   638  	// lock_spinbit.go.
   639  	_ [(1 - goarch.IsWasm) * (2048 - mallocHeaderSize - mRedZoneSize - unsafe.Sizeof(m{}))]byte
   640  }
   641  
   642  type p struct {
   643  	id          int32
   644  	status      uint32 // one of pidle/prunning/...
   645  	link        puintptr
   646  	schedtick   uint32     // incremented on every scheduler call
   647  	syscalltick uint32     // incremented on every system call
   648  	sysmontick  sysmontick // last tick observed by sysmon
   649  	m           muintptr   // back-link to associated m (nil if idle)
   650  	mcache      *mcache
   651  	pcache      pageCache
   652  	raceprocctx uintptr
   653  
   654  	deferpool    []*_defer // pool of available defer structs (see panic.go)
   655  	deferpoolbuf [32]*_defer
   656  
   657  	// Cache of goroutine ids, amortizes accesses to runtime·sched.goidgen.
   658  	goidcache    uint64
   659  	goidcacheend uint64
   660  
   661  	// Queue of runnable goroutines. Accessed without lock.
   662  	runqhead uint32
   663  	runqtail uint32
   664  	runq     [256]guintptr
   665  	// runnext, if non-nil, is a runnable G that was ready'd by
   666  	// the current G and should be run next instead of what's in
   667  	// runq if there's time remaining in the running G's time
   668  	// slice. It will inherit the time left in the current time
   669  	// slice. If a set of goroutines is locked in a
   670  	// communicate-and-wait pattern, this schedules that set as a
   671  	// unit and eliminates the (potentially large) scheduling
   672  	// latency that otherwise arises from adding the ready'd
   673  	// goroutines to the end of the run queue.
   674  	//
   675  	// Note that while other P's may atomically CAS this to zero,
   676  	// only the owner P can CAS it to a valid G.
   677  	runnext guintptr
   678  
   679  	// Available G's (status == Gdead)
   680  	gFree gList
   681  
   682  	sudogcache []*sudog
   683  	sudogbuf   [128]*sudog
   684  
   685  	// Cache of mspan objects from the heap.
   686  	mspancache struct {
   687  		// We need an explicit length here because this field is used
   688  		// in allocation codepaths where write barriers are not allowed,
   689  		// and eliminating the write barrier/keeping it eliminated from
   690  		// slice updates is tricky, more so than just managing the length
   691  		// ourselves.
   692  		len int
   693  		buf [128]*mspan
   694  	}
   695  
   696  	// Cache of a single pinner object to reduce allocations from repeated
   697  	// pinner creation.
   698  	pinnerCache *pinner
   699  
   700  	trace pTraceState
   701  
   702  	palloc persistentAlloc // per-P to avoid mutex
   703  
   704  	// Per-P GC state
   705  	gcAssistTime         int64 // Nanoseconds in assistAlloc
   706  	gcFractionalMarkTime int64 // Nanoseconds in fractional mark worker (atomic)
   707  
   708  	// limiterEvent tracks events for the GC CPU limiter.
   709  	limiterEvent limiterEvent
   710  
   711  	// gcMarkWorkerMode is the mode for the next mark worker to run in.
   712  	// That is, this is used to communicate with the worker goroutine
   713  	// selected for immediate execution by
   714  	// gcController.findRunnableGCWorker. When scheduling other goroutines,
   715  	// this field must be set to gcMarkWorkerNotWorker.
   716  	gcMarkWorkerMode gcMarkWorkerMode
   717  	// gcMarkWorkerStartTime is the nanotime() at which the most recent
   718  	// mark worker started.
   719  	gcMarkWorkerStartTime int64
   720  
   721  	// gcw is this P's GC work buffer cache. The work buffer is
   722  	// filled by write barriers, drained by mutator assists, and
   723  	// disposed on certain GC state transitions.
   724  	gcw gcWork
   725  
   726  	// wbBuf is this P's GC write barrier buffer.
   727  	//
   728  	// TODO: Consider caching this in the running G.
   729  	wbBuf wbBuf
   730  
   731  	runSafePointFn uint32 // if 1, run sched.safePointFn at next safe point
   732  
   733  	// statsSeq is a counter indicating whether this P is currently
   734  	// writing any stats. Its value is even when not, odd when it is.
   735  	statsSeq atomic.Uint32
   736  
   737  	// Timer heap.
   738  	timers timers
   739  
   740  	// Cleanups.
   741  	cleanups       *cleanupBlock
   742  	cleanupsQueued uint64 // monotonic count of cleanups queued by this P
   743  
   744  	// maxStackScanDelta accumulates the amount of stack space held by
   745  	// live goroutines (i.e. those eligible for stack scanning).
   746  	// Flushed to gcController.maxStackScan once maxStackScanSlack
   747  	// or -maxStackScanSlack is reached.
   748  	maxStackScanDelta int64
   749  
   750  	// gc-time statistics about current goroutines
   751  	// Note that this differs from maxStackScan in that this
   752  	// accumulates the actual stack observed to be used at GC time (hi - sp),
   753  	// not an instantaneous measure of the total stack size that might need
   754  	// to be scanned (hi - lo).
   755  	scannedStackSize uint64 // stack size of goroutines scanned by this P
   756  	scannedStacks    uint64 // number of goroutines scanned by this P
   757  
   758  	// preempt is set to indicate that this P should be enter the
   759  	// scheduler ASAP (regardless of what G is running on it).
   760  	preempt bool
   761  
   762  	// gcStopTime is the nanotime timestamp that this P last entered _Pgcstop.
   763  	gcStopTime int64
   764  
   765  	// Padding is no longer needed. False sharing is now not a worry because p is large enough
   766  	// that its size class is an integer multiple of the cache line size (for any of our architectures).
   767  }
   768  
   769  type schedt struct {
   770  	goidgen    atomic.Uint64
   771  	lastpoll   atomic.Int64 // time of last network poll, 0 if currently polling
   772  	pollUntil  atomic.Int64 // time to which current poll is sleeping
   773  	pollingNet atomic.Int32 // 1 if some P doing non-blocking network poll
   774  
   775  	lock mutex
   776  
   777  	// When increasing nmidle, nmidlelocked, nmsys, or nmfreed, be
   778  	// sure to call checkdead().
   779  
   780  	midle        muintptr // idle m's waiting for work
   781  	nmidle       int32    // number of idle m's waiting for work
   782  	nmidlelocked int32    // number of locked m's waiting for work
   783  	mnext        int64    // number of m's that have been created and next M ID
   784  	maxmcount    int32    // maximum number of m's allowed (or die)
   785  	nmsys        int32    // number of system m's not counted for deadlock
   786  	nmfreed      int64    // cumulative number of freed m's
   787  
   788  	ngsys atomic.Int32 // number of system goroutines
   789  
   790  	pidle        puintptr // idle p's
   791  	npidle       atomic.Int32
   792  	nmspinning   atomic.Int32  // See "Worker thread parking/unparking" comment in proc.go.
   793  	needspinning atomic.Uint32 // See "Delicate dance" comment in proc.go. Boolean. Must hold sched.lock to set to 1.
   794  
   795  	// Global runnable queue.
   796  	runq gQueue
   797  
   798  	// disable controls selective disabling of the scheduler.
   799  	//
   800  	// Use schedEnableUser to control this.
   801  	//
   802  	// disable is protected by sched.lock.
   803  	disable struct {
   804  		// user disables scheduling of user goroutines.
   805  		user     bool
   806  		runnable gQueue // pending runnable Gs
   807  	}
   808  
   809  	// Global cache of dead G's.
   810  	gFree struct {
   811  		lock    mutex
   812  		stack   gList // Gs with stacks
   813  		noStack gList // Gs without stacks
   814  	}
   815  
   816  	// Central cache of sudog structs.
   817  	sudoglock  mutex
   818  	sudogcache *sudog
   819  
   820  	// Central pool of available defer structs.
   821  	deferlock mutex
   822  	deferpool *_defer
   823  
   824  	// freem is the list of m's waiting to be freed when their
   825  	// m.exited is set. Linked through m.freelink.
   826  	freem *m
   827  
   828  	gcwaiting  atomic.Bool // gc is waiting to run
   829  	stopwait   int32
   830  	stopnote   note
   831  	sysmonwait atomic.Bool
   832  	sysmonnote note
   833  
   834  	// safePointFn should be called on each P at the next GC
   835  	// safepoint if p.runSafePointFn is set.
   836  	safePointFn   func(*p)
   837  	safePointWait int32
   838  	safePointNote note
   839  
   840  	profilehz int32 // cpu profiling rate
   841  
   842  	procresizetime int64 // nanotime() of last change to gomaxprocs
   843  	totaltime      int64 // ∫gomaxprocs dt up to procresizetime
   844  
   845  	customGOMAXPROCS bool // GOMAXPROCS was manually set from the environment or runtime.GOMAXPROCS
   846  
   847  	// sysmonlock protects sysmon's actions on the runtime.
   848  	//
   849  	// Acquire and hold this mutex to block sysmon from interacting
   850  	// with the rest of the runtime.
   851  	sysmonlock mutex
   852  
   853  	// timeToRun is a distribution of scheduling latencies, defined
   854  	// as the sum of time a G spends in the _Grunnable state before
   855  	// it transitions to _Grunning.
   856  	timeToRun timeHistogram
   857  
   858  	// idleTime is the total CPU time Ps have "spent" idle.
   859  	//
   860  	// Reset on each GC cycle.
   861  	idleTime atomic.Int64
   862  
   863  	// totalMutexWaitTime is the sum of time goroutines have spent in _Gwaiting
   864  	// with a waitreason of the form waitReasonSync{RW,}Mutex{R,}Lock.
   865  	totalMutexWaitTime atomic.Int64
   866  
   867  	// stwStoppingTimeGC/Other are distributions of stop-the-world stopping
   868  	// latencies, defined as the time taken by stopTheWorldWithSema to get
   869  	// all Ps to stop. stwStoppingTimeGC covers all GC-related STWs,
   870  	// stwStoppingTimeOther covers the others.
   871  	stwStoppingTimeGC    timeHistogram
   872  	stwStoppingTimeOther timeHistogram
   873  
   874  	// stwTotalTimeGC/Other are distributions of stop-the-world total
   875  	// latencies, defined as the total time from stopTheWorldWithSema to
   876  	// startTheWorldWithSema. This is a superset of
   877  	// stwStoppingTimeGC/Other. stwTotalTimeGC covers all GC-related STWs,
   878  	// stwTotalTimeOther covers the others.
   879  	stwTotalTimeGC    timeHistogram
   880  	stwTotalTimeOther timeHistogram
   881  
   882  	// totalRuntimeLockWaitTime (plus the value of lockWaitTime on each M in
   883  	// allm) is the sum of time goroutines have spent in _Grunnable and with an
   884  	// M, but waiting for locks within the runtime. This field stores the value
   885  	// for Ms that have exited.
   886  	totalRuntimeLockWaitTime atomic.Int64
   887  }
   888  
   889  // Values for the flags field of a sigTabT.
   890  const (
   891  	_SigNotify   = 1 << iota // let signal.Notify have signal, even if from kernel
   892  	_SigKill                 // if signal.Notify doesn't take it, exit quietly
   893  	_SigThrow                // if signal.Notify doesn't take it, exit loudly
   894  	_SigPanic                // if the signal is from the kernel, panic
   895  	_SigDefault              // if the signal isn't explicitly requested, don't monitor it
   896  	_SigGoExit               // cause all runtime procs to exit (only used on Plan 9).
   897  	_SigSetStack             // Don't explicitly install handler, but add SA_ONSTACK to existing libc handler
   898  	_SigUnblock              // always unblock; see blockableSig
   899  	_SigIgn                  // _SIG_DFL action is to ignore the signal
   900  )
   901  
   902  // Layout of in-memory per-function information prepared by linker
   903  // See https://golang.org/s/go12symtab.
   904  // Keep in sync with linker (../cmd/link/internal/ld/pcln.go:/pclntab)
   905  // and with package debug/gosym and with symtab.go in package runtime.
   906  type _func struct {
   907  	sys.NotInHeap // Only in static data
   908  
   909  	entryOff uint32 // start pc, as offset from moduledata.text/pcHeader.textStart
   910  	nameOff  int32  // function name, as index into moduledata.funcnametab.
   911  
   912  	args        int32  // in/out args size
   913  	deferreturn uint32 // offset of start of a deferreturn call instruction from entry, if any.
   914  
   915  	pcsp      uint32
   916  	pcfile    uint32
   917  	pcln      uint32
   918  	npcdata   uint32
   919  	cuOffset  uint32     // runtime.cutab offset of this function's CU
   920  	startLine int32      // line number of start of function (func keyword/TEXT directive)
   921  	funcID    abi.FuncID // set for certain special runtime functions
   922  	flag      abi.FuncFlag
   923  	_         [1]byte // pad
   924  	nfuncdata uint8   // must be last, must end on a uint32-aligned boundary
   925  
   926  	// The end of the struct is followed immediately by two variable-length
   927  	// arrays that reference the pcdata and funcdata locations for this
   928  	// function.
   929  
   930  	// pcdata contains the offset into moduledata.pctab for the start of
   931  	// that index's table. e.g.,
   932  	// &moduledata.pctab[_func.pcdata[_PCDATA_UnsafePoint]] is the start of
   933  	// the unsafe point table.
   934  	//
   935  	// An offset of 0 indicates that there is no table.
   936  	//
   937  	// pcdata [npcdata]uint32
   938  
   939  	// funcdata contains the offset past moduledata.gofunc which contains a
   940  	// pointer to that index's funcdata. e.g.,
   941  	// *(moduledata.gofunc +  _func.funcdata[_FUNCDATA_ArgsPointerMaps]) is
   942  	// the argument pointer map.
   943  	//
   944  	// An offset of ^uint32(0) indicates that there is no entry.
   945  	//
   946  	// funcdata [nfuncdata]uint32
   947  }
   948  
   949  // Pseudo-Func that is returned for PCs that occur in inlined code.
   950  // A *Func can be either a *_func or a *funcinl, and they are distinguished
   951  // by the first uintptr.
   952  //
   953  // TODO(austin): Can we merge this with inlinedCall?
   954  type funcinl struct {
   955  	ones      uint32  // set to ^0 to distinguish from _func
   956  	entry     uintptr // entry of the real (the "outermost") frame
   957  	name      string
   958  	file      string
   959  	line      int32
   960  	startLine int32
   961  }
   962  
   963  type itab = abi.ITab
   964  
   965  // Lock-free stack node.
   966  // Also known to export_test.go.
   967  type lfnode struct {
   968  	next    uint64
   969  	pushcnt uintptr
   970  }
   971  
   972  type forcegcstate struct {
   973  	lock mutex
   974  	g    *g
   975  	idle atomic.Bool
   976  }
   977  
   978  // A _defer holds an entry on the list of deferred calls.
   979  // If you add a field here, add code to clear it in deferProcStack.
   980  // This struct must match the code in cmd/compile/internal/ssagen/ssa.go:deferstruct
   981  // and cmd/compile/internal/ssagen/ssa.go:(*state).call.
   982  // Some defers will be allocated on the stack and some on the heap.
   983  // All defers are logically part of the stack, so write barriers to
   984  // initialize them are not required. All defers must be manually scanned,
   985  // and for heap defers, marked.
   986  type _defer struct {
   987  	heap      bool
   988  	rangefunc bool    // true for rangefunc list
   989  	sp        uintptr // sp at time of defer
   990  	pc        uintptr // pc at time of defer
   991  	fn        func()  // can be nil for open-coded defers
   992  	link      *_defer // next defer on G; can point to either heap or stack!
   993  
   994  	// If rangefunc is true, *head is the head of the atomic linked list
   995  	// during a range-over-func execution.
   996  	head *atomic.Pointer[_defer]
   997  }
   998  
   999  // A _panic holds information about an active panic.
  1000  //
  1001  // A _panic value must only ever live on the stack.
  1002  //
  1003  // The argp and link fields are stack pointers, but don't need special
  1004  // handling during stack growth: because they are pointer-typed and
  1005  // _panic values only live on the stack, regular stack pointer
  1006  // adjustment takes care of them.
  1007  type _panic struct {
  1008  	argp unsafe.Pointer // pointer to arguments of deferred call run during panic; cannot move - known to liblink
  1009  	arg  any            // argument to panic
  1010  	link *_panic        // link to earlier panic
  1011  
  1012  	// startPC and startSP track where _panic.start was called.
  1013  	startPC uintptr
  1014  	startSP unsafe.Pointer
  1015  
  1016  	// The current stack frame that we're running deferred calls for.
  1017  	sp unsafe.Pointer
  1018  	lr uintptr
  1019  	fp unsafe.Pointer
  1020  
  1021  	// retpc stores the PC where the panic should jump back to, if the
  1022  	// function last returned by _panic.next() recovers the panic.
  1023  	retpc uintptr
  1024  
  1025  	// Extra state for handling open-coded defers.
  1026  	deferBitsPtr *uint8
  1027  	slotsPtr     unsafe.Pointer
  1028  
  1029  	recovered   bool // whether this panic has been recovered
  1030  	repanicked  bool // whether this panic repanicked
  1031  	goexit      bool
  1032  	deferreturn bool
  1033  }
  1034  
  1035  // savedOpenDeferState tracks the extra state from _panic that's
  1036  // necessary for deferreturn to pick up where gopanic left off,
  1037  // without needing to unwind the stack.
  1038  type savedOpenDeferState struct {
  1039  	retpc           uintptr
  1040  	deferBitsOffset uintptr
  1041  	slotsOffset     uintptr
  1042  }
  1043  
  1044  // ancestorInfo records details of where a goroutine was started.
  1045  type ancestorInfo struct {
  1046  	pcs  []uintptr // pcs from the stack of this goroutine
  1047  	goid uint64    // goroutine id of this goroutine; original goroutine possibly dead
  1048  	gopc uintptr   // pc of go statement that created this goroutine
  1049  }
  1050  
  1051  // A waitReason explains why a goroutine has been stopped.
  1052  // See gopark. Do not re-use waitReasons, add new ones.
  1053  type waitReason uint8
  1054  
  1055  const (
  1056  	waitReasonZero                  waitReason = iota // ""
  1057  	waitReasonGCAssistMarking                         // "GC assist marking"
  1058  	waitReasonIOWait                                  // "IO wait"
  1059  	waitReasonChanReceiveNilChan                      // "chan receive (nil chan)"
  1060  	waitReasonChanSendNilChan                         // "chan send (nil chan)"
  1061  	waitReasonDumpingHeap                             // "dumping heap"
  1062  	waitReasonGarbageCollection                       // "garbage collection"
  1063  	waitReasonGarbageCollectionScan                   // "garbage collection scan"
  1064  	waitReasonPanicWait                               // "panicwait"
  1065  	waitReasonSelect                                  // "select"
  1066  	waitReasonSelectNoCases                           // "select (no cases)"
  1067  	waitReasonGCAssistWait                            // "GC assist wait"
  1068  	waitReasonGCSweepWait                             // "GC sweep wait"
  1069  	waitReasonGCScavengeWait                          // "GC scavenge wait"
  1070  	waitReasonChanReceive                             // "chan receive"
  1071  	waitReasonChanSend                                // "chan send"
  1072  	waitReasonFinalizerWait                           // "finalizer wait"
  1073  	waitReasonForceGCIdle                             // "force gc (idle)"
  1074  	waitReasonUpdateGOMAXPROCSIdle                    // "GOMAXPROCS updater (idle)"
  1075  	waitReasonSemacquire                              // "semacquire"
  1076  	waitReasonSleep                                   // "sleep"
  1077  	waitReasonSyncCondWait                            // "sync.Cond.Wait"
  1078  	waitReasonSyncMutexLock                           // "sync.Mutex.Lock"
  1079  	waitReasonSyncRWMutexRLock                        // "sync.RWMutex.RLock"
  1080  	waitReasonSyncRWMutexLock                         // "sync.RWMutex.Lock"
  1081  	waitReasonSyncWaitGroupWait                       // "sync.WaitGroup.Wait"
  1082  	waitReasonTraceReaderBlocked                      // "trace reader (blocked)"
  1083  	waitReasonWaitForGCCycle                          // "wait for GC cycle"
  1084  	waitReasonGCWorkerIdle                            // "GC worker (idle)"
  1085  	waitReasonGCWorkerActive                          // "GC worker (active)"
  1086  	waitReasonPreempted                               // "preempted"
  1087  	waitReasonDebugCall                               // "debug call"
  1088  	waitReasonGCMarkTermination                       // "GC mark termination"
  1089  	waitReasonStoppingTheWorld                        // "stopping the world"
  1090  	waitReasonFlushProcCaches                         // "flushing proc caches"
  1091  	waitReasonTraceGoroutineStatus                    // "trace goroutine status"
  1092  	waitReasonTraceProcStatus                         // "trace proc status"
  1093  	waitReasonPageTraceFlush                          // "page trace flush"
  1094  	waitReasonCoroutine                               // "coroutine"
  1095  	waitReasonGCWeakToStrongWait                      // "GC weak to strong wait"
  1096  	waitReasonSynctestRun                             // "synctest.Run"
  1097  	waitReasonSynctestWait                            // "synctest.Wait"
  1098  	waitReasonSynctestChanReceive                     // "chan receive (durable)"
  1099  	waitReasonSynctestChanSend                        // "chan send (durable)"
  1100  	waitReasonSynctestSelect                          // "select (durable)"
  1101  	waitReasonSynctestWaitGroupWait                   // "sync.WaitGroup.Wait (durable)"
  1102  	waitReasonCleanupWait                             // "cleanup wait"
  1103  )
  1104  
  1105  var waitReasonStrings = [...]string{
  1106  	waitReasonZero:                  "",
  1107  	waitReasonGCAssistMarking:       "GC assist marking",
  1108  	waitReasonIOWait:                "IO wait",
  1109  	waitReasonChanReceiveNilChan:    "chan receive (nil chan)",
  1110  	waitReasonChanSendNilChan:       "chan send (nil chan)",
  1111  	waitReasonDumpingHeap:           "dumping heap",
  1112  	waitReasonGarbageCollection:     "garbage collection",
  1113  	waitReasonGarbageCollectionScan: "garbage collection scan",
  1114  	waitReasonPanicWait:             "panicwait",
  1115  	waitReasonSelect:                "select",
  1116  	waitReasonSelectNoCases:         "select (no cases)",
  1117  	waitReasonGCAssistWait:          "GC assist wait",
  1118  	waitReasonGCSweepWait:           "GC sweep wait",
  1119  	waitReasonGCScavengeWait:        "GC scavenge wait",
  1120  	waitReasonChanReceive:           "chan receive",
  1121  	waitReasonChanSend:              "chan send",
  1122  	waitReasonFinalizerWait:         "finalizer wait",
  1123  	waitReasonForceGCIdle:           "force gc (idle)",
  1124  	waitReasonUpdateGOMAXPROCSIdle:  "GOMAXPROCS updater (idle)",
  1125  	waitReasonSemacquire:            "semacquire",
  1126  	waitReasonSleep:                 "sleep",
  1127  	waitReasonSyncCondWait:          "sync.Cond.Wait",
  1128  	waitReasonSyncMutexLock:         "sync.Mutex.Lock",
  1129  	waitReasonSyncRWMutexRLock:      "sync.RWMutex.RLock",
  1130  	waitReasonSyncRWMutexLock:       "sync.RWMutex.Lock",
  1131  	waitReasonSyncWaitGroupWait:     "sync.WaitGroup.Wait",
  1132  	waitReasonTraceReaderBlocked:    "trace reader (blocked)",
  1133  	waitReasonWaitForGCCycle:        "wait for GC cycle",
  1134  	waitReasonGCWorkerIdle:          "GC worker (idle)",
  1135  	waitReasonGCWorkerActive:        "GC worker (active)",
  1136  	waitReasonPreempted:             "preempted",
  1137  	waitReasonDebugCall:             "debug call",
  1138  	waitReasonGCMarkTermination:     "GC mark termination",
  1139  	waitReasonStoppingTheWorld:      "stopping the world",
  1140  	waitReasonFlushProcCaches:       "flushing proc caches",
  1141  	waitReasonTraceGoroutineStatus:  "trace goroutine status",
  1142  	waitReasonTraceProcStatus:       "trace proc status",
  1143  	waitReasonPageTraceFlush:        "page trace flush",
  1144  	waitReasonCoroutine:             "coroutine",
  1145  	waitReasonGCWeakToStrongWait:    "GC weak to strong wait",
  1146  	waitReasonSynctestRun:           "synctest.Run",
  1147  	waitReasonSynctestWait:          "synctest.Wait",
  1148  	waitReasonSynctestChanReceive:   "chan receive (durable)",
  1149  	waitReasonSynctestChanSend:      "chan send (durable)",
  1150  	waitReasonSynctestSelect:        "select (durable)",
  1151  	waitReasonSynctestWaitGroupWait: "sync.WaitGroup.Wait (durable)",
  1152  	waitReasonCleanupWait:           "cleanup wait",
  1153  }
  1154  
  1155  func (w waitReason) String() string {
  1156  	if w < 0 || w >= waitReason(len(waitReasonStrings)) {
  1157  		return "unknown wait reason"
  1158  	}
  1159  	return waitReasonStrings[w]
  1160  }
  1161  
  1162  func (w waitReason) isMutexWait() bool {
  1163  	return w == waitReasonSyncMutexLock ||
  1164  		w == waitReasonSyncRWMutexRLock ||
  1165  		w == waitReasonSyncRWMutexLock
  1166  }
  1167  
  1168  func (w waitReason) isWaitingForSuspendG() bool {
  1169  	return isWaitingForSuspendG[w]
  1170  }
  1171  
  1172  // isWaitingForSuspendG indicates that a goroutine is only entering _Gwaiting and
  1173  // setting a waitReason because it needs to be able to let the suspendG
  1174  // (used by the GC and the execution tracer) take ownership of its stack.
  1175  // The G is always actually executing on the system stack in these cases.
  1176  //
  1177  // TODO(mknyszek): Consider replacing this with a new dedicated G status.
  1178  var isWaitingForSuspendG = [len(waitReasonStrings)]bool{
  1179  	waitReasonStoppingTheWorld:      true,
  1180  	waitReasonGCMarkTermination:     true,
  1181  	waitReasonGarbageCollection:     true,
  1182  	waitReasonGarbageCollectionScan: true,
  1183  	waitReasonTraceGoroutineStatus:  true,
  1184  	waitReasonTraceProcStatus:       true,
  1185  	waitReasonPageTraceFlush:        true,
  1186  	waitReasonGCAssistMarking:       true,
  1187  	waitReasonGCWorkerActive:        true,
  1188  	waitReasonFlushProcCaches:       true,
  1189  }
  1190  
  1191  func (w waitReason) isIdleInSynctest() bool {
  1192  	return isIdleInSynctest[w]
  1193  }
  1194  
  1195  // isIdleInSynctest indicates that a goroutine is considered idle by synctest.Wait.
  1196  var isIdleInSynctest = [len(waitReasonStrings)]bool{
  1197  	waitReasonChanReceiveNilChan:    true,
  1198  	waitReasonChanSendNilChan:       true,
  1199  	waitReasonSelectNoCases:         true,
  1200  	waitReasonSleep:                 true,
  1201  	waitReasonSyncCondWait:          true,
  1202  	waitReasonSynctestWaitGroupWait: true,
  1203  	waitReasonCoroutine:             true,
  1204  	waitReasonSynctestRun:           true,
  1205  	waitReasonSynctestWait:          true,
  1206  	waitReasonSynctestChanReceive:   true,
  1207  	waitReasonSynctestChanSend:      true,
  1208  	waitReasonSynctestSelect:        true,
  1209  }
  1210  
  1211  var (
  1212  	allm          *m
  1213  	gomaxprocs    int32
  1214  	numCPUStartup int32
  1215  	forcegc       forcegcstate
  1216  	sched         schedt
  1217  	newprocs      int32
  1218  )
  1219  
  1220  var (
  1221  	// allpLock protects P-less reads and size changes of allp, idlepMask,
  1222  	// and timerpMask, and all writes to allp.
  1223  	allpLock mutex
  1224  
  1225  	// len(allp) == gomaxprocs; may change at safe points, otherwise
  1226  	// immutable.
  1227  	allp []*p
  1228  
  1229  	// Bitmask of Ps in _Pidle list, one bit per P. Reads and writes must
  1230  	// be atomic. Length may change at safe points.
  1231  	//
  1232  	// Each P must update only its own bit. In order to maintain
  1233  	// consistency, a P going idle must the idle mask simultaneously with
  1234  	// updates to the idle P list under the sched.lock, otherwise a racing
  1235  	// pidleget may clear the mask before pidleput sets the mask,
  1236  	// corrupting the bitmap.
  1237  	//
  1238  	// N.B., procresize takes ownership of all Ps in stopTheWorldWithSema.
  1239  	idlepMask pMask
  1240  
  1241  	// Bitmask of Ps that may have a timer, one bit per P. Reads and writes
  1242  	// must be atomic. Length may change at safe points.
  1243  	//
  1244  	// Ideally, the timer mask would be kept immediately consistent on any timer
  1245  	// operations. Unfortunately, updating a shared global data structure in the
  1246  	// timer hot path adds too much overhead in applications frequently switching
  1247  	// between no timers and some timers.
  1248  	//
  1249  	// As a compromise, the timer mask is updated only on pidleget / pidleput. A
  1250  	// running P (returned by pidleget) may add a timer at any time, so its mask
  1251  	// must be set. An idle P (passed to pidleput) cannot add new timers while
  1252  	// idle, so if it has no timers at that time, its mask may be cleared.
  1253  	//
  1254  	// Thus, we get the following effects on timer-stealing in findrunnable:
  1255  	//
  1256  	//   - Idle Ps with no timers when they go idle are never checked in findrunnable
  1257  	//     (for work- or timer-stealing; this is the ideal case).
  1258  	//   - Running Ps must always be checked.
  1259  	//   - Idle Ps whose timers are stolen must continue to be checked until they run
  1260  	//     again, even after timer expiration.
  1261  	//
  1262  	// When the P starts running again, the mask should be set, as a timer may be
  1263  	// added at any time.
  1264  	//
  1265  	// TODO(prattmic): Additional targeted updates may improve the above cases.
  1266  	// e.g., updating the mask when stealing a timer.
  1267  	timerpMask pMask
  1268  )
  1269  
  1270  // goarmsoftfp is used by runtime/cgo assembly.
  1271  //
  1272  //go:linkname goarmsoftfp
  1273  
  1274  var (
  1275  	// Pool of GC parked background workers. Entries are type
  1276  	// *gcBgMarkWorkerNode.
  1277  	gcBgMarkWorkerPool lfstack
  1278  
  1279  	// Total number of gcBgMarkWorker goroutines. Protected by worldsema.
  1280  	gcBgMarkWorkerCount int32
  1281  
  1282  	// Information about what cpu features are available.
  1283  	// Packages outside the runtime should not use these
  1284  	// as they are not an external api.
  1285  	// Set on startup in asm_{386,amd64}.s
  1286  	processorVersionInfo uint32
  1287  	isIntel              bool
  1288  )
  1289  
  1290  // set by cmd/link on arm systems
  1291  // accessed using linkname by internal/runtime/atomic.
  1292  //
  1293  // goarm should be an internal detail,
  1294  // but widely used packages access it using linkname.
  1295  // Notable members of the hall of shame include:
  1296  //   - github.com/creativeprojects/go-selfupdate
  1297  //
  1298  // Do not remove or change the type signature.
  1299  // See go.dev/issue/67401.
  1300  //
  1301  //go:linkname goarm
  1302  var (
  1303  	goarm       uint8
  1304  	goarmsoftfp uint8
  1305  )
  1306  
  1307  // Set by the linker so the runtime can determine the buildmode.
  1308  var (
  1309  	islibrary bool // -buildmode=c-shared
  1310  	isarchive bool // -buildmode=c-archive
  1311  )
  1312  
  1313  // Must agree with internal/buildcfg.FramePointerEnabled.
  1314  const framepointer_enabled = GOARCH == "amd64" || GOARCH == "arm64"
  1315  
  1316  // getcallerfp returns the frame pointer of the caller of the caller
  1317  // of this function.
  1318  //
  1319  //go:nosplit
  1320  //go:noinline
  1321  func getcallerfp() uintptr {
  1322  	fp := getfp() // This frame's FP.
  1323  	if fp != 0 {
  1324  		fp = *(*uintptr)(unsafe.Pointer(fp)) // The caller's FP.
  1325  		fp = *(*uintptr)(unsafe.Pointer(fp)) // The caller's caller's FP.
  1326  	}
  1327  	return fp
  1328  }
  1329  

View as plain text