]> Cypherpunks.ru repositories - gostls13.git/blob - src/runtime/proc.go
runtime/trace: add missing events for the locked g in extra M.
[gostls13.git] / src / runtime / proc.go
1 // Copyright 2014 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/cpu"
10         "internal/goarch"
11         "runtime/internal/atomic"
12         "runtime/internal/sys"
13         "unsafe"
14 )
15
16 // set using cmd/go/internal/modload.ModInfoProg
17 var modinfo string
18
19 // Goroutine scheduler
20 // The scheduler's job is to distribute ready-to-run goroutines over worker threads.
21 //
22 // The main concepts are:
23 // G - goroutine.
24 // M - worker thread, or machine.
25 // P - processor, a resource that is required to execute Go code.
26 //     M must have an associated P to execute Go code, however it can be
27 //     blocked or in a syscall w/o an associated P.
28 //
29 // Design doc at https://golang.org/s/go11sched.
30
31 // Worker thread parking/unparking.
32 // We need to balance between keeping enough running worker threads to utilize
33 // available hardware parallelism and parking excessive running worker threads
34 // to conserve CPU resources and power. This is not simple for two reasons:
35 // (1) scheduler state is intentionally distributed (in particular, per-P work
36 // queues), so it is not possible to compute global predicates on fast paths;
37 // (2) for optimal thread management we would need to know the future (don't park
38 // a worker thread when a new goroutine will be readied in near future).
39 //
40 // Three rejected approaches that would work badly:
41 // 1. Centralize all scheduler state (would inhibit scalability).
42 // 2. Direct goroutine handoff. That is, when we ready a new goroutine and there
43 //    is a spare P, unpark a thread and handoff it the thread and the goroutine.
44 //    This would lead to thread state thrashing, as the thread that readied the
45 //    goroutine can be out of work the very next moment, we will need to park it.
46 //    Also, it would destroy locality of computation as we want to preserve
47 //    dependent goroutines on the same thread; and introduce additional latency.
48 // 3. Unpark an additional thread whenever we ready a goroutine and there is an
49 //    idle P, but don't do handoff. This would lead to excessive thread parking/
50 //    unparking as the additional threads will instantly park without discovering
51 //    any work to do.
52 //
53 // The current approach:
54 //
55 // This approach applies to three primary sources of potential work: readying a
56 // goroutine, new/modified-earlier timers, and idle-priority GC. See below for
57 // additional details.
58 //
59 // We unpark an additional thread when we submit work if (this is wakep()):
60 // 1. There is an idle P, and
61 // 2. There are no "spinning" worker threads.
62 //
63 // A worker thread is considered spinning if it is out of local work and did
64 // not find work in the global run queue or netpoller; the spinning state is
65 // denoted in m.spinning and in sched.nmspinning. Threads unparked this way are
66 // also considered spinning; we don't do goroutine handoff so such threads are
67 // out of work initially. Spinning threads spin on looking for work in per-P
68 // run queues and timer heaps or from the GC before parking. If a spinning
69 // thread finds work it takes itself out of the spinning state and proceeds to
70 // execution. If it does not find work it takes itself out of the spinning
71 // state and then parks.
72 //
73 // If there is at least one spinning thread (sched.nmspinning>1), we don't
74 // unpark new threads when submitting work. To compensate for that, if the last
75 // spinning thread finds work and stops spinning, it must unpark a new spinning
76 // thread. This approach smooths out unjustified spikes of thread unparking,
77 // but at the same time guarantees eventual maximal CPU parallelism
78 // utilization.
79 //
80 // The main implementation complication is that we need to be very careful
81 // during spinning->non-spinning thread transition. This transition can race
82 // with submission of new work, and either one part or another needs to unpark
83 // another worker thread. If they both fail to do that, we can end up with
84 // semi-persistent CPU underutilization.
85 //
86 // The general pattern for submission is:
87 // 1. Submit work to the local run queue, timer heap, or GC state.
88 // 2. #StoreLoad-style memory barrier.
89 // 3. Check sched.nmspinning.
90 //
91 // The general pattern for spinning->non-spinning transition is:
92 // 1. Decrement nmspinning.
93 // 2. #StoreLoad-style memory barrier.
94 // 3. Check all per-P work queues and GC for new work.
95 //
96 // Note that all this complexity does not apply to global run queue as we are
97 // not sloppy about thread unparking when submitting to global queue. Also see
98 // comments for nmspinning manipulation.
99 //
100 // How these different sources of work behave varies, though it doesn't affect
101 // the synchronization approach:
102 // * Ready goroutine: this is an obvious source of work; the goroutine is
103 //   immediately ready and must run on some thread eventually.
104 // * New/modified-earlier timer: The current timer implementation (see time.go)
105 //   uses netpoll in a thread with no work available to wait for the soonest
106 //   timer. If there is no thread waiting, we want a new spinning thread to go
107 //   wait.
108 // * Idle-priority GC: The GC wakes a stopped idle thread to contribute to
109 //   background GC work (note: currently disabled per golang.org/issue/19112).
110 //   Also see golang.org/issue/44313, as this should be extended to all GC
111 //   workers.
112
113 var (
114         m0           m
115         g0           g
116         mcache0      *mcache
117         raceprocctx0 uintptr
118 )
119
120 //go:linkname runtime_inittask runtime..inittask
121 var runtime_inittask initTask
122
123 //go:linkname main_inittask main..inittask
124 var main_inittask initTask
125
126 // main_init_done is a signal used by cgocallbackg that initialization
127 // has been completed. It is made before _cgo_notify_runtime_init_done,
128 // so all cgo calls can rely on it existing. When main_init is complete,
129 // it is closed, meaning cgocallbackg can reliably receive from it.
130 var main_init_done chan bool
131
132 //go:linkname main_main main.main
133 func main_main()
134
135 // mainStarted indicates that the main M has started.
136 var mainStarted bool
137
138 // runtimeInitTime is the nanotime() at which the runtime started.
139 var runtimeInitTime int64
140
141 // Value to use for signal mask for newly created M's.
142 var initSigmask sigset
143
144 // The main goroutine.
145 func main() {
146         mp := getg().m
147
148         // Racectx of m0->g0 is used only as the parent of the main goroutine.
149         // It must not be used for anything else.
150         mp.g0.racectx = 0
151
152         // Max stack size is 1 GB on 64-bit, 250 MB on 32-bit.
153         // Using decimal instead of binary GB and MB because
154         // they look nicer in the stack overflow failure message.
155         if goarch.PtrSize == 8 {
156                 maxstacksize = 1000000000
157         } else {
158                 maxstacksize = 250000000
159         }
160
161         // An upper limit for max stack size. Used to avoid random crashes
162         // after calling SetMaxStack and trying to allocate a stack that is too big,
163         // since stackalloc works with 32-bit sizes.
164         maxstackceiling = 2 * maxstacksize
165
166         // Allow newproc to start new Ms.
167         mainStarted = true
168
169         if GOARCH != "wasm" { // no threads on wasm yet, so no sysmon
170                 systemstack(func() {
171                         newm(sysmon, nil, -1)
172                 })
173         }
174
175         // Lock the main goroutine onto this, the main OS thread,
176         // during initialization. Most programs won't care, but a few
177         // do require certain calls to be made by the main thread.
178         // Those can arrange for main.main to run in the main thread
179         // by calling runtime.LockOSThread during initialization
180         // to preserve the lock.
181         lockOSThread()
182
183         if mp != &m0 {
184                 throw("runtime.main not on m0")
185         }
186
187         // Record when the world started.
188         // Must be before doInit for tracing init.
189         runtimeInitTime = nanotime()
190         if runtimeInitTime == 0 {
191                 throw("nanotime returning zero")
192         }
193
194         if debug.inittrace != 0 {
195                 inittrace.id = getg().goid
196                 inittrace.active = true
197         }
198
199         doInit(&runtime_inittask) // Must be before defer.
200
201         // Defer unlock so that runtime.Goexit during init does the unlock too.
202         needUnlock := true
203         defer func() {
204                 if needUnlock {
205                         unlockOSThread()
206                 }
207         }()
208
209         gcenable()
210
211         main_init_done = make(chan bool)
212         if iscgo {
213                 if _cgo_thread_start == nil {
214                         throw("_cgo_thread_start missing")
215                 }
216                 if GOOS != "windows" {
217                         if _cgo_setenv == nil {
218                                 throw("_cgo_setenv missing")
219                         }
220                         if _cgo_unsetenv == nil {
221                                 throw("_cgo_unsetenv missing")
222                         }
223                 }
224                 if _cgo_notify_runtime_init_done == nil {
225                         throw("_cgo_notify_runtime_init_done missing")
226                 }
227                 // Start the template thread in case we enter Go from
228                 // a C-created thread and need to create a new thread.
229                 startTemplateThread()
230                 cgocall(_cgo_notify_runtime_init_done, nil)
231         }
232
233         doInit(&main_inittask)
234
235         // Disable init tracing after main init done to avoid overhead
236         // of collecting statistics in malloc and newproc
237         inittrace.active = false
238
239         close(main_init_done)
240
241         needUnlock = false
242         unlockOSThread()
243
244         if isarchive || islibrary {
245                 // A program compiled with -buildmode=c-archive or c-shared
246                 // has a main, but it is not executed.
247                 return
248         }
249         fn := main_main // make an indirect call, as the linker doesn't know the address of the main package when laying down the runtime
250         fn()
251         if raceenabled {
252                 racefini()
253         }
254
255         // Make racy client program work: if panicking on
256         // another goroutine at the same time as main returns,
257         // let the other goroutine finish printing the panic trace.
258         // Once it does, it will exit. See issues 3934 and 20018.
259         if runningPanicDefers.Load() != 0 {
260                 // Running deferred functions should not take long.
261                 for c := 0; c < 1000; c++ {
262                         if runningPanicDefers.Load() == 0 {
263                                 break
264                         }
265                         Gosched()
266                 }
267         }
268         if panicking.Load() != 0 {
269                 gopark(nil, nil, waitReasonPanicWait, traceEvGoStop, 1)
270         }
271
272         exit(0)
273         for {
274                 var x *int32
275                 *x = 0
276         }
277 }
278
279 // os_beforeExit is called from os.Exit(0).
280 //
281 //go:linkname os_beforeExit os.runtime_beforeExit
282 func os_beforeExit() {
283         if raceenabled {
284                 racefini()
285         }
286 }
287
288 // start forcegc helper goroutine
289 func init() {
290         go forcegchelper()
291 }
292
293 func forcegchelper() {
294         forcegc.g = getg()
295         lockInit(&forcegc.lock, lockRankForcegc)
296         for {
297                 lock(&forcegc.lock)
298                 if forcegc.idle != 0 {
299                         throw("forcegc: phase error")
300                 }
301                 atomic.Store(&forcegc.idle, 1)
302                 goparkunlock(&forcegc.lock, waitReasonForceGCIdle, traceEvGoBlock, 1)
303                 // this goroutine is explicitly resumed by sysmon
304                 if debug.gctrace > 0 {
305                         println("GC forced")
306                 }
307                 // Time-triggered, fully concurrent.
308                 gcStart(gcTrigger{kind: gcTriggerTime, now: nanotime()})
309         }
310 }
311
312 //go:nosplit
313
314 // Gosched yields the processor, allowing other goroutines to run. It does not
315 // suspend the current goroutine, so execution resumes automatically.
316 func Gosched() {
317         checkTimeouts()
318         mcall(gosched_m)
319 }
320
321 // goschedguarded yields the processor like gosched, but also checks
322 // for forbidden states and opts out of the yield in those cases.
323 //
324 //go:nosplit
325 func goschedguarded() {
326         mcall(goschedguarded_m)
327 }
328
329 // Puts the current goroutine into a waiting state and calls unlockf on the
330 // system stack.
331 //
332 // If unlockf returns false, the goroutine is resumed.
333 //
334 // unlockf must not access this G's stack, as it may be moved between
335 // the call to gopark and the call to unlockf.
336 //
337 // Note that because unlockf is called after putting the G into a waiting
338 // state, the G may have already been readied by the time unlockf is called
339 // unless there is external synchronization preventing the G from being
340 // readied. If unlockf returns false, it must guarantee that the G cannot be
341 // externally readied.
342 //
343 // Reason explains why the goroutine has been parked. It is displayed in stack
344 // traces and heap dumps. Reasons should be unique and descriptive. Do not
345 // re-use reasons, add new ones.
346 func gopark(unlockf func(*g, unsafe.Pointer) bool, lock unsafe.Pointer, reason waitReason, traceEv byte, traceskip int) {
347         if reason != waitReasonSleep {
348                 checkTimeouts() // timeouts may expire while two goroutines keep the scheduler busy
349         }
350         mp := acquirem()
351         gp := mp.curg
352         status := readgstatus(gp)
353         if status != _Grunning && status != _Gscanrunning {
354                 throw("gopark: bad g status")
355         }
356         mp.waitlock = lock
357         mp.waitunlockf = unlockf
358         gp.waitreason = reason
359         mp.waittraceev = traceEv
360         mp.waittraceskip = traceskip
361         releasem(mp)
362         // can't do anything that might move the G between Ms here.
363         mcall(park_m)
364 }
365
366 // Puts the current goroutine into a waiting state and unlocks the lock.
367 // The goroutine can be made runnable again by calling goready(gp).
368 func goparkunlock(lock *mutex, reason waitReason, traceEv byte, traceskip int) {
369         gopark(parkunlock_c, unsafe.Pointer(lock), reason, traceEv, traceskip)
370 }
371
372 func goready(gp *g, traceskip int) {
373         systemstack(func() {
374                 ready(gp, traceskip, true)
375         })
376 }
377
378 //go:nosplit
379 func acquireSudog() *sudog {
380         // Delicate dance: the semaphore implementation calls
381         // acquireSudog, acquireSudog calls new(sudog),
382         // new calls malloc, malloc can call the garbage collector,
383         // and the garbage collector calls the semaphore implementation
384         // in stopTheWorld.
385         // Break the cycle by doing acquirem/releasem around new(sudog).
386         // The acquirem/releasem increments m.locks during new(sudog),
387         // which keeps the garbage collector from being invoked.
388         mp := acquirem()
389         pp := mp.p.ptr()
390         if len(pp.sudogcache) == 0 {
391                 lock(&sched.sudoglock)
392                 // First, try to grab a batch from central cache.
393                 for len(pp.sudogcache) < cap(pp.sudogcache)/2 && sched.sudogcache != nil {
394                         s := sched.sudogcache
395                         sched.sudogcache = s.next
396                         s.next = nil
397                         pp.sudogcache = append(pp.sudogcache, s)
398                 }
399                 unlock(&sched.sudoglock)
400                 // If the central cache is empty, allocate a new one.
401                 if len(pp.sudogcache) == 0 {
402                         pp.sudogcache = append(pp.sudogcache, new(sudog))
403                 }
404         }
405         n := len(pp.sudogcache)
406         s := pp.sudogcache[n-1]
407         pp.sudogcache[n-1] = nil
408         pp.sudogcache = pp.sudogcache[:n-1]
409         if s.elem != nil {
410                 throw("acquireSudog: found s.elem != nil in cache")
411         }
412         releasem(mp)
413         return s
414 }
415
416 //go:nosplit
417 func releaseSudog(s *sudog) {
418         if s.elem != nil {
419                 throw("runtime: sudog with non-nil elem")
420         }
421         if s.isSelect {
422                 throw("runtime: sudog with non-false isSelect")
423         }
424         if s.next != nil {
425                 throw("runtime: sudog with non-nil next")
426         }
427         if s.prev != nil {
428                 throw("runtime: sudog with non-nil prev")
429         }
430         if s.waitlink != nil {
431                 throw("runtime: sudog with non-nil waitlink")
432         }
433         if s.c != nil {
434                 throw("runtime: sudog with non-nil c")
435         }
436         gp := getg()
437         if gp.param != nil {
438                 throw("runtime: releaseSudog with non-nil gp.param")
439         }
440         mp := acquirem() // avoid rescheduling to another P
441         pp := mp.p.ptr()
442         if len(pp.sudogcache) == cap(pp.sudogcache) {
443                 // Transfer half of local cache to the central cache.
444                 var first, last *sudog
445                 for len(pp.sudogcache) > cap(pp.sudogcache)/2 {
446                         n := len(pp.sudogcache)
447                         p := pp.sudogcache[n-1]
448                         pp.sudogcache[n-1] = nil
449                         pp.sudogcache = pp.sudogcache[:n-1]
450                         if first == nil {
451                                 first = p
452                         } else {
453                                 last.next = p
454                         }
455                         last = p
456                 }
457                 lock(&sched.sudoglock)
458                 last.next = sched.sudogcache
459                 sched.sudogcache = first
460                 unlock(&sched.sudoglock)
461         }
462         pp.sudogcache = append(pp.sudogcache, s)
463         releasem(mp)
464 }
465
466 // called from assembly
467 func badmcall(fn func(*g)) {
468         throw("runtime: mcall called on m->g0 stack")
469 }
470
471 func badmcall2(fn func(*g)) {
472         throw("runtime: mcall function returned")
473 }
474
475 func badreflectcall() {
476         panic(plainError("arg size to reflect.call more than 1GB"))
477 }
478
479 var badmorestackg0Msg = "fatal: morestack on g0\n"
480
481 //go:nosplit
482 //go:nowritebarrierrec
483 func badmorestackg0() {
484         sp := stringStructOf(&badmorestackg0Msg)
485         write(2, sp.str, int32(sp.len))
486 }
487
488 var badmorestackgsignalMsg = "fatal: morestack on gsignal\n"
489
490 //go:nosplit
491 //go:nowritebarrierrec
492 func badmorestackgsignal() {
493         sp := stringStructOf(&badmorestackgsignalMsg)
494         write(2, sp.str, int32(sp.len))
495 }
496
497 //go:nosplit
498 func badctxt() {
499         throw("ctxt != 0")
500 }
501
502 func lockedOSThread() bool {
503         gp := getg()
504         return gp.lockedm != 0 && gp.m.lockedg != 0
505 }
506
507 var (
508         // allgs contains all Gs ever created (including dead Gs), and thus
509         // never shrinks.
510         //
511         // Access via the slice is protected by allglock or stop-the-world.
512         // Readers that cannot take the lock may (carefully!) use the atomic
513         // variables below.
514         allglock mutex
515         allgs    []*g
516
517         // allglen and allgptr are atomic variables that contain len(allgs) and
518         // &allgs[0] respectively. Proper ordering depends on totally-ordered
519         // loads and stores. Writes are protected by allglock.
520         //
521         // allgptr is updated before allglen. Readers should read allglen
522         // before allgptr to ensure that allglen is always <= len(allgptr). New
523         // Gs appended during the race can be missed. For a consistent view of
524         // all Gs, allglock must be held.
525         //
526         // allgptr copies should always be stored as a concrete type or
527         // unsafe.Pointer, not uintptr, to ensure that GC can still reach it
528         // even if it points to a stale array.
529         allglen uintptr
530         allgptr **g
531 )
532
533 func allgadd(gp *g) {
534         if readgstatus(gp) == _Gidle {
535                 throw("allgadd: bad status Gidle")
536         }
537
538         lock(&allglock)
539         allgs = append(allgs, gp)
540         if &allgs[0] != allgptr {
541                 atomicstorep(unsafe.Pointer(&allgptr), unsafe.Pointer(&allgs[0]))
542         }
543         atomic.Storeuintptr(&allglen, uintptr(len(allgs)))
544         unlock(&allglock)
545 }
546
547 // allGsSnapshot returns a snapshot of the slice of all Gs.
548 //
549 // The world must be stopped or allglock must be held.
550 func allGsSnapshot() []*g {
551         assertWorldStoppedOrLockHeld(&allglock)
552
553         // Because the world is stopped or allglock is held, allgadd
554         // cannot happen concurrently with this. allgs grows
555         // monotonically and existing entries never change, so we can
556         // simply return a copy of the slice header. For added safety,
557         // we trim everything past len because that can still change.
558         return allgs[:len(allgs):len(allgs)]
559 }
560
561 // atomicAllG returns &allgs[0] and len(allgs) for use with atomicAllGIndex.
562 func atomicAllG() (**g, uintptr) {
563         length := atomic.Loaduintptr(&allglen)
564         ptr := (**g)(atomic.Loadp(unsafe.Pointer(&allgptr)))
565         return ptr, length
566 }
567
568 // atomicAllGIndex returns ptr[i] with the allgptr returned from atomicAllG.
569 func atomicAllGIndex(ptr **g, i uintptr) *g {
570         return *(**g)(add(unsafe.Pointer(ptr), i*goarch.PtrSize))
571 }
572
573 // forEachG calls fn on every G from allgs.
574 //
575 // forEachG takes a lock to exclude concurrent addition of new Gs.
576 func forEachG(fn func(gp *g)) {
577         lock(&allglock)
578         for _, gp := range allgs {
579                 fn(gp)
580         }
581         unlock(&allglock)
582 }
583
584 // forEachGRace calls fn on every G from allgs.
585 //
586 // forEachGRace avoids locking, but does not exclude addition of new Gs during
587 // execution, which may be missed.
588 func forEachGRace(fn func(gp *g)) {
589         ptr, length := atomicAllG()
590         for i := uintptr(0); i < length; i++ {
591                 gp := atomicAllGIndex(ptr, i)
592                 fn(gp)
593         }
594         return
595 }
596
597 const (
598         // Number of goroutine ids to grab from sched.goidgen to local per-P cache at once.
599         // 16 seems to provide enough amortization, but other than that it's mostly arbitrary number.
600         _GoidCacheBatch = 16
601 )
602
603 // cpuinit extracts the environment variable GODEBUG from the environment on
604 // Unix-like operating systems and calls internal/cpu.Initialize.
605 func cpuinit() {
606         const prefix = "GODEBUG="
607         var env string
608
609         switch GOOS {
610         case "aix", "darwin", "ios", "dragonfly", "freebsd", "netbsd", "openbsd", "illumos", "solaris", "linux":
611                 cpu.DebugOptions = true
612
613                 // Similar to goenv_unix but extracts the environment value for
614                 // GODEBUG directly.
615                 // TODO(moehrmann): remove when general goenvs() can be called before cpuinit()
616                 n := int32(0)
617                 for argv_index(argv, argc+1+n) != nil {
618                         n++
619                 }
620
621                 for i := int32(0); i < n; i++ {
622                         p := argv_index(argv, argc+1+i)
623                         s := *(*string)(unsafe.Pointer(&stringStruct{unsafe.Pointer(p), findnull(p)}))
624
625                         if hasPrefix(s, prefix) {
626                                 env = gostring(p)[len(prefix):]
627                                 break
628                         }
629                 }
630         }
631
632         cpu.Initialize(env)
633
634         // Support cpu feature variables are used in code generated by the compiler
635         // to guard execution of instructions that can not be assumed to be always supported.
636         switch GOARCH {
637         case "386", "amd64":
638                 x86HasPOPCNT = cpu.X86.HasPOPCNT
639                 x86HasSSE41 = cpu.X86.HasSSE41
640                 x86HasFMA = cpu.X86.HasFMA
641
642         case "arm":
643                 armHasVFPv4 = cpu.ARM.HasVFPv4
644
645         case "arm64":
646                 arm64HasATOMICS = cpu.ARM64.HasATOMICS
647         }
648 }
649
650 // The bootstrap sequence is:
651 //
652 //      call osinit
653 //      call schedinit
654 //      make & queue new G
655 //      call runtime·mstart
656 //
657 // The new G calls runtime·main.
658 func schedinit() {
659         lockInit(&sched.lock, lockRankSched)
660         lockInit(&sched.sysmonlock, lockRankSysmon)
661         lockInit(&sched.deferlock, lockRankDefer)
662         lockInit(&sched.sudoglock, lockRankSudog)
663         lockInit(&deadlock, lockRankDeadlock)
664         lockInit(&paniclk, lockRankPanic)
665         lockInit(&allglock, lockRankAllg)
666         lockInit(&allpLock, lockRankAllp)
667         lockInit(&reflectOffs.lock, lockRankReflectOffs)
668         lockInit(&finlock, lockRankFin)
669         lockInit(&trace.bufLock, lockRankTraceBuf)
670         lockInit(&trace.stringsLock, lockRankTraceStrings)
671         lockInit(&trace.lock, lockRankTrace)
672         lockInit(&cpuprof.lock, lockRankCpuprof)
673         lockInit(&trace.stackTab.lock, lockRankTraceStackTab)
674         // Enforce that this lock is always a leaf lock.
675         // All of this lock's critical sections should be
676         // extremely short.
677         lockInit(&memstats.heapStats.noPLock, lockRankLeafRank)
678
679         // raceinit must be the first call to race detector.
680         // In particular, it must be done before mallocinit below calls racemapshadow.
681         gp := getg()
682         if raceenabled {
683                 gp.racectx, raceprocctx0 = raceinit()
684         }
685
686         sched.maxmcount = 10000
687
688         // The world starts stopped.
689         worldStopped()
690
691         moduledataverify()
692         stackinit()
693         mallocinit()
694         cpuinit()      // must run before alginit
695         alginit()      // maps, hash, fastrand must not be used before this call
696         fastrandinit() // must run before mcommoninit
697         mcommoninit(gp.m, -1)
698         modulesinit()   // provides activeModules
699         typelinksinit() // uses maps, activeModules
700         itabsinit()     // uses activeModules
701         stkobjinit()    // must run before GC starts
702
703         sigsave(&gp.m.sigmask)
704         initSigmask = gp.m.sigmask
705
706         goargs()
707         goenvs()
708         parsedebugvars()
709         gcinit()
710
711         lock(&sched.lock)
712         sched.lastpoll.Store(nanotime())
713         procs := ncpu
714         if n, ok := atoi32(gogetenv("GOMAXPROCS")); ok && n > 0 {
715                 procs = n
716         }
717         if procresize(procs) != nil {
718                 throw("unknown runnable goroutine during bootstrap")
719         }
720         unlock(&sched.lock)
721
722         // World is effectively started now, as P's can run.
723         worldStarted()
724
725         // For cgocheck > 1, we turn on the write barrier at all times
726         // and check all pointer writes. We can't do this until after
727         // procresize because the write barrier needs a P.
728         if debug.cgocheck > 1 {
729                 writeBarrier.cgo = true
730                 writeBarrier.enabled = true
731                 for _, pp := range allp {
732                         pp.wbBuf.reset()
733                 }
734         }
735
736         if buildVersion == "" {
737                 // Condition should never trigger. This code just serves
738                 // to ensure runtime·buildVersion is kept in the resulting binary.
739                 buildVersion = "unknown"
740         }
741         if len(modinfo) == 1 {
742                 // Condition should never trigger. This code just serves
743                 // to ensure runtime·modinfo is kept in the resulting binary.
744                 modinfo = ""
745         }
746 }
747
748 func dumpgstatus(gp *g) {
749         thisg := getg()
750         print("runtime:   gp: gp=", gp, ", goid=", gp.goid, ", gp->atomicstatus=", readgstatus(gp), "\n")
751         print("runtime: getg:  g=", thisg, ", goid=", thisg.goid, ",  g->atomicstatus=", readgstatus(thisg), "\n")
752 }
753
754 // sched.lock must be held.
755 func checkmcount() {
756         assertLockHeld(&sched.lock)
757
758         if mcount() > sched.maxmcount {
759                 print("runtime: program exceeds ", sched.maxmcount, "-thread limit\n")
760                 throw("thread exhaustion")
761         }
762 }
763
764 // mReserveID returns the next ID to use for a new m. This new m is immediately
765 // considered 'running' by checkdead.
766 //
767 // sched.lock must be held.
768 func mReserveID() int64 {
769         assertLockHeld(&sched.lock)
770
771         if sched.mnext+1 < sched.mnext {
772                 throw("runtime: thread ID overflow")
773         }
774         id := sched.mnext
775         sched.mnext++
776         checkmcount()
777         return id
778 }
779
780 // Pre-allocated ID may be passed as 'id', or omitted by passing -1.
781 func mcommoninit(mp *m, id int64) {
782         gp := getg()
783
784         // g0 stack won't make sense for user (and is not necessary unwindable).
785         if gp != gp.m.g0 {
786                 callers(1, mp.createstack[:])
787         }
788
789         lock(&sched.lock)
790
791         if id >= 0 {
792                 mp.id = id
793         } else {
794                 mp.id = mReserveID()
795         }
796
797         lo := uint32(int64Hash(uint64(mp.id), fastrandseed))
798         hi := uint32(int64Hash(uint64(cputicks()), ^fastrandseed))
799         if lo|hi == 0 {
800                 hi = 1
801         }
802         // Same behavior as for 1.17.
803         // TODO: Simplify ths.
804         if goarch.BigEndian {
805                 mp.fastrand = uint64(lo)<<32 | uint64(hi)
806         } else {
807                 mp.fastrand = uint64(hi)<<32 | uint64(lo)
808         }
809
810         mpreinit(mp)
811         if mp.gsignal != nil {
812                 mp.gsignal.stackguard1 = mp.gsignal.stack.lo + _StackGuard
813         }
814
815         // Add to allm so garbage collector doesn't free g->m
816         // when it is just in a register or thread-local storage.
817         mp.alllink = allm
818
819         // NumCgoCall() iterates over allm w/o schedlock,
820         // so we need to publish it safely.
821         atomicstorep(unsafe.Pointer(&allm), unsafe.Pointer(mp))
822         unlock(&sched.lock)
823
824         // Allocate memory to hold a cgo traceback if the cgo call crashes.
825         if iscgo || GOOS == "solaris" || GOOS == "illumos" || GOOS == "windows" {
826                 mp.cgoCallers = new(cgoCallers)
827         }
828 }
829
830 func (mp *m) becomeSpinning() {
831         mp.spinning = true
832         sched.nmspinning.Add(1)
833         sched.needspinning.Store(0)
834 }
835
836 var fastrandseed uintptr
837
838 func fastrandinit() {
839         s := (*[unsafe.Sizeof(fastrandseed)]byte)(unsafe.Pointer(&fastrandseed))[:]
840         getRandomData(s)
841 }
842
843 // Mark gp ready to run.
844 func ready(gp *g, traceskip int, next bool) {
845         if trace.enabled {
846                 traceGoUnpark(gp, traceskip)
847         }
848
849         status := readgstatus(gp)
850
851         // Mark runnable.
852         mp := acquirem() // disable preemption because it can be holding p in a local var
853         if status&^_Gscan != _Gwaiting {
854                 dumpgstatus(gp)
855                 throw("bad g->status in ready")
856         }
857
858         // status is Gwaiting or Gscanwaiting, make Grunnable and put on runq
859         casgstatus(gp, _Gwaiting, _Grunnable)
860         runqput(mp.p.ptr(), gp, next)
861         wakep()
862         releasem(mp)
863 }
864
865 // freezeStopWait is a large value that freezetheworld sets
866 // sched.stopwait to in order to request that all Gs permanently stop.
867 const freezeStopWait = 0x7fffffff
868
869 // freezing is set to non-zero if the runtime is trying to freeze the
870 // world.
871 var freezing uint32
872
873 // Similar to stopTheWorld but best-effort and can be called several times.
874 // There is no reverse operation, used during crashing.
875 // This function must not lock any mutexes.
876 func freezetheworld() {
877         atomic.Store(&freezing, 1)
878         // stopwait and preemption requests can be lost
879         // due to races with concurrently executing threads,
880         // so try several times
881         for i := 0; i < 5; i++ {
882                 // this should tell the scheduler to not start any new goroutines
883                 sched.stopwait = freezeStopWait
884                 sched.gcwaiting.Store(true)
885                 // this should stop running goroutines
886                 if !preemptall() {
887                         break // no running goroutines
888                 }
889                 usleep(1000)
890         }
891         // to be sure
892         usleep(1000)
893         preemptall()
894         usleep(1000)
895 }
896
897 // All reads and writes of g's status go through readgstatus, casgstatus
898 // castogscanstatus, casfrom_Gscanstatus.
899 //
900 //go:nosplit
901 func readgstatus(gp *g) uint32 {
902         return atomic.Load(&gp.atomicstatus)
903 }
904
905 // The Gscanstatuses are acting like locks and this releases them.
906 // If it proves to be a performance hit we should be able to make these
907 // simple atomic stores but for now we are going to throw if
908 // we see an inconsistent state.
909 func casfrom_Gscanstatus(gp *g, oldval, newval uint32) {
910         success := false
911
912         // Check that transition is valid.
913         switch oldval {
914         default:
915                 print("runtime: casfrom_Gscanstatus bad oldval gp=", gp, ", oldval=", hex(oldval), ", newval=", hex(newval), "\n")
916                 dumpgstatus(gp)
917                 throw("casfrom_Gscanstatus:top gp->status is not in scan state")
918         case _Gscanrunnable,
919                 _Gscanwaiting,
920                 _Gscanrunning,
921                 _Gscansyscall,
922                 _Gscanpreempted:
923                 if newval == oldval&^_Gscan {
924                         success = atomic.Cas(&gp.atomicstatus, oldval, newval)
925                 }
926         }
927         if !success {
928                 print("runtime: casfrom_Gscanstatus failed gp=", gp, ", oldval=", hex(oldval), ", newval=", hex(newval), "\n")
929                 dumpgstatus(gp)
930                 throw("casfrom_Gscanstatus: gp->status is not in scan state")
931         }
932         releaseLockRank(lockRankGscan)
933 }
934
935 // This will return false if the gp is not in the expected status and the cas fails.
936 // This acts like a lock acquire while the casfromgstatus acts like a lock release.
937 func castogscanstatus(gp *g, oldval, newval uint32) bool {
938         switch oldval {
939         case _Grunnable,
940                 _Grunning,
941                 _Gwaiting,
942                 _Gsyscall:
943                 if newval == oldval|_Gscan {
944                         r := atomic.Cas(&gp.atomicstatus, oldval, newval)
945                         if r {
946                                 acquireLockRank(lockRankGscan)
947                         }
948                         return r
949
950                 }
951         }
952         print("runtime: castogscanstatus oldval=", hex(oldval), " newval=", hex(newval), "\n")
953         throw("castogscanstatus")
954         panic("not reached")
955 }
956
957 // If asked to move to or from a Gscanstatus this will throw. Use the castogscanstatus
958 // and casfrom_Gscanstatus instead.
959 // casgstatus will loop if the g->atomicstatus is in a Gscan status until the routine that
960 // put it in the Gscan state is finished.
961 //
962 //go:nosplit
963 func casgstatus(gp *g, oldval, newval uint32) {
964         if (oldval&_Gscan != 0) || (newval&_Gscan != 0) || oldval == newval {
965                 systemstack(func() {
966                         print("runtime: casgstatus: oldval=", hex(oldval), " newval=", hex(newval), "\n")
967                         throw("casgstatus: bad incoming values")
968                 })
969         }
970
971         acquireLockRank(lockRankGscan)
972         releaseLockRank(lockRankGscan)
973
974         // See https://golang.org/cl/21503 for justification of the yield delay.
975         const yieldDelay = 5 * 1000
976         var nextYield int64
977
978         // loop if gp->atomicstatus is in a scan state giving
979         // GC time to finish and change the state to oldval.
980         for i := 0; !atomic.Cas(&gp.atomicstatus, oldval, newval); i++ {
981                 if oldval == _Gwaiting && gp.atomicstatus == _Grunnable {
982                         throw("casgstatus: waiting for Gwaiting but is Grunnable")
983                 }
984                 if i == 0 {
985                         nextYield = nanotime() + yieldDelay
986                 }
987                 if nanotime() < nextYield {
988                         for x := 0; x < 10 && gp.atomicstatus != oldval; x++ {
989                                 procyield(1)
990                         }
991                 } else {
992                         osyield()
993                         nextYield = nanotime() + yieldDelay/2
994                 }
995         }
996
997         // Handle tracking for scheduling latencies.
998         if oldval == _Grunning {
999                 // Track every 8th time a goroutine transitions out of running.
1000                 if gp.trackingSeq%gTrackingPeriod == 0 {
1001                         gp.tracking = true
1002                 }
1003                 gp.trackingSeq++
1004         }
1005         if gp.tracking {
1006                 if oldval == _Grunnable {
1007                         // We transitioned out of runnable, so measure how much
1008                         // time we spent in this state and add it to
1009                         // runnableTime.
1010                         now := nanotime()
1011                         gp.runnableTime += now - gp.runnableStamp
1012                         gp.runnableStamp = 0
1013                 }
1014                 if newval == _Grunnable {
1015                         // We just transitioned into runnable, so record what
1016                         // time that happened.
1017                         now := nanotime()
1018                         gp.runnableStamp = now
1019                 } else if newval == _Grunning {
1020                         // We're transitioning into running, so turn off
1021                         // tracking and record how much time we spent in
1022                         // runnable.
1023                         gp.tracking = false
1024                         sched.timeToRun.record(gp.runnableTime)
1025                         gp.runnableTime = 0
1026                 }
1027         }
1028 }
1029
1030 // casgstatus(gp, oldstatus, Gcopystack), assuming oldstatus is Gwaiting or Grunnable.
1031 // Returns old status. Cannot call casgstatus directly, because we are racing with an
1032 // async wakeup that might come in from netpoll. If we see Gwaiting from the readgstatus,
1033 // it might have become Grunnable by the time we get to the cas. If we called casgstatus,
1034 // it would loop waiting for the status to go back to Gwaiting, which it never will.
1035 //
1036 //go:nosplit
1037 func casgcopystack(gp *g) uint32 {
1038         for {
1039                 oldstatus := readgstatus(gp) &^ _Gscan
1040                 if oldstatus != _Gwaiting && oldstatus != _Grunnable {
1041                         throw("copystack: bad status, not Gwaiting or Grunnable")
1042                 }
1043                 if atomic.Cas(&gp.atomicstatus, oldstatus, _Gcopystack) {
1044                         return oldstatus
1045                 }
1046         }
1047 }
1048
1049 // casGToPreemptScan transitions gp from _Grunning to _Gscan|_Gpreempted.
1050 //
1051 // TODO(austin): This is the only status operation that both changes
1052 // the status and locks the _Gscan bit. Rethink this.
1053 func casGToPreemptScan(gp *g, old, new uint32) {
1054         if old != _Grunning || new != _Gscan|_Gpreempted {
1055                 throw("bad g transition")
1056         }
1057         acquireLockRank(lockRankGscan)
1058         for !atomic.Cas(&gp.atomicstatus, _Grunning, _Gscan|_Gpreempted) {
1059         }
1060 }
1061
1062 // casGFromPreempted attempts to transition gp from _Gpreempted to
1063 // _Gwaiting. If successful, the caller is responsible for
1064 // re-scheduling gp.
1065 func casGFromPreempted(gp *g, old, new uint32) bool {
1066         if old != _Gpreempted || new != _Gwaiting {
1067                 throw("bad g transition")
1068         }
1069         return atomic.Cas(&gp.atomicstatus, _Gpreempted, _Gwaiting)
1070 }
1071
1072 // stopTheWorld stops all P's from executing goroutines, interrupting
1073 // all goroutines at GC safe points and records reason as the reason
1074 // for the stop. On return, only the current goroutine's P is running.
1075 // stopTheWorld must not be called from a system stack and the caller
1076 // must not hold worldsema. The caller must call startTheWorld when
1077 // other P's should resume execution.
1078 //
1079 // stopTheWorld is safe for multiple goroutines to call at the
1080 // same time. Each will execute its own stop, and the stops will
1081 // be serialized.
1082 //
1083 // This is also used by routines that do stack dumps. If the system is
1084 // in panic or being exited, this may not reliably stop all
1085 // goroutines.
1086 func stopTheWorld(reason string) {
1087         semacquire(&worldsema)
1088         gp := getg()
1089         gp.m.preemptoff = reason
1090         systemstack(func() {
1091                 // Mark the goroutine which called stopTheWorld preemptible so its
1092                 // stack may be scanned.
1093                 // This lets a mark worker scan us while we try to stop the world
1094                 // since otherwise we could get in a mutual preemption deadlock.
1095                 // We must not modify anything on the G stack because a stack shrink
1096                 // may occur. A stack shrink is otherwise OK though because in order
1097                 // to return from this function (and to leave the system stack) we
1098                 // must have preempted all goroutines, including any attempting
1099                 // to scan our stack, in which case, any stack shrinking will
1100                 // have already completed by the time we exit.
1101                 casgstatus(gp, _Grunning, _Gwaiting)
1102                 stopTheWorldWithSema()
1103                 casgstatus(gp, _Gwaiting, _Grunning)
1104         })
1105 }
1106
1107 // startTheWorld undoes the effects of stopTheWorld.
1108 func startTheWorld() {
1109         systemstack(func() { startTheWorldWithSema(false) })
1110
1111         // worldsema must be held over startTheWorldWithSema to ensure
1112         // gomaxprocs cannot change while worldsema is held.
1113         //
1114         // Release worldsema with direct handoff to the next waiter, but
1115         // acquirem so that semrelease1 doesn't try to yield our time.
1116         //
1117         // Otherwise if e.g. ReadMemStats is being called in a loop,
1118         // it might stomp on other attempts to stop the world, such as
1119         // for starting or ending GC. The operation this blocks is
1120         // so heavy-weight that we should just try to be as fair as
1121         // possible here.
1122         //
1123         // We don't want to just allow us to get preempted between now
1124         // and releasing the semaphore because then we keep everyone
1125         // (including, for example, GCs) waiting longer.
1126         mp := acquirem()
1127         mp.preemptoff = ""
1128         semrelease1(&worldsema, true, 0)
1129         releasem(mp)
1130 }
1131
1132 // stopTheWorldGC has the same effect as stopTheWorld, but blocks
1133 // until the GC is not running. It also blocks a GC from starting
1134 // until startTheWorldGC is called.
1135 func stopTheWorldGC(reason string) {
1136         semacquire(&gcsema)
1137         stopTheWorld(reason)
1138 }
1139
1140 // startTheWorldGC undoes the effects of stopTheWorldGC.
1141 func startTheWorldGC() {
1142         startTheWorld()
1143         semrelease(&gcsema)
1144 }
1145
1146 // Holding worldsema grants an M the right to try to stop the world.
1147 var worldsema uint32 = 1
1148
1149 // Holding gcsema grants the M the right to block a GC, and blocks
1150 // until the current GC is done. In particular, it prevents gomaxprocs
1151 // from changing concurrently.
1152 //
1153 // TODO(mknyszek): Once gomaxprocs and the execution tracer can handle
1154 // being changed/enabled during a GC, remove this.
1155 var gcsema uint32 = 1
1156
1157 // stopTheWorldWithSema is the core implementation of stopTheWorld.
1158 // The caller is responsible for acquiring worldsema and disabling
1159 // preemption first and then should stopTheWorldWithSema on the system
1160 // stack:
1161 //
1162 //      semacquire(&worldsema, 0)
1163 //      m.preemptoff = "reason"
1164 //      systemstack(stopTheWorldWithSema)
1165 //
1166 // When finished, the caller must either call startTheWorld or undo
1167 // these three operations separately:
1168 //
1169 //      m.preemptoff = ""
1170 //      systemstack(startTheWorldWithSema)
1171 //      semrelease(&worldsema)
1172 //
1173 // It is allowed to acquire worldsema once and then execute multiple
1174 // startTheWorldWithSema/stopTheWorldWithSema pairs.
1175 // Other P's are able to execute between successive calls to
1176 // startTheWorldWithSema and stopTheWorldWithSema.
1177 // Holding worldsema causes any other goroutines invoking
1178 // stopTheWorld to block.
1179 func stopTheWorldWithSema() {
1180         gp := getg()
1181
1182         // If we hold a lock, then we won't be able to stop another M
1183         // that is blocked trying to acquire the lock.
1184         if gp.m.locks > 0 {
1185                 throw("stopTheWorld: holding locks")
1186         }
1187
1188         lock(&sched.lock)
1189         sched.stopwait = gomaxprocs
1190         sched.gcwaiting.Store(true)
1191         preemptall()
1192         // stop current P
1193         gp.m.p.ptr().status = _Pgcstop // Pgcstop is only diagnostic.
1194         sched.stopwait--
1195         // try to retake all P's in Psyscall status
1196         for _, pp := range allp {
1197                 s := pp.status
1198                 if s == _Psyscall && atomic.Cas(&pp.status, s, _Pgcstop) {
1199                         if trace.enabled {
1200                                 traceGoSysBlock(pp)
1201                                 traceProcStop(pp)
1202                         }
1203                         pp.syscalltick++
1204                         sched.stopwait--
1205                 }
1206         }
1207         // stop idle P's
1208         now := nanotime()
1209         for {
1210                 pp, _ := pidleget(now)
1211                 if pp == nil {
1212                         break
1213                 }
1214                 pp.status = _Pgcstop
1215                 sched.stopwait--
1216         }
1217         wait := sched.stopwait > 0
1218         unlock(&sched.lock)
1219
1220         // wait for remaining P's to stop voluntarily
1221         if wait {
1222                 for {
1223                         // wait for 100us, then try to re-preempt in case of any races
1224                         if notetsleep(&sched.stopnote, 100*1000) {
1225                                 noteclear(&sched.stopnote)
1226                                 break
1227                         }
1228                         preemptall()
1229                 }
1230         }
1231
1232         // sanity checks
1233         bad := ""
1234         if sched.stopwait != 0 {
1235                 bad = "stopTheWorld: not stopped (stopwait != 0)"
1236         } else {
1237                 for _, pp := range allp {
1238                         if pp.status != _Pgcstop {
1239                                 bad = "stopTheWorld: not stopped (status != _Pgcstop)"
1240                         }
1241                 }
1242         }
1243         if atomic.Load(&freezing) != 0 {
1244                 // Some other thread is panicking. This can cause the
1245                 // sanity checks above to fail if the panic happens in
1246                 // the signal handler on a stopped thread. Either way,
1247                 // we should halt this thread.
1248                 lock(&deadlock)
1249                 lock(&deadlock)
1250         }
1251         if bad != "" {
1252                 throw(bad)
1253         }
1254
1255         worldStopped()
1256 }
1257
1258 func startTheWorldWithSema(emitTraceEvent bool) int64 {
1259         assertWorldStopped()
1260
1261         mp := acquirem() // disable preemption because it can be holding p in a local var
1262         if netpollinited() {
1263                 list := netpoll(0) // non-blocking
1264                 injectglist(&list)
1265         }
1266         lock(&sched.lock)
1267
1268         procs := gomaxprocs
1269         if newprocs != 0 {
1270                 procs = newprocs
1271                 newprocs = 0
1272         }
1273         p1 := procresize(procs)
1274         sched.gcwaiting.Store(false)
1275         if sched.sysmonwait.Load() {
1276                 sched.sysmonwait.Store(false)
1277                 notewakeup(&sched.sysmonnote)
1278         }
1279         unlock(&sched.lock)
1280
1281         worldStarted()
1282
1283         for p1 != nil {
1284                 p := p1
1285                 p1 = p1.link.ptr()
1286                 if p.m != 0 {
1287                         mp := p.m.ptr()
1288                         p.m = 0
1289                         if mp.nextp != 0 {
1290                                 throw("startTheWorld: inconsistent mp->nextp")
1291                         }
1292                         mp.nextp.set(p)
1293                         notewakeup(&mp.park)
1294                 } else {
1295                         // Start M to run P.  Do not start another M below.
1296                         newm(nil, p, -1)
1297                 }
1298         }
1299
1300         // Capture start-the-world time before doing clean-up tasks.
1301         startTime := nanotime()
1302         if emitTraceEvent {
1303                 traceGCSTWDone()
1304         }
1305
1306         // Wakeup an additional proc in case we have excessive runnable goroutines
1307         // in local queues or in the global queue. If we don't, the proc will park itself.
1308         // If we have lots of excessive work, resetspinning will unpark additional procs as necessary.
1309         wakep()
1310
1311         releasem(mp)
1312
1313         return startTime
1314 }
1315
1316 // usesLibcall indicates whether this runtime performs system calls
1317 // via libcall.
1318 func usesLibcall() bool {
1319         switch GOOS {
1320         case "aix", "darwin", "illumos", "ios", "solaris", "windows":
1321                 return true
1322         case "openbsd":
1323                 return GOARCH == "386" || GOARCH == "amd64" || GOARCH == "arm" || GOARCH == "arm64"
1324         }
1325         return false
1326 }
1327
1328 // mStackIsSystemAllocated indicates whether this runtime starts on a
1329 // system-allocated stack.
1330 func mStackIsSystemAllocated() bool {
1331         switch GOOS {
1332         case "aix", "darwin", "plan9", "illumos", "ios", "solaris", "windows":
1333                 return true
1334         case "openbsd":
1335                 switch GOARCH {
1336                 case "386", "amd64", "arm", "arm64":
1337                         return true
1338                 }
1339         }
1340         return false
1341 }
1342
1343 // mstart is the entry-point for new Ms.
1344 // It is written in assembly, uses ABI0, is marked TOPFRAME, and calls mstart0.
1345 func mstart()
1346
1347 // mstart0 is the Go entry-point for new Ms.
1348 // This must not split the stack because we may not even have stack
1349 // bounds set up yet.
1350 //
1351 // May run during STW (because it doesn't have a P yet), so write
1352 // barriers are not allowed.
1353 //
1354 //go:nosplit
1355 //go:nowritebarrierrec
1356 func mstart0() {
1357         gp := getg()
1358
1359         osStack := gp.stack.lo == 0
1360         if osStack {
1361                 // Initialize stack bounds from system stack.
1362                 // Cgo may have left stack size in stack.hi.
1363                 // minit may update the stack bounds.
1364                 //
1365                 // Note: these bounds may not be very accurate.
1366                 // We set hi to &size, but there are things above
1367                 // it. The 1024 is supposed to compensate this,
1368                 // but is somewhat arbitrary.
1369                 size := gp.stack.hi
1370                 if size == 0 {
1371                         size = 8192 * sys.StackGuardMultiplier
1372                 }
1373                 gp.stack.hi = uintptr(noescape(unsafe.Pointer(&size)))
1374                 gp.stack.lo = gp.stack.hi - size + 1024
1375         }
1376         // Initialize stack guard so that we can start calling regular
1377         // Go code.
1378         gp.stackguard0 = gp.stack.lo + _StackGuard
1379         // This is the g0, so we can also call go:systemstack
1380         // functions, which check stackguard1.
1381         gp.stackguard1 = gp.stackguard0
1382         mstart1()
1383
1384         // Exit this thread.
1385         if mStackIsSystemAllocated() {
1386                 // Windows, Solaris, illumos, Darwin, AIX and Plan 9 always system-allocate
1387                 // the stack, but put it in gp.stack before mstart,
1388                 // so the logic above hasn't set osStack yet.
1389                 osStack = true
1390         }
1391         mexit(osStack)
1392 }
1393
1394 // The go:noinline is to guarantee the getcallerpc/getcallersp below are safe,
1395 // so that we can set up g0.sched to return to the call of mstart1 above.
1396 //
1397 //go:noinline
1398 func mstart1() {
1399         gp := getg()
1400
1401         if gp != gp.m.g0 {
1402                 throw("bad runtime·mstart")
1403         }
1404
1405         // Set up m.g0.sched as a label returning to just
1406         // after the mstart1 call in mstart0 above, for use by goexit0 and mcall.
1407         // We're never coming back to mstart1 after we call schedule,
1408         // so other calls can reuse the current frame.
1409         // And goexit0 does a gogo that needs to return from mstart1
1410         // and let mstart0 exit the thread.
1411         gp.sched.g = guintptr(unsafe.Pointer(gp))
1412         gp.sched.pc = getcallerpc()
1413         gp.sched.sp = getcallersp()
1414
1415         asminit()
1416         minit()
1417
1418         // Install signal handlers; after minit so that minit can
1419         // prepare the thread to be able to handle the signals.
1420         if gp.m == &m0 {
1421                 mstartm0()
1422         }
1423
1424         if fn := gp.m.mstartfn; fn != nil {
1425                 fn()
1426         }
1427
1428         if gp.m != &m0 {
1429                 acquirep(gp.m.nextp.ptr())
1430                 gp.m.nextp = 0
1431         }
1432         schedule()
1433 }
1434
1435 // mstartm0 implements part of mstart1 that only runs on the m0.
1436 //
1437 // Write barriers are allowed here because we know the GC can't be
1438 // running yet, so they'll be no-ops.
1439 //
1440 //go:yeswritebarrierrec
1441 func mstartm0() {
1442         // Create an extra M for callbacks on threads not created by Go.
1443         // An extra M is also needed on Windows for callbacks created by
1444         // syscall.NewCallback. See issue #6751 for details.
1445         if (iscgo || GOOS == "windows") && !cgoHasExtraM {
1446                 cgoHasExtraM = true
1447                 newextram()
1448         }
1449         initsig(false)
1450 }
1451
1452 // mPark causes a thread to park itself, returning once woken.
1453 //
1454 //go:nosplit
1455 func mPark() {
1456         gp := getg()
1457         notesleep(&gp.m.park)
1458         noteclear(&gp.m.park)
1459 }
1460
1461 // mexit tears down and exits the current thread.
1462 //
1463 // Don't call this directly to exit the thread, since it must run at
1464 // the top of the thread stack. Instead, use gogo(&gp.m.g0.sched) to
1465 // unwind the stack to the point that exits the thread.
1466 //
1467 // It is entered with m.p != nil, so write barriers are allowed. It
1468 // will release the P before exiting.
1469 //
1470 //go:yeswritebarrierrec
1471 func mexit(osStack bool) {
1472         mp := getg().m
1473
1474         if mp == &m0 {
1475                 // This is the main thread. Just wedge it.
1476                 //
1477                 // On Linux, exiting the main thread puts the process
1478                 // into a non-waitable zombie state. On Plan 9,
1479                 // exiting the main thread unblocks wait even though
1480                 // other threads are still running. On Solaris we can
1481                 // neither exitThread nor return from mstart. Other
1482                 // bad things probably happen on other platforms.
1483                 //
1484                 // We could try to clean up this M more before wedging
1485                 // it, but that complicates signal handling.
1486                 handoffp(releasep())
1487                 lock(&sched.lock)
1488                 sched.nmfreed++
1489                 checkdead()
1490                 unlock(&sched.lock)
1491                 mPark()
1492                 throw("locked m0 woke up")
1493         }
1494
1495         sigblock(true)
1496         unminit()
1497
1498         // Free the gsignal stack.
1499         if mp.gsignal != nil {
1500                 stackfree(mp.gsignal.stack)
1501                 // On some platforms, when calling into VDSO (e.g. nanotime)
1502                 // we store our g on the gsignal stack, if there is one.
1503                 // Now the stack is freed, unlink it from the m, so we
1504                 // won't write to it when calling VDSO code.
1505                 mp.gsignal = nil
1506         }
1507
1508         // Remove m from allm.
1509         lock(&sched.lock)
1510         for pprev := &allm; *pprev != nil; pprev = &(*pprev).alllink {
1511                 if *pprev == mp {
1512                         *pprev = mp.alllink
1513                         goto found
1514                 }
1515         }
1516         throw("m not found in allm")
1517 found:
1518         if !osStack {
1519                 // Delay reaping m until it's done with the stack.
1520                 //
1521                 // If this is using an OS stack, the OS will free it
1522                 // so there's no need for reaping.
1523                 atomic.Store(&mp.freeWait, 1)
1524                 // Put m on the free list, though it will not be reaped until
1525                 // freeWait is 0. Note that the free list must not be linked
1526                 // through alllink because some functions walk allm without
1527                 // locking, so may be using alllink.
1528                 mp.freelink = sched.freem
1529                 sched.freem = mp
1530         }
1531         unlock(&sched.lock)
1532
1533         atomic.Xadd64(&ncgocall, int64(mp.ncgocall))
1534
1535         // Release the P.
1536         handoffp(releasep())
1537         // After this point we must not have write barriers.
1538
1539         // Invoke the deadlock detector. This must happen after
1540         // handoffp because it may have started a new M to take our
1541         // P's work.
1542         lock(&sched.lock)
1543         sched.nmfreed++
1544         checkdead()
1545         unlock(&sched.lock)
1546
1547         if GOOS == "darwin" || GOOS == "ios" {
1548                 // Make sure pendingPreemptSignals is correct when an M exits.
1549                 // For #41702.
1550                 if atomic.Load(&mp.signalPending) != 0 {
1551                         pendingPreemptSignals.Add(-1)
1552                 }
1553         }
1554
1555         // Destroy all allocated resources. After this is called, we may no
1556         // longer take any locks.
1557         mdestroy(mp)
1558
1559         if osStack {
1560                 // Return from mstart and let the system thread
1561                 // library free the g0 stack and terminate the thread.
1562                 return
1563         }
1564
1565         // mstart is the thread's entry point, so there's nothing to
1566         // return to. Exit the thread directly. exitThread will clear
1567         // m.freeWait when it's done with the stack and the m can be
1568         // reaped.
1569         exitThread(&mp.freeWait)
1570 }
1571
1572 // forEachP calls fn(p) for every P p when p reaches a GC safe point.
1573 // If a P is currently executing code, this will bring the P to a GC
1574 // safe point and execute fn on that P. If the P is not executing code
1575 // (it is idle or in a syscall), this will call fn(p) directly while
1576 // preventing the P from exiting its state. This does not ensure that
1577 // fn will run on every CPU executing Go code, but it acts as a global
1578 // memory barrier. GC uses this as a "ragged barrier."
1579 //
1580 // The caller must hold worldsema.
1581 //
1582 //go:systemstack
1583 func forEachP(fn func(*p)) {
1584         mp := acquirem()
1585         pp := getg().m.p.ptr()
1586
1587         lock(&sched.lock)
1588         if sched.safePointWait != 0 {
1589                 throw("forEachP: sched.safePointWait != 0")
1590         }
1591         sched.safePointWait = gomaxprocs - 1
1592         sched.safePointFn = fn
1593
1594         // Ask all Ps to run the safe point function.
1595         for _, p2 := range allp {
1596                 if p2 != pp {
1597                         atomic.Store(&p2.runSafePointFn, 1)
1598                 }
1599         }
1600         preemptall()
1601
1602         // Any P entering _Pidle or _Psyscall from now on will observe
1603         // p.runSafePointFn == 1 and will call runSafePointFn when
1604         // changing its status to _Pidle/_Psyscall.
1605
1606         // Run safe point function for all idle Ps. sched.pidle will
1607         // not change because we hold sched.lock.
1608         for p := sched.pidle.ptr(); p != nil; p = p.link.ptr() {
1609                 if atomic.Cas(&p.runSafePointFn, 1, 0) {
1610                         fn(p)
1611                         sched.safePointWait--
1612                 }
1613         }
1614
1615         wait := sched.safePointWait > 0
1616         unlock(&sched.lock)
1617
1618         // Run fn for the current P.
1619         fn(pp)
1620
1621         // Force Ps currently in _Psyscall into _Pidle and hand them
1622         // off to induce safe point function execution.
1623         for _, p2 := range allp {
1624                 s := p2.status
1625                 if s == _Psyscall && p2.runSafePointFn == 1 && atomic.Cas(&p2.status, s, _Pidle) {
1626                         if trace.enabled {
1627                                 traceGoSysBlock(p2)
1628                                 traceProcStop(p2)
1629                         }
1630                         p2.syscalltick++
1631                         handoffp(p2)
1632                 }
1633         }
1634
1635         // Wait for remaining Ps to run fn.
1636         if wait {
1637                 for {
1638                         // Wait for 100us, then try to re-preempt in
1639                         // case of any races.
1640                         //
1641                         // Requires system stack.
1642                         if notetsleep(&sched.safePointNote, 100*1000) {
1643                                 noteclear(&sched.safePointNote)
1644                                 break
1645                         }
1646                         preemptall()
1647                 }
1648         }
1649         if sched.safePointWait != 0 {
1650                 throw("forEachP: not done")
1651         }
1652         for _, p2 := range allp {
1653                 if p2.runSafePointFn != 0 {
1654                         throw("forEachP: P did not run fn")
1655                 }
1656         }
1657
1658         lock(&sched.lock)
1659         sched.safePointFn = nil
1660         unlock(&sched.lock)
1661         releasem(mp)
1662 }
1663
1664 // runSafePointFn runs the safe point function, if any, for this P.
1665 // This should be called like
1666 //
1667 //      if getg().m.p.runSafePointFn != 0 {
1668 //          runSafePointFn()
1669 //      }
1670 //
1671 // runSafePointFn must be checked on any transition in to _Pidle or
1672 // _Psyscall to avoid a race where forEachP sees that the P is running
1673 // just before the P goes into _Pidle/_Psyscall and neither forEachP
1674 // nor the P run the safe-point function.
1675 func runSafePointFn() {
1676         p := getg().m.p.ptr()
1677         // Resolve the race between forEachP running the safe-point
1678         // function on this P's behalf and this P running the
1679         // safe-point function directly.
1680         if !atomic.Cas(&p.runSafePointFn, 1, 0) {
1681                 return
1682         }
1683         sched.safePointFn(p)
1684         lock(&sched.lock)
1685         sched.safePointWait--
1686         if sched.safePointWait == 0 {
1687                 notewakeup(&sched.safePointNote)
1688         }
1689         unlock(&sched.lock)
1690 }
1691
1692 // When running with cgo, we call _cgo_thread_start
1693 // to start threads for us so that we can play nicely with
1694 // foreign code.
1695 var cgoThreadStart unsafe.Pointer
1696
1697 type cgothreadstart struct {
1698         g   guintptr
1699         tls *uint64
1700         fn  unsafe.Pointer
1701 }
1702
1703 // Allocate a new m unassociated with any thread.
1704 // Can use p for allocation context if needed.
1705 // fn is recorded as the new m's m.mstartfn.
1706 // id is optional pre-allocated m ID. Omit by passing -1.
1707 //
1708 // This function is allowed to have write barriers even if the caller
1709 // isn't because it borrows pp.
1710 //
1711 //go:yeswritebarrierrec
1712 func allocm(pp *p, fn func(), id int64) *m {
1713         allocmLock.rlock()
1714
1715         // The caller owns pp, but we may borrow (i.e., acquirep) it. We must
1716         // disable preemption to ensure it is not stolen, which would make the
1717         // caller lose ownership.
1718         acquirem()
1719
1720         gp := getg()
1721         if gp.m.p == 0 {
1722                 acquirep(pp) // temporarily borrow p for mallocs in this function
1723         }
1724
1725         // Release the free M list. We need to do this somewhere and
1726         // this may free up a stack we can use.
1727         if sched.freem != nil {
1728                 lock(&sched.lock)
1729                 var newList *m
1730                 for freem := sched.freem; freem != nil; {
1731                         if freem.freeWait != 0 {
1732                                 next := freem.freelink
1733                                 freem.freelink = newList
1734                                 newList = freem
1735                                 freem = next
1736                                 continue
1737                         }
1738                         // stackfree must be on the system stack, but allocm is
1739                         // reachable off the system stack transitively from
1740                         // startm.
1741                         systemstack(func() {
1742                                 stackfree(freem.g0.stack)
1743                         })
1744                         freem = freem.freelink
1745                 }
1746                 sched.freem = newList
1747                 unlock(&sched.lock)
1748         }
1749
1750         mp := new(m)
1751         mp.mstartfn = fn
1752         mcommoninit(mp, id)
1753
1754         // In case of cgo or Solaris or illumos or Darwin, pthread_create will make us a stack.
1755         // Windows and Plan 9 will layout sched stack on OS stack.
1756         if iscgo || mStackIsSystemAllocated() {
1757                 mp.g0 = malg(-1)
1758         } else {
1759                 mp.g0 = malg(8192 * sys.StackGuardMultiplier)
1760         }
1761         mp.g0.m = mp
1762
1763         if pp == gp.m.p.ptr() {
1764                 releasep()
1765         }
1766
1767         releasem(gp.m)
1768         allocmLock.runlock()
1769         return mp
1770 }
1771
1772 // needm is called when a cgo callback happens on a
1773 // thread without an m (a thread not created by Go).
1774 // In this case, needm is expected to find an m to use
1775 // and return with m, g initialized correctly.
1776 // Since m and g are not set now (likely nil, but see below)
1777 // needm is limited in what routines it can call. In particular
1778 // it can only call nosplit functions (textflag 7) and cannot
1779 // do any scheduling that requires an m.
1780 //
1781 // In order to avoid needing heavy lifting here, we adopt
1782 // the following strategy: there is a stack of available m's
1783 // that can be stolen. Using compare-and-swap
1784 // to pop from the stack has ABA races, so we simulate
1785 // a lock by doing an exchange (via Casuintptr) to steal the stack
1786 // head and replace the top pointer with MLOCKED (1).
1787 // This serves as a simple spin lock that we can use even
1788 // without an m. The thread that locks the stack in this way
1789 // unlocks the stack by storing a valid stack head pointer.
1790 //
1791 // In order to make sure that there is always an m structure
1792 // available to be stolen, we maintain the invariant that there
1793 // is always one more than needed. At the beginning of the
1794 // program (if cgo is in use) the list is seeded with a single m.
1795 // If needm finds that it has taken the last m off the list, its job
1796 // is - once it has installed its own m so that it can do things like
1797 // allocate memory - to create a spare m and put it on the list.
1798 //
1799 // Each of these extra m's also has a g0 and a curg that are
1800 // pressed into service as the scheduling stack and current
1801 // goroutine for the duration of the cgo callback.
1802 //
1803 // When the callback is done with the m, it calls dropm to
1804 // put the m back on the list.
1805 //
1806 //go:nosplit
1807 func needm() {
1808         if (iscgo || GOOS == "windows") && !cgoHasExtraM {
1809                 // Can happen if C/C++ code calls Go from a global ctor.
1810                 // Can also happen on Windows if a global ctor uses a
1811                 // callback created by syscall.NewCallback. See issue #6751
1812                 // for details.
1813                 //
1814                 // Can not throw, because scheduler is not initialized yet.
1815                 write(2, unsafe.Pointer(&earlycgocallback[0]), int32(len(earlycgocallback)))
1816                 exit(1)
1817         }
1818
1819         // Save and block signals before getting an M.
1820         // The signal handler may call needm itself,
1821         // and we must avoid a deadlock. Also, once g is installed,
1822         // any incoming signals will try to execute,
1823         // but we won't have the sigaltstack settings and other data
1824         // set up appropriately until the end of minit, which will
1825         // unblock the signals. This is the same dance as when
1826         // starting a new m to run Go code via newosproc.
1827         var sigmask sigset
1828         sigsave(&sigmask)
1829         sigblock(false)
1830
1831         // Lock extra list, take head, unlock popped list.
1832         // nilokay=false is safe here because of the invariant above,
1833         // that the extra list always contains or will soon contain
1834         // at least one m.
1835         mp := lockextra(false)
1836
1837         // Set needextram when we've just emptied the list,
1838         // so that the eventual call into cgocallbackg will
1839         // allocate a new m for the extra list. We delay the
1840         // allocation until then so that it can be done
1841         // after exitsyscall makes sure it is okay to be
1842         // running at all (that is, there's no garbage collection
1843         // running right now).
1844         mp.needextram = mp.schedlink == 0
1845         extraMCount--
1846         unlockextra(mp.schedlink.ptr())
1847
1848         // Store the original signal mask for use by minit.
1849         mp.sigmask = sigmask
1850
1851         // Install TLS on some platforms (previously setg
1852         // would do this if necessary).
1853         osSetupTLS(mp)
1854
1855         // Install g (= m->g0) and set the stack bounds
1856         // to match the current stack. We don't actually know
1857         // how big the stack is, like we don't know how big any
1858         // scheduling stack is, but we assume there's at least 32 kB,
1859         // which is more than enough for us.
1860         setg(mp.g0)
1861         gp := getg()
1862         gp.stack.hi = getcallersp() + 1024
1863         gp.stack.lo = getcallersp() - 32*1024
1864         gp.stackguard0 = gp.stack.lo + _StackGuard
1865
1866         // Initialize this thread to use the m.
1867         asminit()
1868         minit()
1869
1870         // mp.curg is now a real goroutine.
1871         casgstatus(mp.curg, _Gdead, _Gsyscall)
1872         sched.ngsys.Add(-1)
1873 }
1874
1875 var earlycgocallback = []byte("fatal error: cgo callback before cgo call\n")
1876
1877 // newextram allocates m's and puts them on the extra list.
1878 // It is called with a working local m, so that it can do things
1879 // like call schedlock and allocate.
1880 func newextram() {
1881         c := atomic.Xchg(&extraMWaiters, 0)
1882         if c > 0 {
1883                 for i := uint32(0); i < c; i++ {
1884                         oneNewExtraM()
1885                 }
1886         } else {
1887                 // Make sure there is at least one extra M.
1888                 mp := lockextra(true)
1889                 unlockextra(mp)
1890                 if mp == nil {
1891                         oneNewExtraM()
1892                 }
1893         }
1894 }
1895
1896 // oneNewExtraM allocates an m and puts it on the extra list.
1897 func oneNewExtraM() {
1898         // Create extra goroutine locked to extra m.
1899         // The goroutine is the context in which the cgo callback will run.
1900         // The sched.pc will never be returned to, but setting it to
1901         // goexit makes clear to the traceback routines where
1902         // the goroutine stack ends.
1903         mp := allocm(nil, nil, -1)
1904         gp := malg(4096)
1905         gp.sched.pc = abi.FuncPCABI0(goexit) + sys.PCQuantum
1906         gp.sched.sp = gp.stack.hi
1907         gp.sched.sp -= 4 * goarch.PtrSize // extra space in case of reads slightly beyond frame
1908         gp.sched.lr = 0
1909         gp.sched.g = guintptr(unsafe.Pointer(gp))
1910         gp.syscallpc = gp.sched.pc
1911         gp.syscallsp = gp.sched.sp
1912         gp.stktopsp = gp.sched.sp
1913         // malg returns status as _Gidle. Change to _Gdead before
1914         // adding to allg where GC can see it. We use _Gdead to hide
1915         // this from tracebacks and stack scans since it isn't a
1916         // "real" goroutine until needm grabs it.
1917         casgstatus(gp, _Gidle, _Gdead)
1918         gp.m = mp
1919         mp.curg = gp
1920         mp.isextra = true
1921         mp.lockedInt++
1922         mp.lockedg.set(gp)
1923         gp.lockedm.set(mp)
1924         gp.goid = sched.goidgen.Add(1)
1925         if raceenabled {
1926                 gp.racectx = racegostart(abi.FuncPCABIInternal(newextram) + sys.PCQuantum)
1927         }
1928         if trace.enabled {
1929                 // trigger two trace events for the locked g in the extra m,
1930                 // since the next event of the g will be traceEvGoSysExit in exitsyscall,
1931                 // while calling from C thread to Go.
1932                 traceGoCreate(gp, 0) // no start pc
1933                 gp.traceseq++
1934                 traceEvent(traceEvGoInSyscall, -1, gp.goid)
1935         }
1936         // put on allg for garbage collector
1937         allgadd(gp)
1938
1939         // gp is now on the allg list, but we don't want it to be
1940         // counted by gcount. It would be more "proper" to increment
1941         // sched.ngfree, but that requires locking. Incrementing ngsys
1942         // has the same effect.
1943         sched.ngsys.Add(1)
1944
1945         // Add m to the extra list.
1946         mnext := lockextra(true)
1947         mp.schedlink.set(mnext)
1948         extraMCount++
1949         unlockextra(mp)
1950 }
1951
1952 // dropm is called when a cgo callback has called needm but is now
1953 // done with the callback and returning back into the non-Go thread.
1954 // It puts the current m back onto the extra list.
1955 //
1956 // The main expense here is the call to signalstack to release the
1957 // m's signal stack, and then the call to needm on the next callback
1958 // from this thread. It is tempting to try to save the m for next time,
1959 // which would eliminate both these costs, but there might not be
1960 // a next time: the current thread (which Go does not control) might exit.
1961 // If we saved the m for that thread, there would be an m leak each time
1962 // such a thread exited. Instead, we acquire and release an m on each
1963 // call. These should typically not be scheduling operations, just a few
1964 // atomics, so the cost should be small.
1965 //
1966 // TODO(rsc): An alternative would be to allocate a dummy pthread per-thread
1967 // variable using pthread_key_create. Unlike the pthread keys we already use
1968 // on OS X, this dummy key would never be read by Go code. It would exist
1969 // only so that we could register at thread-exit-time destructor.
1970 // That destructor would put the m back onto the extra list.
1971 // This is purely a performance optimization. The current version,
1972 // in which dropm happens on each cgo call, is still correct too.
1973 // We may have to keep the current version on systems with cgo
1974 // but without pthreads, like Windows.
1975 func dropm() {
1976         // Clear m and g, and return m to the extra list.
1977         // After the call to setg we can only call nosplit functions
1978         // with no pointer manipulation.
1979         mp := getg().m
1980
1981         // Return mp.curg to dead state.
1982         casgstatus(mp.curg, _Gsyscall, _Gdead)
1983         mp.curg.preemptStop = false
1984         sched.ngsys.Add(1)
1985
1986         // Block signals before unminit.
1987         // Unminit unregisters the signal handling stack (but needs g on some systems).
1988         // Setg(nil) clears g, which is the signal handler's cue not to run Go handlers.
1989         // It's important not to try to handle a signal between those two steps.
1990         sigmask := mp.sigmask
1991         sigblock(false)
1992         unminit()
1993
1994         mnext := lockextra(true)
1995         extraMCount++
1996         mp.schedlink.set(mnext)
1997
1998         setg(nil)
1999
2000         // Commit the release of mp.
2001         unlockextra(mp)
2002
2003         msigrestore(sigmask)
2004 }
2005
2006 // A helper function for EnsureDropM.
2007 func getm() uintptr {
2008         return uintptr(unsafe.Pointer(getg().m))
2009 }
2010
2011 var extram uintptr
2012 var extraMCount uint32 // Protected by lockextra
2013 var extraMWaiters uint32
2014
2015 // lockextra locks the extra list and returns the list head.
2016 // The caller must unlock the list by storing a new list head
2017 // to extram. If nilokay is true, then lockextra will
2018 // return a nil list head if that's what it finds. If nilokay is false,
2019 // lockextra will keep waiting until the list head is no longer nil.
2020 //
2021 //go:nosplit
2022 func lockextra(nilokay bool) *m {
2023         const locked = 1
2024
2025         incr := false
2026         for {
2027                 old := atomic.Loaduintptr(&extram)
2028                 if old == locked {
2029                         osyield_no_g()
2030                         continue
2031                 }
2032                 if old == 0 && !nilokay {
2033                         if !incr {
2034                                 // Add 1 to the number of threads
2035                                 // waiting for an M.
2036                                 // This is cleared by newextram.
2037                                 atomic.Xadd(&extraMWaiters, 1)
2038                                 incr = true
2039                         }
2040                         usleep_no_g(1)
2041                         continue
2042                 }
2043                 if atomic.Casuintptr(&extram, old, locked) {
2044                         return (*m)(unsafe.Pointer(old))
2045                 }
2046                 osyield_no_g()
2047                 continue
2048         }
2049 }
2050
2051 //go:nosplit
2052 func unlockextra(mp *m) {
2053         atomic.Storeuintptr(&extram, uintptr(unsafe.Pointer(mp)))
2054 }
2055
2056 var (
2057         // allocmLock is locked for read when creating new Ms in allocm and their
2058         // addition to allm. Thus acquiring this lock for write blocks the
2059         // creation of new Ms.
2060         allocmLock rwmutex
2061
2062         // execLock serializes exec and clone to avoid bugs or unspecified
2063         // behaviour around exec'ing while creating/destroying threads. See
2064         // issue #19546.
2065         execLock rwmutex
2066 )
2067
2068 // newmHandoff contains a list of m structures that need new OS threads.
2069 // This is used by newm in situations where newm itself can't safely
2070 // start an OS thread.
2071 var newmHandoff struct {
2072         lock mutex
2073
2074         // newm points to a list of M structures that need new OS
2075         // threads. The list is linked through m.schedlink.
2076         newm muintptr
2077
2078         // waiting indicates that wake needs to be notified when an m
2079         // is put on the list.
2080         waiting bool
2081         wake    note
2082
2083         // haveTemplateThread indicates that the templateThread has
2084         // been started. This is not protected by lock. Use cas to set
2085         // to 1.
2086         haveTemplateThread uint32
2087 }
2088
2089 // Create a new m. It will start off with a call to fn, or else the scheduler.
2090 // fn needs to be static and not a heap allocated closure.
2091 // May run with m.p==nil, so write barriers are not allowed.
2092 //
2093 // id is optional pre-allocated m ID. Omit by passing -1.
2094 //
2095 //go:nowritebarrierrec
2096 func newm(fn func(), pp *p, id int64) {
2097         // allocm adds a new M to allm, but they do not start until created by
2098         // the OS in newm1 or the template thread.
2099         //
2100         // doAllThreadsSyscall requires that every M in allm will eventually
2101         // start and be signal-able, even with a STW.
2102         //
2103         // Disable preemption here until we start the thread to ensure that
2104         // newm is not preempted between allocm and starting the new thread,
2105         // ensuring that anything added to allm is guaranteed to eventually
2106         // start.
2107         acquirem()
2108
2109         mp := allocm(pp, fn, id)
2110         mp.nextp.set(pp)
2111         mp.sigmask = initSigmask
2112         if gp := getg(); gp != nil && gp.m != nil && (gp.m.lockedExt != 0 || gp.m.incgo) && GOOS != "plan9" {
2113                 // We're on a locked M or a thread that may have been
2114                 // started by C. The kernel state of this thread may
2115                 // be strange (the user may have locked it for that
2116                 // purpose). We don't want to clone that into another
2117                 // thread. Instead, ask a known-good thread to create
2118                 // the thread for us.
2119                 //
2120                 // This is disabled on Plan 9. See golang.org/issue/22227.
2121                 //
2122                 // TODO: This may be unnecessary on Windows, which
2123                 // doesn't model thread creation off fork.
2124                 lock(&newmHandoff.lock)
2125                 if newmHandoff.haveTemplateThread == 0 {
2126                         throw("on a locked thread with no template thread")
2127                 }
2128                 mp.schedlink = newmHandoff.newm
2129                 newmHandoff.newm.set(mp)
2130                 if newmHandoff.waiting {
2131                         newmHandoff.waiting = false
2132                         notewakeup(&newmHandoff.wake)
2133                 }
2134                 unlock(&newmHandoff.lock)
2135                 // The M has not started yet, but the template thread does not
2136                 // participate in STW, so it will always process queued Ms and
2137                 // it is safe to releasem.
2138                 releasem(getg().m)
2139                 return
2140         }
2141         newm1(mp)
2142         releasem(getg().m)
2143 }
2144
2145 func newm1(mp *m) {
2146         if iscgo {
2147                 var ts cgothreadstart
2148                 if _cgo_thread_start == nil {
2149                         throw("_cgo_thread_start missing")
2150                 }
2151                 ts.g.set(mp.g0)
2152                 ts.tls = (*uint64)(unsafe.Pointer(&mp.tls[0]))
2153                 ts.fn = unsafe.Pointer(abi.FuncPCABI0(mstart))
2154                 if msanenabled {
2155                         msanwrite(unsafe.Pointer(&ts), unsafe.Sizeof(ts))
2156                 }
2157                 if asanenabled {
2158                         asanwrite(unsafe.Pointer(&ts), unsafe.Sizeof(ts))
2159                 }
2160                 execLock.rlock() // Prevent process clone.
2161                 asmcgocall(_cgo_thread_start, unsafe.Pointer(&ts))
2162                 execLock.runlock()
2163                 return
2164         }
2165         execLock.rlock() // Prevent process clone.
2166         newosproc(mp)
2167         execLock.runlock()
2168 }
2169
2170 // startTemplateThread starts the template thread if it is not already
2171 // running.
2172 //
2173 // The calling thread must itself be in a known-good state.
2174 func startTemplateThread() {
2175         if GOARCH == "wasm" { // no threads on wasm yet
2176                 return
2177         }
2178
2179         // Disable preemption to guarantee that the template thread will be
2180         // created before a park once haveTemplateThread is set.
2181         mp := acquirem()
2182         if !atomic.Cas(&newmHandoff.haveTemplateThread, 0, 1) {
2183                 releasem(mp)
2184                 return
2185         }
2186         newm(templateThread, nil, -1)
2187         releasem(mp)
2188 }
2189
2190 // templateThread is a thread in a known-good state that exists solely
2191 // to start new threads in known-good states when the calling thread
2192 // may not be in a good state.
2193 //
2194 // Many programs never need this, so templateThread is started lazily
2195 // when we first enter a state that might lead to running on a thread
2196 // in an unknown state.
2197 //
2198 // templateThread runs on an M without a P, so it must not have write
2199 // barriers.
2200 //
2201 //go:nowritebarrierrec
2202 func templateThread() {
2203         lock(&sched.lock)
2204         sched.nmsys++
2205         checkdead()
2206         unlock(&sched.lock)
2207
2208         for {
2209                 lock(&newmHandoff.lock)
2210                 for newmHandoff.newm != 0 {
2211                         newm := newmHandoff.newm.ptr()
2212                         newmHandoff.newm = 0
2213                         unlock(&newmHandoff.lock)
2214                         for newm != nil {
2215                                 next := newm.schedlink.ptr()
2216                                 newm.schedlink = 0
2217                                 newm1(newm)
2218                                 newm = next
2219                         }
2220                         lock(&newmHandoff.lock)
2221                 }
2222                 newmHandoff.waiting = true
2223                 noteclear(&newmHandoff.wake)
2224                 unlock(&newmHandoff.lock)
2225                 notesleep(&newmHandoff.wake)
2226         }
2227 }
2228
2229 // Stops execution of the current m until new work is available.
2230 // Returns with acquired P.
2231 func stopm() {
2232         gp := getg()
2233
2234         if gp.m.locks != 0 {
2235                 throw("stopm holding locks")
2236         }
2237         if gp.m.p != 0 {
2238                 throw("stopm holding p")
2239         }
2240         if gp.m.spinning {
2241                 throw("stopm spinning")
2242         }
2243
2244         lock(&sched.lock)
2245         mput(gp.m)
2246         unlock(&sched.lock)
2247         mPark()
2248         acquirep(gp.m.nextp.ptr())
2249         gp.m.nextp = 0
2250 }
2251
2252 func mspinning() {
2253         // startm's caller incremented nmspinning. Set the new M's spinning.
2254         getg().m.spinning = true
2255 }
2256
2257 // Schedules some M to run the p (creates an M if necessary).
2258 // If p==nil, tries to get an idle P, if no idle P's does nothing.
2259 // May run with m.p==nil, so write barriers are not allowed.
2260 // If spinning is set, the caller has incremented nmspinning and must provide a
2261 // P. startm will set m.spinning in the newly started M.
2262 //
2263 // Callers passing a non-nil P must call from a non-preemptible context. See
2264 // comment on acquirem below.
2265 //
2266 // Must not have write barriers because this may be called without a P.
2267 //
2268 //go:nowritebarrierrec
2269 func startm(pp *p, spinning bool) {
2270         // Disable preemption.
2271         //
2272         // Every owned P must have an owner that will eventually stop it in the
2273         // event of a GC stop request. startm takes transient ownership of a P
2274         // (either from argument or pidleget below) and transfers ownership to
2275         // a started M, which will be responsible for performing the stop.
2276         //
2277         // Preemption must be disabled during this transient ownership,
2278         // otherwise the P this is running on may enter GC stop while still
2279         // holding the transient P, leaving that P in limbo and deadlocking the
2280         // STW.
2281         //
2282         // Callers passing a non-nil P must already be in non-preemptible
2283         // context, otherwise such preemption could occur on function entry to
2284         // startm. Callers passing a nil P may be preemptible, so we must
2285         // disable preemption before acquiring a P from pidleget below.
2286         mp := acquirem()
2287         lock(&sched.lock)
2288         if pp == nil {
2289                 if spinning {
2290                         // TODO(prattmic): All remaining calls to this function
2291                         // with _p_ == nil could be cleaned up to find a P
2292                         // before calling startm.
2293                         throw("startm: P required for spinning=true")
2294                 }
2295                 pp, _ = pidleget(0)
2296                 if pp == nil {
2297                         unlock(&sched.lock)
2298                         releasem(mp)
2299                         return
2300                 }
2301         }
2302         nmp := mget()
2303         if nmp == nil {
2304                 // No M is available, we must drop sched.lock and call newm.
2305                 // However, we already own a P to assign to the M.
2306                 //
2307                 // Once sched.lock is released, another G (e.g., in a syscall),
2308                 // could find no idle P while checkdead finds a runnable G but
2309                 // no running M's because this new M hasn't started yet, thus
2310                 // throwing in an apparent deadlock.
2311                 //
2312                 // Avoid this situation by pre-allocating the ID for the new M,
2313                 // thus marking it as 'running' before we drop sched.lock. This
2314                 // new M will eventually run the scheduler to execute any
2315                 // queued G's.
2316                 id := mReserveID()
2317                 unlock(&sched.lock)
2318
2319                 var fn func()
2320                 if spinning {
2321                         // The caller incremented nmspinning, so set m.spinning in the new M.
2322                         fn = mspinning
2323                 }
2324                 newm(fn, pp, id)
2325                 // Ownership transfer of pp committed by start in newm.
2326                 // Preemption is now safe.
2327                 releasem(mp)
2328                 return
2329         }
2330         unlock(&sched.lock)
2331         if nmp.spinning {
2332                 throw("startm: m is spinning")
2333         }
2334         if nmp.nextp != 0 {
2335                 throw("startm: m has p")
2336         }
2337         if spinning && !runqempty(pp) {
2338                 throw("startm: p has runnable gs")
2339         }
2340         // The caller incremented nmspinning, so set m.spinning in the new M.
2341         nmp.spinning = spinning
2342         nmp.nextp.set(pp)
2343         notewakeup(&nmp.park)
2344         // Ownership transfer of pp committed by wakeup. Preemption is now
2345         // safe.
2346         releasem(mp)
2347 }
2348
2349 // Hands off P from syscall or locked M.
2350 // Always runs without a P, so write barriers are not allowed.
2351 //
2352 //go:nowritebarrierrec
2353 func handoffp(pp *p) {
2354         // handoffp must start an M in any situation where
2355         // findrunnable would return a G to run on pp.
2356
2357         // if it has local work, start it straight away
2358         if !runqempty(pp) || sched.runqsize != 0 {
2359                 startm(pp, false)
2360                 return
2361         }
2362         // if there's trace work to do, start it straight away
2363         if (trace.enabled || trace.shutdown) && traceReaderAvailable() != nil {
2364                 startm(pp, false)
2365                 return
2366         }
2367         // if it has GC work, start it straight away
2368         if gcBlackenEnabled != 0 && gcMarkWorkAvailable(pp) {
2369                 startm(pp, false)
2370                 return
2371         }
2372         // no local work, check that there are no spinning/idle M's,
2373         // otherwise our help is not required
2374         if sched.nmspinning.Load()+sched.npidle.Load() == 0 && sched.nmspinning.CompareAndSwap(0, 1) { // TODO: fast atomic
2375                 sched.needspinning.Store(0)
2376                 startm(pp, true)
2377                 return
2378         }
2379         lock(&sched.lock)
2380         if sched.gcwaiting.Load() {
2381                 pp.status = _Pgcstop
2382                 sched.stopwait--
2383                 if sched.stopwait == 0 {
2384                         notewakeup(&sched.stopnote)
2385                 }
2386                 unlock(&sched.lock)
2387                 return
2388         }
2389         if pp.runSafePointFn != 0 && atomic.Cas(&pp.runSafePointFn, 1, 0) {
2390                 sched.safePointFn(pp)
2391                 sched.safePointWait--
2392                 if sched.safePointWait == 0 {
2393                         notewakeup(&sched.safePointNote)
2394                 }
2395         }
2396         if sched.runqsize != 0 {
2397                 unlock(&sched.lock)
2398                 startm(pp, false)
2399                 return
2400         }
2401         // If this is the last running P and nobody is polling network,
2402         // need to wakeup another M to poll network.
2403         if sched.npidle.Load() == gomaxprocs-1 && sched.lastpoll.Load() != 0 {
2404                 unlock(&sched.lock)
2405                 startm(pp, false)
2406                 return
2407         }
2408
2409         // The scheduler lock cannot be held when calling wakeNetPoller below
2410         // because wakeNetPoller may call wakep which may call startm.
2411         when := nobarrierWakeTime(pp)
2412         pidleput(pp, 0)
2413         unlock(&sched.lock)
2414
2415         if when != 0 {
2416                 wakeNetPoller(when)
2417         }
2418 }
2419
2420 // Tries to add one more P to execute G's.
2421 // Called when a G is made runnable (newproc, ready).
2422 // Must be called with a P.
2423 func wakep() {
2424         // Be conservative about spinning threads, only start one if none exist
2425         // already.
2426         if sched.nmspinning.Load() != 0 || !sched.nmspinning.CompareAndSwap(0, 1) {
2427                 return
2428         }
2429
2430         // Disable preemption until ownership of pp transfers to the next M in
2431         // startm. Otherwise preemption here would leave pp stuck waiting to
2432         // enter _Pgcstop.
2433         //
2434         // See preemption comment on acquirem in startm for more details.
2435         mp := acquirem()
2436
2437         var pp *p
2438         lock(&sched.lock)
2439         pp, _ = pidlegetSpinning(0)
2440         if pp == nil {
2441                 if sched.nmspinning.Add(-1) < 0 {
2442                         throw("wakep: negative nmspinning")
2443                 }
2444                 unlock(&sched.lock)
2445                 releasem(mp)
2446                 return
2447         }
2448         // Since we always have a P, the race in the "No M is available"
2449         // comment in startm doesn't apply during the small window between the
2450         // unlock here and lock in startm. A checkdead in between will always
2451         // see at least one running M (ours).
2452         unlock(&sched.lock)
2453
2454         startm(pp, true)
2455
2456         releasem(mp)
2457 }
2458
2459 // Stops execution of the current m that is locked to a g until the g is runnable again.
2460 // Returns with acquired P.
2461 func stoplockedm() {
2462         gp := getg()
2463
2464         if gp.m.lockedg == 0 || gp.m.lockedg.ptr().lockedm.ptr() != gp.m {
2465                 throw("stoplockedm: inconsistent locking")
2466         }
2467         if gp.m.p != 0 {
2468                 // Schedule another M to run this p.
2469                 pp := releasep()
2470                 handoffp(pp)
2471         }
2472         incidlelocked(1)
2473         // Wait until another thread schedules lockedg again.
2474         mPark()
2475         status := readgstatus(gp.m.lockedg.ptr())
2476         if status&^_Gscan != _Grunnable {
2477                 print("runtime:stoplockedm: lockedg (atomicstatus=", status, ") is not Grunnable or Gscanrunnable\n")
2478                 dumpgstatus(gp.m.lockedg.ptr())
2479                 throw("stoplockedm: not runnable")
2480         }
2481         acquirep(gp.m.nextp.ptr())
2482         gp.m.nextp = 0
2483 }
2484
2485 // Schedules the locked m to run the locked gp.
2486 // May run during STW, so write barriers are not allowed.
2487 //
2488 //go:nowritebarrierrec
2489 func startlockedm(gp *g) {
2490         mp := gp.lockedm.ptr()
2491         if mp == getg().m {
2492                 throw("startlockedm: locked to me")
2493         }
2494         if mp.nextp != 0 {
2495                 throw("startlockedm: m has p")
2496         }
2497         // directly handoff current P to the locked m
2498         incidlelocked(-1)
2499         pp := releasep()
2500         mp.nextp.set(pp)
2501         notewakeup(&mp.park)
2502         stopm()
2503 }
2504
2505 // Stops the current m for stopTheWorld.
2506 // Returns when the world is restarted.
2507 func gcstopm() {
2508         gp := getg()
2509
2510         if !sched.gcwaiting.Load() {
2511                 throw("gcstopm: not waiting for gc")
2512         }
2513         if gp.m.spinning {
2514                 gp.m.spinning = false
2515                 // OK to just drop nmspinning here,
2516                 // startTheWorld will unpark threads as necessary.
2517                 if sched.nmspinning.Add(-1) < 0 {
2518                         throw("gcstopm: negative nmspinning")
2519                 }
2520         }
2521         pp := releasep()
2522         lock(&sched.lock)
2523         pp.status = _Pgcstop
2524         sched.stopwait--
2525         if sched.stopwait == 0 {
2526                 notewakeup(&sched.stopnote)
2527         }
2528         unlock(&sched.lock)
2529         stopm()
2530 }
2531
2532 // Schedules gp to run on the current M.
2533 // If inheritTime is true, gp inherits the remaining time in the
2534 // current time slice. Otherwise, it starts a new time slice.
2535 // Never returns.
2536 //
2537 // Write barriers are allowed because this is called immediately after
2538 // acquiring a P in several places.
2539 //
2540 //go:yeswritebarrierrec
2541 func execute(gp *g, inheritTime bool) {
2542         mp := getg().m
2543
2544         if goroutineProfile.active {
2545                 // Make sure that gp has had its stack written out to the goroutine
2546                 // profile, exactly as it was when the goroutine profiler first stopped
2547                 // the world.
2548                 tryRecordGoroutineProfile(gp, osyield)
2549         }
2550
2551         // Assign gp.m before entering _Grunning so running Gs have an
2552         // M.
2553         mp.curg = gp
2554         gp.m = mp
2555         casgstatus(gp, _Grunnable, _Grunning)
2556         gp.waitsince = 0
2557         gp.preempt = false
2558         gp.stackguard0 = gp.stack.lo + _StackGuard
2559         if !inheritTime {
2560                 mp.p.ptr().schedtick++
2561         }
2562
2563         // Check whether the profiler needs to be turned on or off.
2564         hz := sched.profilehz
2565         if mp.profilehz != hz {
2566                 setThreadCPUProfiler(hz)
2567         }
2568
2569         if trace.enabled {
2570                 // GoSysExit has to happen when we have a P, but before GoStart.
2571                 // So we emit it here.
2572                 if gp.syscallsp != 0 && gp.sysblocktraced {
2573                         traceGoSysExit(gp.sysexitticks)
2574                 }
2575                 traceGoStart()
2576         }
2577
2578         gogo(&gp.sched)
2579 }
2580
2581 // Finds a runnable goroutine to execute.
2582 // Tries to steal from other P's, get g from local or global queue, poll network.
2583 // tryWakeP indicates that the returned goroutine is not normal (GC worker, trace
2584 // reader) so the caller should try to wake a P.
2585 func findRunnable() (gp *g, inheritTime, tryWakeP bool) {
2586         mp := getg().m
2587
2588         // The conditions here and in handoffp must agree: if
2589         // findrunnable would return a G to run, handoffp must start
2590         // an M.
2591
2592 top:
2593         pp := mp.p.ptr()
2594         if sched.gcwaiting.Load() {
2595                 gcstopm()
2596                 goto top
2597         }
2598         if pp.runSafePointFn != 0 {
2599                 runSafePointFn()
2600         }
2601
2602         // now and pollUntil are saved for work stealing later,
2603         // which may steal timers. It's important that between now
2604         // and then, nothing blocks, so these numbers remain mostly
2605         // relevant.
2606         now, pollUntil, _ := checkTimers(pp, 0)
2607
2608         // Try to schedule the trace reader.
2609         if trace.enabled || trace.shutdown {
2610                 gp := traceReader()
2611                 if gp != nil {
2612                         casgstatus(gp, _Gwaiting, _Grunnable)
2613                         traceGoUnpark(gp, 0)
2614                         return gp, false, true
2615                 }
2616         }
2617
2618         // Try to schedule a GC worker.
2619         if gcBlackenEnabled != 0 {
2620                 gp, tnow := gcController.findRunnableGCWorker(pp, now)
2621                 if gp != nil {
2622                         return gp, false, true
2623                 }
2624                 now = tnow
2625         }
2626
2627         // Check the global runnable queue once in a while to ensure fairness.
2628         // Otherwise two goroutines can completely occupy the local runqueue
2629         // by constantly respawning each other.
2630         if pp.schedtick%61 == 0 && sched.runqsize > 0 {
2631                 lock(&sched.lock)
2632                 gp := globrunqget(pp, 1)
2633                 unlock(&sched.lock)
2634                 if gp != nil {
2635                         return gp, false, false
2636                 }
2637         }
2638
2639         // Wake up the finalizer G.
2640         if fingwait && fingwake {
2641                 if gp := wakefing(); gp != nil {
2642                         ready(gp, 0, true)
2643                 }
2644         }
2645         if *cgo_yield != nil {
2646                 asmcgocall(*cgo_yield, nil)
2647         }
2648
2649         // local runq
2650         if gp, inheritTime := runqget(pp); gp != nil {
2651                 return gp, inheritTime, false
2652         }
2653
2654         // global runq
2655         if sched.runqsize != 0 {
2656                 lock(&sched.lock)
2657                 gp := globrunqget(pp, 0)
2658                 unlock(&sched.lock)
2659                 if gp != nil {
2660                         return gp, false, false
2661                 }
2662         }
2663
2664         // Poll network.
2665         // This netpoll is only an optimization before we resort to stealing.
2666         // We can safely skip it if there are no waiters or a thread is blocked
2667         // in netpoll already. If there is any kind of logical race with that
2668         // blocked thread (e.g. it has already returned from netpoll, but does
2669         // not set lastpoll yet), this thread will do blocking netpoll below
2670         // anyway.
2671         if netpollinited() && atomic.Load(&netpollWaiters) > 0 && sched.lastpoll.Load() != 0 {
2672                 if list := netpoll(0); !list.empty() { // non-blocking
2673                         gp := list.pop()
2674                         injectglist(&list)
2675                         casgstatus(gp, _Gwaiting, _Grunnable)
2676                         if trace.enabled {
2677                                 traceGoUnpark(gp, 0)
2678                         }
2679                         return gp, false, false
2680                 }
2681         }
2682
2683         // Spinning Ms: steal work from other Ps.
2684         //
2685         // Limit the number of spinning Ms to half the number of busy Ps.
2686         // This is necessary to prevent excessive CPU consumption when
2687         // GOMAXPROCS>>1 but the program parallelism is low.
2688         if mp.spinning || 2*sched.nmspinning.Load() < gomaxprocs-sched.npidle.Load() {
2689                 if !mp.spinning {
2690                         mp.becomeSpinning()
2691                 }
2692
2693                 gp, inheritTime, tnow, w, newWork := stealWork(now)
2694                 if gp != nil {
2695                         // Successfully stole.
2696                         return gp, inheritTime, false
2697                 }
2698                 if newWork {
2699                         // There may be new timer or GC work; restart to
2700                         // discover.
2701                         goto top
2702                 }
2703
2704                 now = tnow
2705                 if w != 0 && (pollUntil == 0 || w < pollUntil) {
2706                         // Earlier timer to wait for.
2707                         pollUntil = w
2708                 }
2709         }
2710
2711         // We have nothing to do.
2712         //
2713         // If we're in the GC mark phase, can safely scan and blacken objects,
2714         // and have work to do, run idle-time marking rather than give up the P.
2715         if gcBlackenEnabled != 0 && gcMarkWorkAvailable(pp) && gcController.addIdleMarkWorker() {
2716                 node := (*gcBgMarkWorkerNode)(gcBgMarkWorkerPool.pop())
2717                 if node != nil {
2718                         pp.gcMarkWorkerMode = gcMarkWorkerIdleMode
2719                         gp := node.gp.ptr()
2720                         casgstatus(gp, _Gwaiting, _Grunnable)
2721                         if trace.enabled {
2722                                 traceGoUnpark(gp, 0)
2723                         }
2724                         return gp, false, false
2725                 }
2726                 gcController.removeIdleMarkWorker()
2727         }
2728
2729         // wasm only:
2730         // If a callback returned and no other goroutine is awake,
2731         // then wake event handler goroutine which pauses execution
2732         // until a callback was triggered.
2733         gp, otherReady := beforeIdle(now, pollUntil)
2734         if gp != nil {
2735                 casgstatus(gp, _Gwaiting, _Grunnable)
2736                 if trace.enabled {
2737                         traceGoUnpark(gp, 0)
2738                 }
2739                 return gp, false, false
2740         }
2741         if otherReady {
2742                 goto top
2743         }
2744
2745         // Before we drop our P, make a snapshot of the allp slice,
2746         // which can change underfoot once we no longer block
2747         // safe-points. We don't need to snapshot the contents because
2748         // everything up to cap(allp) is immutable.
2749         allpSnapshot := allp
2750         // Also snapshot masks. Value changes are OK, but we can't allow
2751         // len to change out from under us.
2752         idlepMaskSnapshot := idlepMask
2753         timerpMaskSnapshot := timerpMask
2754
2755         // return P and block
2756         lock(&sched.lock)
2757         if sched.gcwaiting.Load() || pp.runSafePointFn != 0 {
2758                 unlock(&sched.lock)
2759                 goto top
2760         }
2761         if sched.runqsize != 0 {
2762                 gp := globrunqget(pp, 0)
2763                 unlock(&sched.lock)
2764                 return gp, false, false
2765         }
2766         if !mp.spinning && sched.needspinning.Load() == 1 {
2767                 // See "Delicate dance" comment below.
2768                 mp.becomeSpinning()
2769                 unlock(&sched.lock)
2770                 goto top
2771         }
2772         if releasep() != pp {
2773                 throw("findrunnable: wrong p")
2774         }
2775         now = pidleput(pp, now)
2776         unlock(&sched.lock)
2777
2778         // Delicate dance: thread transitions from spinning to non-spinning
2779         // state, potentially concurrently with submission of new work. We must
2780         // drop nmspinning first and then check all sources again (with
2781         // #StoreLoad memory barrier in between). If we do it the other way
2782         // around, another thread can submit work after we've checked all
2783         // sources but before we drop nmspinning; as a result nobody will
2784         // unpark a thread to run the work.
2785         //
2786         // This applies to the following sources of work:
2787         //
2788         // * Goroutines added to a per-P run queue.
2789         // * New/modified-earlier timers on a per-P timer heap.
2790         // * Idle-priority GC work (barring golang.org/issue/19112).
2791         //
2792         // If we discover new work below, we need to restore m.spinning as a
2793         // signal for resetspinning to unpark a new worker thread (because
2794         // there can be more than one starving goroutine).
2795         //
2796         // However, if after discovering new work we also observe no idle Ps
2797         // (either here or in resetspinning), we have a problem. We may be
2798         // racing with a non-spinning M in the block above, having found no
2799         // work and preparing to release its P and park. Allowing that P to go
2800         // idle will result in loss of work conservation (idle P while there is
2801         // runnable work). This could result in complete deadlock in the
2802         // unlikely event that we discover new work (from netpoll) right as we
2803         // are racing with _all_ other Ps going idle.
2804         //
2805         // We use sched.needspinning to synchronize with non-spinning Ms going
2806         // idle. If needspinning is set when they are about to drop their P,
2807         // they abort the drop and instead become a new spinning M on our
2808         // behalf. If we are not racing and the system is truly fully loaded
2809         // then no spinning threads are required, and the next thread to
2810         // naturally become spinning will clear the flag.
2811         //
2812         // Also see "Worker thread parking/unparking" comment at the top of the
2813         // file.
2814         wasSpinning := mp.spinning
2815         if mp.spinning {
2816                 mp.spinning = false
2817                 if sched.nmspinning.Add(-1) < 0 {
2818                         throw("findrunnable: negative nmspinning")
2819                 }
2820
2821                 // Note the for correctness, only the last M transitioning from
2822                 // spinning to non-spinning must perform these rechecks to
2823                 // ensure no missed work. However, the runtime has some cases
2824                 // of transient increments of nmspinning that are decremented
2825                 // without going through this path, so we must be conservative
2826                 // and perform the check on all spinning Ms.
2827                 //
2828                 // See https://go.dev/issue/43997.
2829
2830                 // Check all runqueues once again.
2831                 pp := checkRunqsNoP(allpSnapshot, idlepMaskSnapshot)
2832                 if pp != nil {
2833                         acquirep(pp)
2834                         mp.becomeSpinning()
2835                         goto top
2836                 }
2837
2838                 // Check for idle-priority GC work again.
2839                 pp, gp := checkIdleGCNoP()
2840                 if pp != nil {
2841                         acquirep(pp)
2842                         mp.becomeSpinning()
2843
2844                         // Run the idle worker.
2845                         pp.gcMarkWorkerMode = gcMarkWorkerIdleMode
2846                         casgstatus(gp, _Gwaiting, _Grunnable)
2847                         if trace.enabled {
2848                                 traceGoUnpark(gp, 0)
2849                         }
2850                         return gp, false, false
2851                 }
2852
2853                 // Finally, check for timer creation or expiry concurrently with
2854                 // transitioning from spinning to non-spinning.
2855                 //
2856                 // Note that we cannot use checkTimers here because it calls
2857                 // adjusttimers which may need to allocate memory, and that isn't
2858                 // allowed when we don't have an active P.
2859                 pollUntil = checkTimersNoP(allpSnapshot, timerpMaskSnapshot, pollUntil)
2860         }
2861
2862         // Poll network until next timer.
2863         if netpollinited() && (atomic.Load(&netpollWaiters) > 0 || pollUntil != 0) && sched.lastpoll.Swap(0) != 0 {
2864                 sched.pollUntil.Store(pollUntil)
2865                 if mp.p != 0 {
2866                         throw("findrunnable: netpoll with p")
2867                 }
2868                 if mp.spinning {
2869                         throw("findrunnable: netpoll with spinning")
2870                 }
2871                 // Refresh now.
2872                 now = nanotime()
2873                 delay := int64(-1)
2874                 if pollUntil != 0 {
2875                         delay = pollUntil - now
2876                         if delay < 0 {
2877                                 delay = 0
2878                         }
2879                 }
2880                 if faketime != 0 {
2881                         // When using fake time, just poll.
2882                         delay = 0
2883                 }
2884                 list := netpoll(delay) // block until new work is available
2885                 sched.pollUntil.Store(0)
2886                 sched.lastpoll.Store(now)
2887                 if faketime != 0 && list.empty() {
2888                         // Using fake time and nothing is ready; stop M.
2889                         // When all M's stop, checkdead will call timejump.
2890                         stopm()
2891                         goto top
2892                 }
2893                 lock(&sched.lock)
2894                 pp, _ := pidleget(now)
2895                 unlock(&sched.lock)
2896                 if pp == nil {
2897                         injectglist(&list)
2898                 } else {
2899                         acquirep(pp)
2900                         if !list.empty() {
2901                                 gp := list.pop()
2902                                 injectglist(&list)
2903                                 casgstatus(gp, _Gwaiting, _Grunnable)
2904                                 if trace.enabled {
2905                                         traceGoUnpark(gp, 0)
2906                                 }
2907                                 return gp, false, false
2908                         }
2909                         if wasSpinning {
2910                                 mp.becomeSpinning()
2911                         }
2912                         goto top
2913                 }
2914         } else if pollUntil != 0 && netpollinited() {
2915                 pollerPollUntil := sched.pollUntil.Load()
2916                 if pollerPollUntil == 0 || pollerPollUntil > pollUntil {
2917                         netpollBreak()
2918                 }
2919         }
2920         stopm()
2921         goto top
2922 }
2923
2924 // pollWork reports whether there is non-background work this P could
2925 // be doing. This is a fairly lightweight check to be used for
2926 // background work loops, like idle GC. It checks a subset of the
2927 // conditions checked by the actual scheduler.
2928 func pollWork() bool {
2929         if sched.runqsize != 0 {
2930                 return true
2931         }
2932         p := getg().m.p.ptr()
2933         if !runqempty(p) {
2934                 return true
2935         }
2936         if netpollinited() && atomic.Load(&netpollWaiters) > 0 && sched.lastpoll.Load() != 0 {
2937                 if list := netpoll(0); !list.empty() {
2938                         injectglist(&list)
2939                         return true
2940                 }
2941         }
2942         return false
2943 }
2944
2945 // stealWork attempts to steal a runnable goroutine or timer from any P.
2946 //
2947 // If newWork is true, new work may have been readied.
2948 //
2949 // If now is not 0 it is the current time. stealWork returns the passed time or
2950 // the current time if now was passed as 0.
2951 func stealWork(now int64) (gp *g, inheritTime bool, rnow, pollUntil int64, newWork bool) {
2952         pp := getg().m.p.ptr()
2953
2954         ranTimer := false
2955
2956         const stealTries = 4
2957         for i := 0; i < stealTries; i++ {
2958                 stealTimersOrRunNextG := i == stealTries-1
2959
2960                 for enum := stealOrder.start(fastrand()); !enum.done(); enum.next() {
2961                         if sched.gcwaiting.Load() {
2962                                 // GC work may be available.
2963                                 return nil, false, now, pollUntil, true
2964                         }
2965                         p2 := allp[enum.position()]
2966                         if pp == p2 {
2967                                 continue
2968                         }
2969
2970                         // Steal timers from p2. This call to checkTimers is the only place
2971                         // where we might hold a lock on a different P's timers. We do this
2972                         // once on the last pass before checking runnext because stealing
2973                         // from the other P's runnext should be the last resort, so if there
2974                         // are timers to steal do that first.
2975                         //
2976                         // We only check timers on one of the stealing iterations because
2977                         // the time stored in now doesn't change in this loop and checking
2978                         // the timers for each P more than once with the same value of now
2979                         // is probably a waste of time.
2980                         //
2981                         // timerpMask tells us whether the P may have timers at all. If it
2982                         // can't, no need to check at all.
2983                         if stealTimersOrRunNextG && timerpMask.read(enum.position()) {
2984                                 tnow, w, ran := checkTimers(p2, now)
2985                                 now = tnow
2986                                 if w != 0 && (pollUntil == 0 || w < pollUntil) {
2987                                         pollUntil = w
2988                                 }
2989                                 if ran {
2990                                         // Running the timers may have
2991                                         // made an arbitrary number of G's
2992                                         // ready and added them to this P's
2993                                         // local run queue. That invalidates
2994                                         // the assumption of runqsteal
2995                                         // that it always has room to add
2996                                         // stolen G's. So check now if there
2997                                         // is a local G to run.
2998                                         if gp, inheritTime := runqget(pp); gp != nil {
2999                                                 return gp, inheritTime, now, pollUntil, ranTimer
3000                                         }
3001                                         ranTimer = true
3002                                 }
3003                         }
3004
3005                         // Don't bother to attempt to steal if p2 is idle.
3006                         if !idlepMask.read(enum.position()) {
3007                                 if gp := runqsteal(pp, p2, stealTimersOrRunNextG); gp != nil {
3008                                         return gp, false, now, pollUntil, ranTimer
3009                                 }
3010                         }
3011                 }
3012         }
3013
3014         // No goroutines found to steal. Regardless, running a timer may have
3015         // made some goroutine ready that we missed. Indicate the next timer to
3016         // wait for.
3017         return nil, false, now, pollUntil, ranTimer
3018 }
3019
3020 // Check all Ps for a runnable G to steal.
3021 //
3022 // On entry we have no P. If a G is available to steal and a P is available,
3023 // the P is returned which the caller should acquire and attempt to steal the
3024 // work to.
3025 func checkRunqsNoP(allpSnapshot []*p, idlepMaskSnapshot pMask) *p {
3026         for id, p2 := range allpSnapshot {
3027                 if !idlepMaskSnapshot.read(uint32(id)) && !runqempty(p2) {
3028                         lock(&sched.lock)
3029                         pp, _ := pidlegetSpinning(0)
3030                         if pp == nil {
3031                                 // Can't get a P, don't bother checking remaining Ps.
3032                                 unlock(&sched.lock)
3033                                 return nil
3034                         }
3035                         unlock(&sched.lock)
3036                         return pp
3037                 }
3038         }
3039
3040         // No work available.
3041         return nil
3042 }
3043
3044 // Check all Ps for a timer expiring sooner than pollUntil.
3045 //
3046 // Returns updated pollUntil value.
3047 func checkTimersNoP(allpSnapshot []*p, timerpMaskSnapshot pMask, pollUntil int64) int64 {
3048         for id, p2 := range allpSnapshot {
3049                 if timerpMaskSnapshot.read(uint32(id)) {
3050                         w := nobarrierWakeTime(p2)
3051                         if w != 0 && (pollUntil == 0 || w < pollUntil) {
3052                                 pollUntil = w
3053                         }
3054                 }
3055         }
3056
3057         return pollUntil
3058 }
3059
3060 // Check for idle-priority GC, without a P on entry.
3061 //
3062 // If some GC work, a P, and a worker G are all available, the P and G will be
3063 // returned. The returned P has not been wired yet.
3064 func checkIdleGCNoP() (*p, *g) {
3065         // N.B. Since we have no P, gcBlackenEnabled may change at any time; we
3066         // must check again after acquiring a P. As an optimization, we also check
3067         // if an idle mark worker is needed at all. This is OK here, because if we
3068         // observe that one isn't needed, at least one is currently running. Even if
3069         // it stops running, its own journey into the scheduler should schedule it
3070         // again, if need be (at which point, this check will pass, if relevant).
3071         if atomic.Load(&gcBlackenEnabled) == 0 || !gcController.needIdleMarkWorker() {
3072                 return nil, nil
3073         }
3074         if !gcMarkWorkAvailable(nil) {
3075                 return nil, nil
3076         }
3077
3078         // Work is available; we can start an idle GC worker only if there is
3079         // an available P and available worker G.
3080         //
3081         // We can attempt to acquire these in either order, though both have
3082         // synchronization concerns (see below). Workers are almost always
3083         // available (see comment in findRunnableGCWorker for the one case
3084         // there may be none). Since we're slightly less likely to find a P,
3085         // check for that first.
3086         //
3087         // Synchronization: note that we must hold sched.lock until we are
3088         // committed to keeping it. Otherwise we cannot put the unnecessary P
3089         // back in sched.pidle without performing the full set of idle
3090         // transition checks.
3091         //
3092         // If we were to check gcBgMarkWorkerPool first, we must somehow handle
3093         // the assumption in gcControllerState.findRunnableGCWorker that an
3094         // empty gcBgMarkWorkerPool is only possible if gcMarkDone is running.
3095         lock(&sched.lock)
3096         pp, now := pidlegetSpinning(0)
3097         if pp == nil {
3098                 unlock(&sched.lock)
3099                 return nil, nil
3100         }
3101
3102         // Now that we own a P, gcBlackenEnabled can't change (as it requires STW).
3103         if gcBlackenEnabled == 0 || !gcController.addIdleMarkWorker() {
3104                 pidleput(pp, now)
3105                 unlock(&sched.lock)
3106                 return nil, nil
3107         }
3108
3109         node := (*gcBgMarkWorkerNode)(gcBgMarkWorkerPool.pop())
3110         if node == nil {
3111                 pidleput(pp, now)
3112                 unlock(&sched.lock)
3113                 gcController.removeIdleMarkWorker()
3114                 return nil, nil
3115         }
3116
3117         unlock(&sched.lock)
3118
3119         return pp, node.gp.ptr()
3120 }
3121
3122 // wakeNetPoller wakes up the thread sleeping in the network poller if it isn't
3123 // going to wake up before the when argument; or it wakes an idle P to service
3124 // timers and the network poller if there isn't one already.
3125 func wakeNetPoller(when int64) {
3126         if sched.lastpoll.Load() == 0 {
3127                 // In findrunnable we ensure that when polling the pollUntil
3128                 // field is either zero or the time to which the current
3129                 // poll is expected to run. This can have a spurious wakeup
3130                 // but should never miss a wakeup.
3131                 pollerPollUntil := sched.pollUntil.Load()
3132                 if pollerPollUntil == 0 || pollerPollUntil > when {
3133                         netpollBreak()
3134                 }
3135         } else {
3136                 // There are no threads in the network poller, try to get
3137                 // one there so it can handle new timers.
3138                 if GOOS != "plan9" { // Temporary workaround - see issue #42303.
3139                         wakep()
3140                 }
3141         }
3142 }
3143
3144 func resetspinning() {
3145         gp := getg()
3146         if !gp.m.spinning {
3147                 throw("resetspinning: not a spinning m")
3148         }
3149         gp.m.spinning = false
3150         nmspinning := sched.nmspinning.Add(-1)
3151         if nmspinning < 0 {
3152                 throw("findrunnable: negative nmspinning")
3153         }
3154         // M wakeup policy is deliberately somewhat conservative, so check if we
3155         // need to wakeup another P here. See "Worker thread parking/unparking"
3156         // comment at the top of the file for details.
3157         wakep()
3158 }
3159
3160 // injectglist adds each runnable G on the list to some run queue,
3161 // and clears glist. If there is no current P, they are added to the
3162 // global queue, and up to npidle M's are started to run them.
3163 // Otherwise, for each idle P, this adds a G to the global queue
3164 // and starts an M. Any remaining G's are added to the current P's
3165 // local run queue.
3166 // This may temporarily acquire sched.lock.
3167 // Can run concurrently with GC.
3168 func injectglist(glist *gList) {
3169         if glist.empty() {
3170                 return
3171         }
3172         if trace.enabled {
3173                 for gp := glist.head.ptr(); gp != nil; gp = gp.schedlink.ptr() {
3174                         traceGoUnpark(gp, 0)
3175                 }
3176         }
3177
3178         // Mark all the goroutines as runnable before we put them
3179         // on the run queues.
3180         head := glist.head.ptr()
3181         var tail *g
3182         qsize := 0
3183         for gp := head; gp != nil; gp = gp.schedlink.ptr() {
3184                 tail = gp
3185                 qsize++
3186                 casgstatus(gp, _Gwaiting, _Grunnable)
3187         }
3188
3189         // Turn the gList into a gQueue.
3190         var q gQueue
3191         q.head.set(head)
3192         q.tail.set(tail)
3193         *glist = gList{}
3194
3195         startIdle := func(n int) {
3196                 for i := 0; i < n; i++ {
3197                         mp := acquirem() // See comment in startm.
3198                         lock(&sched.lock)
3199
3200                         pp, _ := pidlegetSpinning(0)
3201                         if pp == nil {
3202                                 unlock(&sched.lock)
3203                                 releasem(mp)
3204                                 break
3205                         }
3206
3207                         unlock(&sched.lock)
3208                         startm(pp, false)
3209                         releasem(mp)
3210                 }
3211         }
3212
3213         pp := getg().m.p.ptr()
3214         if pp == nil {
3215                 lock(&sched.lock)
3216                 globrunqputbatch(&q, int32(qsize))
3217                 unlock(&sched.lock)
3218                 startIdle(qsize)
3219                 return
3220         }
3221
3222         npidle := int(sched.npidle.Load())
3223         var globq gQueue
3224         var n int
3225         for n = 0; n < npidle && !q.empty(); n++ {
3226                 g := q.pop()
3227                 globq.pushBack(g)
3228         }
3229         if n > 0 {
3230                 lock(&sched.lock)
3231                 globrunqputbatch(&globq, int32(n))
3232                 unlock(&sched.lock)
3233                 startIdle(n)
3234                 qsize -= n
3235         }
3236
3237         if !q.empty() {
3238                 runqputbatch(pp, &q, qsize)
3239         }
3240 }
3241
3242 // One round of scheduler: find a runnable goroutine and execute it.
3243 // Never returns.
3244 func schedule() {
3245         mp := getg().m
3246
3247         if mp.locks != 0 {
3248                 throw("schedule: holding locks")
3249         }
3250
3251         if mp.lockedg != 0 {
3252                 stoplockedm()
3253                 execute(mp.lockedg.ptr(), false) // Never returns.
3254         }
3255
3256         // We should not schedule away from a g that is executing a cgo call,
3257         // since the cgo call is using the m's g0 stack.
3258         if mp.incgo {
3259                 throw("schedule: in cgo")
3260         }
3261
3262 top:
3263         pp := mp.p.ptr()
3264         pp.preempt = false
3265
3266         // Safety check: if we are spinning, the run queue should be empty.
3267         // Check this before calling checkTimers, as that might call
3268         // goready to put a ready goroutine on the local run queue.
3269         if mp.spinning && (pp.runnext != 0 || pp.runqhead != pp.runqtail) {
3270                 throw("schedule: spinning with local work")
3271         }
3272
3273         gp, inheritTime, tryWakeP := findRunnable() // blocks until work is available
3274
3275         // This thread is going to run a goroutine and is not spinning anymore,
3276         // so if it was marked as spinning we need to reset it now and potentially
3277         // start a new spinning M.
3278         if mp.spinning {
3279                 resetspinning()
3280         }
3281
3282         if sched.disable.user && !schedEnabled(gp) {
3283                 // Scheduling of this goroutine is disabled. Put it on
3284                 // the list of pending runnable goroutines for when we
3285                 // re-enable user scheduling and look again.
3286                 lock(&sched.lock)
3287                 if schedEnabled(gp) {
3288                         // Something re-enabled scheduling while we
3289                         // were acquiring the lock.
3290                         unlock(&sched.lock)
3291                 } else {
3292                         sched.disable.runnable.pushBack(gp)
3293                         sched.disable.n++
3294                         unlock(&sched.lock)
3295                         goto top
3296                 }
3297         }
3298
3299         // If about to schedule a not-normal goroutine (a GCworker or tracereader),
3300         // wake a P if there is one.
3301         if tryWakeP {
3302                 wakep()
3303         }
3304         if gp.lockedm != 0 {
3305                 // Hands off own p to the locked m,
3306                 // then blocks waiting for a new p.
3307                 startlockedm(gp)
3308                 goto top
3309         }
3310
3311         execute(gp, inheritTime)
3312 }
3313
3314 // dropg removes the association between m and the current goroutine m->curg (gp for short).
3315 // Typically a caller sets gp's status away from Grunning and then
3316 // immediately calls dropg to finish the job. The caller is also responsible
3317 // for arranging that gp will be restarted using ready at an
3318 // appropriate time. After calling dropg and arranging for gp to be
3319 // readied later, the caller can do other work but eventually should
3320 // call schedule to restart the scheduling of goroutines on this m.
3321 func dropg() {
3322         gp := getg()
3323
3324         setMNoWB(&gp.m.curg.m, nil)
3325         setGNoWB(&gp.m.curg, nil)
3326 }
3327
3328 // checkTimers runs any timers for the P that are ready.
3329 // If now is not 0 it is the current time.
3330 // It returns the passed time or the current time if now was passed as 0.
3331 // and the time when the next timer should run or 0 if there is no next timer,
3332 // and reports whether it ran any timers.
3333 // If the time when the next timer should run is not 0,
3334 // it is always larger than the returned time.
3335 // We pass now in and out to avoid extra calls of nanotime.
3336 //
3337 //go:yeswritebarrierrec
3338 func checkTimers(pp *p, now int64) (rnow, pollUntil int64, ran bool) {
3339         // If it's not yet time for the first timer, or the first adjusted
3340         // timer, then there is nothing to do.
3341         next := int64(atomic.Load64(&pp.timer0When))
3342         nextAdj := int64(atomic.Load64(&pp.timerModifiedEarliest))
3343         if next == 0 || (nextAdj != 0 && nextAdj < next) {
3344                 next = nextAdj
3345         }
3346
3347         if next == 0 {
3348                 // No timers to run or adjust.
3349                 return now, 0, false
3350         }
3351
3352         if now == 0 {
3353                 now = nanotime()
3354         }
3355         if now < next {
3356                 // Next timer is not ready to run, but keep going
3357                 // if we would clear deleted timers.
3358                 // This corresponds to the condition below where
3359                 // we decide whether to call clearDeletedTimers.
3360                 if pp != getg().m.p.ptr() || int(atomic.Load(&pp.deletedTimers)) <= int(atomic.Load(&pp.numTimers)/4) {
3361                         return now, next, false
3362                 }
3363         }
3364
3365         lock(&pp.timersLock)
3366
3367         if len(pp.timers) > 0 {
3368                 adjusttimers(pp, now)
3369                 for len(pp.timers) > 0 {
3370                         // Note that runtimer may temporarily unlock
3371                         // pp.timersLock.
3372                         if tw := runtimer(pp, now); tw != 0 {
3373                                 if tw > 0 {
3374                                         pollUntil = tw
3375                                 }
3376                                 break
3377                         }
3378                         ran = true
3379                 }
3380         }
3381
3382         // If this is the local P, and there are a lot of deleted timers,
3383         // clear them out. We only do this for the local P to reduce
3384         // lock contention on timersLock.
3385         if pp == getg().m.p.ptr() && int(atomic.Load(&pp.deletedTimers)) > len(pp.timers)/4 {
3386                 clearDeletedTimers(pp)
3387         }
3388
3389         unlock(&pp.timersLock)
3390
3391         return now, pollUntil, ran
3392 }
3393
3394 func parkunlock_c(gp *g, lock unsafe.Pointer) bool {
3395         unlock((*mutex)(lock))
3396         return true
3397 }
3398
3399 // park continuation on g0.
3400 func park_m(gp *g) {
3401         mp := getg().m
3402
3403         if trace.enabled {
3404                 traceGoPark(mp.waittraceev, mp.waittraceskip)
3405         }
3406
3407         casgstatus(gp, _Grunning, _Gwaiting)
3408         dropg()
3409
3410         if fn := mp.waitunlockf; fn != nil {
3411                 ok := fn(gp, mp.waitlock)
3412                 mp.waitunlockf = nil
3413                 mp.waitlock = nil
3414                 if !ok {
3415                         if trace.enabled {
3416                                 traceGoUnpark(gp, 2)
3417                         }
3418                         casgstatus(gp, _Gwaiting, _Grunnable)
3419                         execute(gp, true) // Schedule it back, never returns.
3420                 }
3421         }
3422         schedule()
3423 }
3424
3425 func goschedImpl(gp *g) {
3426         status := readgstatus(gp)
3427         if status&^_Gscan != _Grunning {
3428                 dumpgstatus(gp)
3429                 throw("bad g status")
3430         }
3431         casgstatus(gp, _Grunning, _Grunnable)
3432         dropg()
3433         lock(&sched.lock)
3434         globrunqput(gp)
3435         unlock(&sched.lock)
3436
3437         schedule()
3438 }
3439
3440 // Gosched continuation on g0.
3441 func gosched_m(gp *g) {
3442         if trace.enabled {
3443                 traceGoSched()
3444         }
3445         goschedImpl(gp)
3446 }
3447
3448 // goschedguarded is a forbidden-states-avoided version of gosched_m
3449 func goschedguarded_m(gp *g) {
3450
3451         if !canPreemptM(gp.m) {
3452                 gogo(&gp.sched) // never return
3453         }
3454
3455         if trace.enabled {
3456                 traceGoSched()
3457         }
3458         goschedImpl(gp)
3459 }
3460
3461 func gopreempt_m(gp *g) {
3462         if trace.enabled {
3463                 traceGoPreempt()
3464         }
3465         goschedImpl(gp)
3466 }
3467
3468 // preemptPark parks gp and puts it in _Gpreempted.
3469 //
3470 //go:systemstack
3471 func preemptPark(gp *g) {
3472         if trace.enabled {
3473                 traceGoPark(traceEvGoBlock, 0)
3474         }
3475         status := readgstatus(gp)
3476         if status&^_Gscan != _Grunning {
3477                 dumpgstatus(gp)
3478                 throw("bad g status")
3479         }
3480         gp.waitreason = waitReasonPreempted
3481
3482         if gp.asyncSafePoint {
3483                 // Double-check that async preemption does not
3484                 // happen in SPWRITE assembly functions.
3485                 // isAsyncSafePoint must exclude this case.
3486                 f := findfunc(gp.sched.pc)
3487                 if !f.valid() {
3488                         throw("preempt at unknown pc")
3489                 }
3490                 if f.flag&funcFlag_SPWRITE != 0 {
3491                         println("runtime: unexpected SPWRITE function", funcname(f), "in async preempt")
3492                         throw("preempt SPWRITE")
3493                 }
3494         }
3495
3496         // Transition from _Grunning to _Gscan|_Gpreempted. We can't
3497         // be in _Grunning when we dropg because then we'd be running
3498         // without an M, but the moment we're in _Gpreempted,
3499         // something could claim this G before we've fully cleaned it
3500         // up. Hence, we set the scan bit to lock down further
3501         // transitions until we can dropg.
3502         casGToPreemptScan(gp, _Grunning, _Gscan|_Gpreempted)
3503         dropg()
3504         casfrom_Gscanstatus(gp, _Gscan|_Gpreempted, _Gpreempted)
3505         schedule()
3506 }
3507
3508 // goyield is like Gosched, but it:
3509 // - emits a GoPreempt trace event instead of a GoSched trace event
3510 // - puts the current G on the runq of the current P instead of the globrunq
3511 func goyield() {
3512         checkTimeouts()
3513         mcall(goyield_m)
3514 }
3515
3516 func goyield_m(gp *g) {
3517         if trace.enabled {
3518                 traceGoPreempt()
3519         }
3520         pp := gp.m.p.ptr()
3521         casgstatus(gp, _Grunning, _Grunnable)
3522         dropg()
3523         runqput(pp, gp, false)
3524         schedule()
3525 }
3526
3527 // Finishes execution of the current goroutine.
3528 func goexit1() {
3529         if raceenabled {
3530                 racegoend()
3531         }
3532         if trace.enabled {
3533                 traceGoEnd()
3534         }
3535         mcall(goexit0)
3536 }
3537
3538 // goexit continuation on g0.
3539 func goexit0(gp *g) {
3540         mp := getg().m
3541         pp := mp.p.ptr()
3542
3543         casgstatus(gp, _Grunning, _Gdead)
3544         gcController.addScannableStack(pp, -int64(gp.stack.hi-gp.stack.lo))
3545         if isSystemGoroutine(gp, false) {
3546                 sched.ngsys.Add(-1)
3547         }
3548         gp.m = nil
3549         locked := gp.lockedm != 0
3550         gp.lockedm = 0
3551         mp.lockedg = 0
3552         gp.preemptStop = false
3553         gp.paniconfault = false
3554         gp._defer = nil // should be true already but just in case.
3555         gp._panic = nil // non-nil for Goexit during panic. points at stack-allocated data.
3556         gp.writebuf = nil
3557         gp.waitreason = 0
3558         gp.param = nil
3559         gp.labels = nil
3560         gp.timer = nil
3561
3562         if gcBlackenEnabled != 0 && gp.gcAssistBytes > 0 {
3563                 // Flush assist credit to the global pool. This gives
3564                 // better information to pacing if the application is
3565                 // rapidly creating an exiting goroutines.
3566                 assistWorkPerByte := gcController.assistWorkPerByte.Load()
3567                 scanCredit := int64(assistWorkPerByte * float64(gp.gcAssistBytes))
3568                 gcController.bgScanCredit.Add(scanCredit)
3569                 gp.gcAssistBytes = 0
3570         }
3571
3572         dropg()
3573
3574         if GOARCH == "wasm" { // no threads yet on wasm
3575                 gfput(pp, gp)
3576                 schedule() // never returns
3577         }
3578
3579         if mp.lockedInt != 0 {
3580                 print("invalid m->lockedInt = ", mp.lockedInt, "\n")
3581                 throw("internal lockOSThread error")
3582         }
3583         gfput(pp, gp)
3584         if locked {
3585                 // The goroutine may have locked this thread because
3586                 // it put it in an unusual kernel state. Kill it
3587                 // rather than returning it to the thread pool.
3588
3589                 // Return to mstart, which will release the P and exit
3590                 // the thread.
3591                 if GOOS != "plan9" { // See golang.org/issue/22227.
3592                         gogo(&mp.g0.sched)
3593                 } else {
3594                         // Clear lockedExt on plan9 since we may end up re-using
3595                         // this thread.
3596                         mp.lockedExt = 0
3597                 }
3598         }
3599         schedule()
3600 }
3601
3602 // save updates getg().sched to refer to pc and sp so that a following
3603 // gogo will restore pc and sp.
3604 //
3605 // save must not have write barriers because invoking a write barrier
3606 // can clobber getg().sched.
3607 //
3608 //go:nosplit
3609 //go:nowritebarrierrec
3610 func save(pc, sp uintptr) {
3611         gp := getg()
3612
3613         if gp == gp.m.g0 || gp == gp.m.gsignal {
3614                 // m.g0.sched is special and must describe the context
3615                 // for exiting the thread. mstart1 writes to it directly.
3616                 // m.gsignal.sched should not be used at all.
3617                 // This check makes sure save calls do not accidentally
3618                 // run in contexts where they'd write to system g's.
3619                 throw("save on system g not allowed")
3620         }
3621
3622         gp.sched.pc = pc
3623         gp.sched.sp = sp
3624         gp.sched.lr = 0
3625         gp.sched.ret = 0
3626         // We need to ensure ctxt is zero, but can't have a write
3627         // barrier here. However, it should always already be zero.
3628         // Assert that.
3629         if gp.sched.ctxt != nil {
3630                 badctxt()
3631         }
3632 }
3633
3634 // The goroutine g is about to enter a system call.
3635 // Record that it's not using the cpu anymore.
3636 // This is called only from the go syscall library and cgocall,
3637 // not from the low-level system calls used by the runtime.
3638 //
3639 // Entersyscall cannot split the stack: the save must
3640 // make g->sched refer to the caller's stack segment, because
3641 // entersyscall is going to return immediately after.
3642 //
3643 // Nothing entersyscall calls can split the stack either.
3644 // We cannot safely move the stack during an active call to syscall,
3645 // because we do not know which of the uintptr arguments are
3646 // really pointers (back into the stack).
3647 // In practice, this means that we make the fast path run through
3648 // entersyscall doing no-split things, and the slow path has to use systemstack
3649 // to run bigger things on the system stack.
3650 //
3651 // reentersyscall is the entry point used by cgo callbacks, where explicitly
3652 // saved SP and PC are restored. This is needed when exitsyscall will be called
3653 // from a function further up in the call stack than the parent, as g->syscallsp
3654 // must always point to a valid stack frame. entersyscall below is the normal
3655 // entry point for syscalls, which obtains the SP and PC from the caller.
3656 //
3657 // Syscall tracing:
3658 // At the start of a syscall we emit traceGoSysCall to capture the stack trace.
3659 // If the syscall does not block, that is it, we do not emit any other events.
3660 // If the syscall blocks (that is, P is retaken), retaker emits traceGoSysBlock;
3661 // when syscall returns we emit traceGoSysExit and when the goroutine starts running
3662 // (potentially instantly, if exitsyscallfast returns true) we emit traceGoStart.
3663 // To ensure that traceGoSysExit is emitted strictly after traceGoSysBlock,
3664 // we remember current value of syscalltick in m (gp.m.syscalltick = gp.m.p.ptr().syscalltick),
3665 // whoever emits traceGoSysBlock increments p.syscalltick afterwards;
3666 // and we wait for the increment before emitting traceGoSysExit.
3667 // Note that the increment is done even if tracing is not enabled,
3668 // because tracing can be enabled in the middle of syscall. We don't want the wait to hang.
3669 //
3670 //go:nosplit
3671 func reentersyscall(pc, sp uintptr) {
3672         gp := getg()
3673
3674         // Disable preemption because during this function g is in Gsyscall status,
3675         // but can have inconsistent g->sched, do not let GC observe it.
3676         gp.m.locks++
3677
3678         // Entersyscall must not call any function that might split/grow the stack.
3679         // (See details in comment above.)
3680         // Catch calls that might, by replacing the stack guard with something that
3681         // will trip any stack check and leaving a flag to tell newstack to die.
3682         gp.stackguard0 = stackPreempt
3683         gp.throwsplit = true
3684
3685         // Leave SP around for GC and traceback.
3686         save(pc, sp)
3687         gp.syscallsp = sp
3688         gp.syscallpc = pc
3689         casgstatus(gp, _Grunning, _Gsyscall)
3690         if gp.syscallsp < gp.stack.lo || gp.stack.hi < gp.syscallsp {
3691                 systemstack(func() {
3692                         print("entersyscall inconsistent ", hex(gp.syscallsp), " [", hex(gp.stack.lo), ",", hex(gp.stack.hi), "]\n")
3693                         throw("entersyscall")
3694                 })
3695         }
3696
3697         if trace.enabled {
3698                 systemstack(traceGoSysCall)
3699                 // systemstack itself clobbers g.sched.{pc,sp} and we might
3700                 // need them later when the G is genuinely blocked in a
3701                 // syscall
3702                 save(pc, sp)
3703         }
3704
3705         if sched.sysmonwait.Load() {
3706                 systemstack(entersyscall_sysmon)
3707                 save(pc, sp)
3708         }
3709
3710         if gp.m.p.ptr().runSafePointFn != 0 {
3711                 // runSafePointFn may stack split if run on this stack
3712                 systemstack(runSafePointFn)
3713                 save(pc, sp)
3714         }
3715
3716         gp.m.syscalltick = gp.m.p.ptr().syscalltick
3717         gp.sysblocktraced = true
3718         pp := gp.m.p.ptr()
3719         pp.m = 0
3720         gp.m.oldp.set(pp)
3721         gp.m.p = 0
3722         atomic.Store(&pp.status, _Psyscall)
3723         if sched.gcwaiting.Load() {
3724                 systemstack(entersyscall_gcwait)
3725                 save(pc, sp)
3726         }
3727
3728         gp.m.locks--
3729 }
3730
3731 // Standard syscall entry used by the go syscall library and normal cgo calls.
3732 //
3733 // This is exported via linkname to assembly in the syscall package and x/sys.
3734 //
3735 //go:nosplit
3736 //go:linkname entersyscall
3737 func entersyscall() {
3738         reentersyscall(getcallerpc(), getcallersp())
3739 }
3740
3741 func entersyscall_sysmon() {
3742         lock(&sched.lock)
3743         if sched.sysmonwait.Load() {
3744                 sched.sysmonwait.Store(false)
3745                 notewakeup(&sched.sysmonnote)
3746         }
3747         unlock(&sched.lock)
3748 }
3749
3750 func entersyscall_gcwait() {
3751         gp := getg()
3752         pp := gp.m.oldp.ptr()
3753
3754         lock(&sched.lock)
3755         if sched.stopwait > 0 && atomic.Cas(&pp.status, _Psyscall, _Pgcstop) {
3756                 if trace.enabled {
3757                         traceGoSysBlock(pp)
3758                         traceProcStop(pp)
3759                 }
3760                 pp.syscalltick++
3761                 if sched.stopwait--; sched.stopwait == 0 {
3762                         notewakeup(&sched.stopnote)
3763                 }
3764         }
3765         unlock(&sched.lock)
3766 }
3767
3768 // The same as entersyscall(), but with a hint that the syscall is blocking.
3769 //
3770 //go:nosplit
3771 func entersyscallblock() {
3772         gp := getg()
3773
3774         gp.m.locks++ // see comment in entersyscall
3775         gp.throwsplit = true
3776         gp.stackguard0 = stackPreempt // see comment in entersyscall
3777         gp.m.syscalltick = gp.m.p.ptr().syscalltick
3778         gp.sysblocktraced = true
3779         gp.m.p.ptr().syscalltick++
3780
3781         // Leave SP around for GC and traceback.
3782         pc := getcallerpc()
3783         sp := getcallersp()
3784         save(pc, sp)
3785         gp.syscallsp = gp.sched.sp
3786         gp.syscallpc = gp.sched.pc
3787         if gp.syscallsp < gp.stack.lo || gp.stack.hi < gp.syscallsp {
3788                 sp1 := sp
3789                 sp2 := gp.sched.sp
3790                 sp3 := gp.syscallsp
3791                 systemstack(func() {
3792                         print("entersyscallblock inconsistent ", hex(sp1), " ", hex(sp2), " ", hex(sp3), " [", hex(gp.stack.lo), ",", hex(gp.stack.hi), "]\n")
3793                         throw("entersyscallblock")
3794                 })
3795         }
3796         casgstatus(gp, _Grunning, _Gsyscall)
3797         if gp.syscallsp < gp.stack.lo || gp.stack.hi < gp.syscallsp {
3798                 systemstack(func() {
3799                         print("entersyscallblock inconsistent ", hex(sp), " ", hex(gp.sched.sp), " ", hex(gp.syscallsp), " [", hex(gp.stack.lo), ",", hex(gp.stack.hi), "]\n")
3800                         throw("entersyscallblock")
3801                 })
3802         }
3803
3804         systemstack(entersyscallblock_handoff)
3805
3806         // Resave for traceback during blocked call.
3807         save(getcallerpc(), getcallersp())
3808
3809         gp.m.locks--
3810 }
3811
3812 func entersyscallblock_handoff() {
3813         if trace.enabled {
3814                 traceGoSysCall()
3815                 traceGoSysBlock(getg().m.p.ptr())
3816         }
3817         handoffp(releasep())
3818 }
3819
3820 // The goroutine g exited its system call.
3821 // Arrange for it to run on a cpu again.
3822 // This is called only from the go syscall library, not
3823 // from the low-level system calls used by the runtime.
3824 //
3825 // Write barriers are not allowed because our P may have been stolen.
3826 //
3827 // This is exported via linkname to assembly in the syscall package.
3828 //
3829 //go:nosplit
3830 //go:nowritebarrierrec
3831 //go:linkname exitsyscall
3832 func exitsyscall() {
3833         gp := getg()
3834
3835         gp.m.locks++ // see comment in entersyscall
3836         if getcallersp() > gp.syscallsp {
3837                 throw("exitsyscall: syscall frame is no longer valid")
3838         }
3839
3840         gp.waitsince = 0
3841         oldp := gp.m.oldp.ptr()
3842         gp.m.oldp = 0
3843         if exitsyscallfast(oldp) {
3844                 // When exitsyscallfast returns success, we have a P so can now use
3845                 // write barriers
3846                 if goroutineProfile.active {
3847                         // Make sure that gp has had its stack written out to the goroutine
3848                         // profile, exactly as it was when the goroutine profiler first
3849                         // stopped the world.
3850                         systemstack(func() {
3851                                 tryRecordGoroutineProfileWB(gp)
3852                         })
3853                 }
3854                 if trace.enabled {
3855                         if oldp != gp.m.p.ptr() || gp.m.syscalltick != gp.m.p.ptr().syscalltick {
3856                                 systemstack(traceGoStart)
3857                         }
3858                 }
3859                 // There's a cpu for us, so we can run.
3860                 gp.m.p.ptr().syscalltick++
3861                 // We need to cas the status and scan before resuming...
3862                 casgstatus(gp, _Gsyscall, _Grunning)
3863
3864                 // Garbage collector isn't running (since we are),
3865                 // so okay to clear syscallsp.
3866                 gp.syscallsp = 0
3867                 gp.m.locks--
3868                 if gp.preempt {
3869                         // restore the preemption request in case we've cleared it in newstack
3870                         gp.stackguard0 = stackPreempt
3871                 } else {
3872                         // otherwise restore the real _StackGuard, we've spoiled it in entersyscall/entersyscallblock
3873                         gp.stackguard0 = gp.stack.lo + _StackGuard
3874                 }
3875                 gp.throwsplit = false
3876
3877                 if sched.disable.user && !schedEnabled(gp) {
3878                         // Scheduling of this goroutine is disabled.
3879                         Gosched()
3880                 }
3881
3882                 return
3883         }
3884
3885         gp.sysexitticks = 0
3886         if trace.enabled {
3887                 // Wait till traceGoSysBlock event is emitted.
3888                 // This ensures consistency of the trace (the goroutine is started after it is blocked).
3889                 for oldp != nil && oldp.syscalltick == gp.m.syscalltick {
3890                         osyield()
3891                 }
3892                 // We can't trace syscall exit right now because we don't have a P.
3893                 // Tracing code can invoke write barriers that cannot run without a P.
3894                 // So instead we remember the syscall exit time and emit the event
3895                 // in execute when we have a P.
3896                 gp.sysexitticks = cputicks()
3897         }
3898
3899         gp.m.locks--
3900
3901         // Call the scheduler.
3902         mcall(exitsyscall0)
3903
3904         // Scheduler returned, so we're allowed to run now.
3905         // Delete the syscallsp information that we left for
3906         // the garbage collector during the system call.
3907         // Must wait until now because until gosched returns
3908         // we don't know for sure that the garbage collector
3909         // is not running.
3910         gp.syscallsp = 0
3911         gp.m.p.ptr().syscalltick++
3912         gp.throwsplit = false
3913 }
3914
3915 //go:nosplit
3916 func exitsyscallfast(oldp *p) bool {
3917         gp := getg()
3918
3919         // Freezetheworld sets stopwait but does not retake P's.
3920         if sched.stopwait == freezeStopWait {
3921                 return false
3922         }
3923
3924         // Try to re-acquire the last P.
3925         if oldp != nil && oldp.status == _Psyscall && atomic.Cas(&oldp.status, _Psyscall, _Pidle) {
3926                 // There's a cpu for us, so we can run.
3927                 wirep(oldp)
3928                 exitsyscallfast_reacquired()
3929                 return true
3930         }
3931
3932         // Try to get any other idle P.
3933         if sched.pidle != 0 {
3934                 var ok bool
3935                 systemstack(func() {
3936                         ok = exitsyscallfast_pidle()
3937                         if ok && trace.enabled {
3938                                 if oldp != nil {
3939                                         // Wait till traceGoSysBlock event is emitted.
3940                                         // This ensures consistency of the trace (the goroutine is started after it is blocked).
3941                                         for oldp.syscalltick == gp.m.syscalltick {
3942                                                 osyield()
3943                                         }
3944                                 }
3945                                 traceGoSysExit(0)
3946                         }
3947                 })
3948                 if ok {
3949                         return true
3950                 }
3951         }
3952         return false
3953 }
3954
3955 // exitsyscallfast_reacquired is the exitsyscall path on which this G
3956 // has successfully reacquired the P it was running on before the
3957 // syscall.
3958 //
3959 //go:nosplit
3960 func exitsyscallfast_reacquired() {
3961         gp := getg()
3962         if gp.m.syscalltick != gp.m.p.ptr().syscalltick {
3963                 if trace.enabled {
3964                         // The p was retaken and then enter into syscall again (since gp.m.syscalltick has changed).
3965                         // traceGoSysBlock for this syscall was already emitted,
3966                         // but here we effectively retake the p from the new syscall running on the same p.
3967                         systemstack(func() {
3968                                 // Denote blocking of the new syscall.
3969                                 traceGoSysBlock(gp.m.p.ptr())
3970                                 // Denote completion of the current syscall.
3971                                 traceGoSysExit(0)
3972                         })
3973                 }
3974                 gp.m.p.ptr().syscalltick++
3975         }
3976 }
3977
3978 func exitsyscallfast_pidle() bool {
3979         lock(&sched.lock)
3980         pp, _ := pidleget(0)
3981         if pp != nil && sched.sysmonwait.Load() {
3982                 sched.sysmonwait.Store(false)
3983                 notewakeup(&sched.sysmonnote)
3984         }
3985         unlock(&sched.lock)
3986         if pp != nil {
3987                 acquirep(pp)
3988                 return true
3989         }
3990         return false
3991 }
3992
3993 // exitsyscall slow path on g0.
3994 // Failed to acquire P, enqueue gp as runnable.
3995 //
3996 // Called via mcall, so gp is the calling g from this M.
3997 //
3998 //go:nowritebarrierrec
3999 func exitsyscall0(gp *g) {
4000         casgstatus(gp, _Gsyscall, _Grunnable)
4001         dropg()
4002         lock(&sched.lock)
4003         var pp *p
4004         if schedEnabled(gp) {
4005                 pp, _ = pidleget(0)
4006         }
4007         var locked bool
4008         if pp == nil {
4009                 globrunqput(gp)
4010
4011                 // Below, we stoplockedm if gp is locked. globrunqput releases
4012                 // ownership of gp, so we must check if gp is locked prior to
4013                 // committing the release by unlocking sched.lock, otherwise we
4014                 // could race with another M transitioning gp from unlocked to
4015                 // locked.
4016                 locked = gp.lockedm != 0
4017         } else if sched.sysmonwait.Load() {
4018                 sched.sysmonwait.Store(false)
4019                 notewakeup(&sched.sysmonnote)
4020         }
4021         unlock(&sched.lock)
4022         if pp != nil {
4023                 acquirep(pp)
4024                 execute(gp, false) // Never returns.
4025         }
4026         if locked {
4027                 // Wait until another thread schedules gp and so m again.
4028                 //
4029                 // N.B. lockedm must be this M, as this g was running on this M
4030                 // before entersyscall.
4031                 stoplockedm()
4032                 execute(gp, false) // Never returns.
4033         }
4034         stopm()
4035         schedule() // Never returns.
4036 }
4037
4038 // Called from syscall package before fork.
4039 //
4040 //go:linkname syscall_runtime_BeforeFork syscall.runtime_BeforeFork
4041 //go:nosplit
4042 func syscall_runtime_BeforeFork() {
4043         gp := getg().m.curg
4044
4045         // Block signals during a fork, so that the child does not run
4046         // a signal handler before exec if a signal is sent to the process
4047         // group. See issue #18600.
4048         gp.m.locks++
4049         sigsave(&gp.m.sigmask)
4050         sigblock(false)
4051
4052         // This function is called before fork in syscall package.
4053         // Code between fork and exec must not allocate memory nor even try to grow stack.
4054         // Here we spoil g->_StackGuard to reliably detect any attempts to grow stack.
4055         // runtime_AfterFork will undo this in parent process, but not in child.
4056         gp.stackguard0 = stackFork
4057 }
4058
4059 // Called from syscall package after fork in parent.
4060 //
4061 //go:linkname syscall_runtime_AfterFork syscall.runtime_AfterFork
4062 //go:nosplit
4063 func syscall_runtime_AfterFork() {
4064         gp := getg().m.curg
4065
4066         // See the comments in beforefork.
4067         gp.stackguard0 = gp.stack.lo + _StackGuard
4068
4069         msigrestore(gp.m.sigmask)
4070
4071         gp.m.locks--
4072 }
4073
4074 // inForkedChild is true while manipulating signals in the child process.
4075 // This is used to avoid calling libc functions in case we are using vfork.
4076 var inForkedChild bool
4077
4078 // Called from syscall package after fork in child.
4079 // It resets non-sigignored signals to the default handler, and
4080 // restores the signal mask in preparation for the exec.
4081 //
4082 // Because this might be called during a vfork, and therefore may be
4083 // temporarily sharing address space with the parent process, this must
4084 // not change any global variables or calling into C code that may do so.
4085 //
4086 //go:linkname syscall_runtime_AfterForkInChild syscall.runtime_AfterForkInChild
4087 //go:nosplit
4088 //go:nowritebarrierrec
4089 func syscall_runtime_AfterForkInChild() {
4090         // It's OK to change the global variable inForkedChild here
4091         // because we are going to change it back. There is no race here,
4092         // because if we are sharing address space with the parent process,
4093         // then the parent process can not be running concurrently.
4094         inForkedChild = true
4095
4096         clearSignalHandlers()
4097
4098         // When we are the child we are the only thread running,
4099         // so we know that nothing else has changed gp.m.sigmask.
4100         msigrestore(getg().m.sigmask)
4101
4102         inForkedChild = false
4103 }
4104
4105 // pendingPreemptSignals is the number of preemption signals
4106 // that have been sent but not received. This is only used on Darwin.
4107 // For #41702.
4108 var pendingPreemptSignals atomic.Int32
4109
4110 // Called from syscall package before Exec.
4111 //
4112 //go:linkname syscall_runtime_BeforeExec syscall.runtime_BeforeExec
4113 func syscall_runtime_BeforeExec() {
4114         // Prevent thread creation during exec.
4115         execLock.lock()
4116
4117         // On Darwin, wait for all pending preemption signals to
4118         // be received. See issue #41702.
4119         if GOOS == "darwin" || GOOS == "ios" {
4120                 for pendingPreemptSignals.Load() > 0 {
4121                         osyield()
4122                 }
4123         }
4124 }
4125
4126 // Called from syscall package after Exec.
4127 //
4128 //go:linkname syscall_runtime_AfterExec syscall.runtime_AfterExec
4129 func syscall_runtime_AfterExec() {
4130         execLock.unlock()
4131 }
4132
4133 // Allocate a new g, with a stack big enough for stacksize bytes.
4134 func malg(stacksize int32) *g {
4135         newg := new(g)
4136         if stacksize >= 0 {
4137                 stacksize = round2(_StackSystem + stacksize)
4138                 systemstack(func() {
4139                         newg.stack = stackalloc(uint32(stacksize))
4140                 })
4141                 newg.stackguard0 = newg.stack.lo + _StackGuard
4142                 newg.stackguard1 = ^uintptr(0)
4143                 // Clear the bottom word of the stack. We record g
4144                 // there on gsignal stack during VDSO on ARM and ARM64.
4145                 *(*uintptr)(unsafe.Pointer(newg.stack.lo)) = 0
4146         }
4147         return newg
4148 }
4149
4150 // Create a new g running fn.
4151 // Put it on the queue of g's waiting to run.
4152 // The compiler turns a go statement into a call to this.
4153 func newproc(fn *funcval) {
4154         gp := getg()
4155         pc := getcallerpc()
4156         systemstack(func() {
4157                 newg := newproc1(fn, gp, pc)
4158
4159                 pp := getg().m.p.ptr()
4160                 runqput(pp, newg, true)
4161
4162                 if mainStarted {
4163                         wakep()
4164                 }
4165         })
4166 }
4167
4168 // Create a new g in state _Grunnable, starting at fn. callerpc is the
4169 // address of the go statement that created this. The caller is responsible
4170 // for adding the new g to the scheduler.
4171 func newproc1(fn *funcval, callergp *g, callerpc uintptr) *g {
4172         if fn == nil {
4173                 fatal("go of nil func value")
4174         }
4175
4176         mp := acquirem() // disable preemption because we hold M and P in local vars.
4177         pp := mp.p.ptr()
4178         newg := gfget(pp)
4179         if newg == nil {
4180                 newg = malg(_StackMin)
4181                 casgstatus(newg, _Gidle, _Gdead)
4182                 allgadd(newg) // publishes with a g->status of Gdead so GC scanner doesn't look at uninitialized stack.
4183         }
4184         if newg.stack.hi == 0 {
4185                 throw("newproc1: newg missing stack")
4186         }
4187
4188         if readgstatus(newg) != _Gdead {
4189                 throw("newproc1: new g is not Gdead")
4190         }
4191
4192         totalSize := uintptr(4*goarch.PtrSize + sys.MinFrameSize) // extra space in case of reads slightly beyond frame
4193         totalSize = alignUp(totalSize, sys.StackAlign)
4194         sp := newg.stack.hi - totalSize
4195         spArg := sp
4196         if usesLR {
4197                 // caller's LR
4198                 *(*uintptr)(unsafe.Pointer(sp)) = 0
4199                 prepGoExitFrame(sp)
4200                 spArg += sys.MinFrameSize
4201         }
4202
4203         memclrNoHeapPointers(unsafe.Pointer(&newg.sched), unsafe.Sizeof(newg.sched))
4204         newg.sched.sp = sp
4205         newg.stktopsp = sp
4206         newg.sched.pc = abi.FuncPCABI0(goexit) + sys.PCQuantum // +PCQuantum so that previous instruction is in same function
4207         newg.sched.g = guintptr(unsafe.Pointer(newg))
4208         gostartcallfn(&newg.sched, fn)
4209         newg.gopc = callerpc
4210         newg.ancestors = saveAncestors(callergp)
4211         newg.startpc = fn.fn
4212         if isSystemGoroutine(newg, false) {
4213                 sched.ngsys.Add(1)
4214         } else {
4215                 // Only user goroutines inherit pprof labels.
4216                 if mp.curg != nil {
4217                         newg.labels = mp.curg.labels
4218                 }
4219                 if goroutineProfile.active {
4220                         // A concurrent goroutine profile is running. It should include
4221                         // exactly the set of goroutines that were alive when the goroutine
4222                         // profiler first stopped the world. That does not include newg, so
4223                         // mark it as not needing a profile before transitioning it from
4224                         // _Gdead.
4225                         newg.goroutineProfiled.Store(goroutineProfileSatisfied)
4226                 }
4227         }
4228         // Track initial transition?
4229         newg.trackingSeq = uint8(fastrand())
4230         if newg.trackingSeq%gTrackingPeriod == 0 {
4231                 newg.tracking = true
4232         }
4233         casgstatus(newg, _Gdead, _Grunnable)
4234         gcController.addScannableStack(pp, int64(newg.stack.hi-newg.stack.lo))
4235
4236         if pp.goidcache == pp.goidcacheend {
4237                 // Sched.goidgen is the last allocated id,
4238                 // this batch must be [sched.goidgen+1, sched.goidgen+GoidCacheBatch].
4239                 // At startup sched.goidgen=0, so main goroutine receives goid=1.
4240                 pp.goidcache = sched.goidgen.Add(_GoidCacheBatch)
4241                 pp.goidcache -= _GoidCacheBatch - 1
4242                 pp.goidcacheend = pp.goidcache + _GoidCacheBatch
4243         }
4244         newg.goid = pp.goidcache
4245         pp.goidcache++
4246         if raceenabled {
4247                 newg.racectx = racegostart(callerpc)
4248                 if newg.labels != nil {
4249                         // See note in proflabel.go on labelSync's role in synchronizing
4250                         // with the reads in the signal handler.
4251                         racereleasemergeg(newg, unsafe.Pointer(&labelSync))
4252                 }
4253         }
4254         if trace.enabled {
4255                 traceGoCreate(newg, newg.startpc)
4256         }
4257         releasem(mp)
4258
4259         return newg
4260 }
4261
4262 // saveAncestors copies previous ancestors of the given caller g and
4263 // includes infor for the current caller into a new set of tracebacks for
4264 // a g being created.
4265 func saveAncestors(callergp *g) *[]ancestorInfo {
4266         // Copy all prior info, except for the root goroutine (goid 0).
4267         if debug.tracebackancestors <= 0 || callergp.goid == 0 {
4268                 return nil
4269         }
4270         var callerAncestors []ancestorInfo
4271         if callergp.ancestors != nil {
4272                 callerAncestors = *callergp.ancestors
4273         }
4274         n := int32(len(callerAncestors)) + 1
4275         if n > debug.tracebackancestors {
4276                 n = debug.tracebackancestors
4277         }
4278         ancestors := make([]ancestorInfo, n)
4279         copy(ancestors[1:], callerAncestors)
4280
4281         var pcs [_TracebackMaxFrames]uintptr
4282         npcs := gcallers(callergp, 0, pcs[:])
4283         ipcs := make([]uintptr, npcs)
4284         copy(ipcs, pcs[:])
4285         ancestors[0] = ancestorInfo{
4286                 pcs:  ipcs,
4287                 goid: callergp.goid,
4288                 gopc: callergp.gopc,
4289         }
4290
4291         ancestorsp := new([]ancestorInfo)
4292         *ancestorsp = ancestors
4293         return ancestorsp
4294 }
4295
4296 // Put on gfree list.
4297 // If local list is too long, transfer a batch to the global list.
4298 func gfput(pp *p, gp *g) {
4299         if readgstatus(gp) != _Gdead {
4300                 throw("gfput: bad status (not Gdead)")
4301         }
4302
4303         stksize := gp.stack.hi - gp.stack.lo
4304
4305         if stksize != uintptr(startingStackSize) {
4306                 // non-standard stack size - free it.
4307                 stackfree(gp.stack)
4308                 gp.stack.lo = 0
4309                 gp.stack.hi = 0
4310                 gp.stackguard0 = 0
4311         }
4312
4313         pp.gFree.push(gp)
4314         pp.gFree.n++
4315         if pp.gFree.n >= 64 {
4316                 var (
4317                         inc      int32
4318                         stackQ   gQueue
4319                         noStackQ gQueue
4320                 )
4321                 for pp.gFree.n >= 32 {
4322                         gp := pp.gFree.pop()
4323                         pp.gFree.n--
4324                         if gp.stack.lo == 0 {
4325                                 noStackQ.push(gp)
4326                         } else {
4327                                 stackQ.push(gp)
4328                         }
4329                         inc++
4330                 }
4331                 lock(&sched.gFree.lock)
4332                 sched.gFree.noStack.pushAll(noStackQ)
4333                 sched.gFree.stack.pushAll(stackQ)
4334                 sched.gFree.n += inc
4335                 unlock(&sched.gFree.lock)
4336         }
4337 }
4338
4339 // Get from gfree list.
4340 // If local list is empty, grab a batch from global list.
4341 func gfget(pp *p) *g {
4342 retry:
4343         if pp.gFree.empty() && (!sched.gFree.stack.empty() || !sched.gFree.noStack.empty()) {
4344                 lock(&sched.gFree.lock)
4345                 // Move a batch of free Gs to the P.
4346                 for pp.gFree.n < 32 {
4347                         // Prefer Gs with stacks.
4348                         gp := sched.gFree.stack.pop()
4349                         if gp == nil {
4350                                 gp = sched.gFree.noStack.pop()
4351                                 if gp == nil {
4352                                         break
4353                                 }
4354                         }
4355                         sched.gFree.n--
4356                         pp.gFree.push(gp)
4357                         pp.gFree.n++
4358                 }
4359                 unlock(&sched.gFree.lock)
4360                 goto retry
4361         }
4362         gp := pp.gFree.pop()
4363         if gp == nil {
4364                 return nil
4365         }
4366         pp.gFree.n--
4367         if gp.stack.lo != 0 && gp.stack.hi-gp.stack.lo != uintptr(startingStackSize) {
4368                 // Deallocate old stack. We kept it in gfput because it was the
4369                 // right size when the goroutine was put on the free list, but
4370                 // the right size has changed since then.
4371                 systemstack(func() {
4372                         stackfree(gp.stack)
4373                         gp.stack.lo = 0
4374                         gp.stack.hi = 0
4375                         gp.stackguard0 = 0
4376                 })
4377         }
4378         if gp.stack.lo == 0 {
4379                 // Stack was deallocated in gfput or just above. Allocate a new one.
4380                 systemstack(func() {
4381                         gp.stack = stackalloc(startingStackSize)
4382                 })
4383                 gp.stackguard0 = gp.stack.lo + _StackGuard
4384         } else {
4385                 if raceenabled {
4386                         racemalloc(unsafe.Pointer(gp.stack.lo), gp.stack.hi-gp.stack.lo)
4387                 }
4388                 if msanenabled {
4389                         msanmalloc(unsafe.Pointer(gp.stack.lo), gp.stack.hi-gp.stack.lo)
4390                 }
4391                 if asanenabled {
4392                         asanunpoison(unsafe.Pointer(gp.stack.lo), gp.stack.hi-gp.stack.lo)
4393                 }
4394         }
4395         return gp
4396 }
4397
4398 // Purge all cached G's from gfree list to the global list.
4399 func gfpurge(pp *p) {
4400         var (
4401                 inc      int32
4402                 stackQ   gQueue
4403                 noStackQ gQueue
4404         )
4405         for !pp.gFree.empty() {
4406                 gp := pp.gFree.pop()
4407                 pp.gFree.n--
4408                 if gp.stack.lo == 0 {
4409                         noStackQ.push(gp)
4410                 } else {
4411                         stackQ.push(gp)
4412                 }
4413                 inc++
4414         }
4415         lock(&sched.gFree.lock)
4416         sched.gFree.noStack.pushAll(noStackQ)
4417         sched.gFree.stack.pushAll(stackQ)
4418         sched.gFree.n += inc
4419         unlock(&sched.gFree.lock)
4420 }
4421
4422 // Breakpoint executes a breakpoint trap.
4423 func Breakpoint() {
4424         breakpoint()
4425 }
4426
4427 // dolockOSThread is called by LockOSThread and lockOSThread below
4428 // after they modify m.locked. Do not allow preemption during this call,
4429 // or else the m might be different in this function than in the caller.
4430 //
4431 //go:nosplit
4432 func dolockOSThread() {
4433         if GOARCH == "wasm" {
4434                 return // no threads on wasm yet
4435         }
4436         gp := getg()
4437         gp.m.lockedg.set(gp)
4438         gp.lockedm.set(gp.m)
4439 }
4440
4441 //go:nosplit
4442
4443 // LockOSThread wires the calling goroutine to its current operating system thread.
4444 // The calling goroutine will always execute in that thread,
4445 // and no other goroutine will execute in it,
4446 // until the calling goroutine has made as many calls to
4447 // UnlockOSThread as to LockOSThread.
4448 // If the calling goroutine exits without unlocking the thread,
4449 // the thread will be terminated.
4450 //
4451 // All init functions are run on the startup thread. Calling LockOSThread
4452 // from an init function will cause the main function to be invoked on
4453 // that thread.
4454 //
4455 // A goroutine should call LockOSThread before calling OS services or
4456 // non-Go library functions that depend on per-thread state.
4457 func LockOSThread() {
4458         if atomic.Load(&newmHandoff.haveTemplateThread) == 0 && GOOS != "plan9" {
4459                 // If we need to start a new thread from the locked
4460                 // thread, we need the template thread. Start it now
4461                 // while we're in a known-good state.
4462                 startTemplateThread()
4463         }
4464         gp := getg()
4465         gp.m.lockedExt++
4466         if gp.m.lockedExt == 0 {
4467                 gp.m.lockedExt--
4468                 panic("LockOSThread nesting overflow")
4469         }
4470         dolockOSThread()
4471 }
4472
4473 //go:nosplit
4474 func lockOSThread() {
4475         getg().m.lockedInt++
4476         dolockOSThread()
4477 }
4478
4479 // dounlockOSThread is called by UnlockOSThread and unlockOSThread below
4480 // after they update m->locked. Do not allow preemption during this call,
4481 // or else the m might be in different in this function than in the caller.
4482 //
4483 //go:nosplit
4484 func dounlockOSThread() {
4485         if GOARCH == "wasm" {
4486                 return // no threads on wasm yet
4487         }
4488         gp := getg()
4489         if gp.m.lockedInt != 0 || gp.m.lockedExt != 0 {
4490                 return
4491         }
4492         gp.m.lockedg = 0
4493         gp.lockedm = 0
4494 }
4495
4496 //go:nosplit
4497
4498 // UnlockOSThread undoes an earlier call to LockOSThread.
4499 // If this drops the number of active LockOSThread calls on the
4500 // calling goroutine to zero, it unwires the calling goroutine from
4501 // its fixed operating system thread.
4502 // If there are no active LockOSThread calls, this is a no-op.
4503 //
4504 // Before calling UnlockOSThread, the caller must ensure that the OS
4505 // thread is suitable for running other goroutines. If the caller made
4506 // any permanent changes to the state of the thread that would affect
4507 // other goroutines, it should not call this function and thus leave
4508 // the goroutine locked to the OS thread until the goroutine (and
4509 // hence the thread) exits.
4510 func UnlockOSThread() {
4511         gp := getg()
4512         if gp.m.lockedExt == 0 {
4513                 return
4514         }
4515         gp.m.lockedExt--
4516         dounlockOSThread()
4517 }
4518
4519 //go:nosplit
4520 func unlockOSThread() {
4521         gp := getg()
4522         if gp.m.lockedInt == 0 {
4523                 systemstack(badunlockosthread)
4524         }
4525         gp.m.lockedInt--
4526         dounlockOSThread()
4527 }
4528
4529 func badunlockosthread() {
4530         throw("runtime: internal error: misuse of lockOSThread/unlockOSThread")
4531 }
4532
4533 func gcount() int32 {
4534         n := int32(atomic.Loaduintptr(&allglen)) - sched.gFree.n - sched.ngsys.Load()
4535         for _, pp := range allp {
4536                 n -= pp.gFree.n
4537         }
4538
4539         // All these variables can be changed concurrently, so the result can be inconsistent.
4540         // But at least the current goroutine is running.
4541         if n < 1 {
4542                 n = 1
4543         }
4544         return n
4545 }
4546
4547 func mcount() int32 {
4548         return int32(sched.mnext - sched.nmfreed)
4549 }
4550
4551 var prof struct {
4552         signalLock atomic.Uint32
4553
4554         // Must hold signalLock to write. Reads may be lock-free, but
4555         // signalLock should be taken to synchronize with changes.
4556         hz atomic.Int32
4557 }
4558
4559 func _System()                    { _System() }
4560 func _ExternalCode()              { _ExternalCode() }
4561 func _LostExternalCode()          { _LostExternalCode() }
4562 func _GC()                        { _GC() }
4563 func _LostSIGPROFDuringAtomic64() { _LostSIGPROFDuringAtomic64() }
4564 func _VDSO()                      { _VDSO() }
4565
4566 // Called if we receive a SIGPROF signal.
4567 // Called by the signal handler, may run during STW.
4568 //
4569 //go:nowritebarrierrec
4570 func sigprof(pc, sp, lr uintptr, gp *g, mp *m) {
4571         if prof.hz.Load() == 0 {
4572                 return
4573         }
4574
4575         // If mp.profilehz is 0, then profiling is not enabled for this thread.
4576         // We must check this to avoid a deadlock between setcpuprofilerate
4577         // and the call to cpuprof.add, below.
4578         if mp != nil && mp.profilehz == 0 {
4579                 return
4580         }
4581
4582         // On mips{,le}/arm, 64bit atomics are emulated with spinlocks, in
4583         // runtime/internal/atomic. If SIGPROF arrives while the program is inside
4584         // the critical section, it creates a deadlock (when writing the sample).
4585         // As a workaround, create a counter of SIGPROFs while in critical section
4586         // to store the count, and pass it to sigprof.add() later when SIGPROF is
4587         // received from somewhere else (with _LostSIGPROFDuringAtomic64 as pc).
4588         if GOARCH == "mips" || GOARCH == "mipsle" || GOARCH == "arm" {
4589                 if f := findfunc(pc); f.valid() {
4590                         if hasPrefix(funcname(f), "runtime/internal/atomic") {
4591                                 cpuprof.lostAtomic++
4592                                 return
4593                         }
4594                 }
4595                 if GOARCH == "arm" && goarm < 7 && GOOS == "linux" && pc&0xffff0000 == 0xffff0000 {
4596                         // runtime/internal/atomic functions call into kernel
4597                         // helpers on arm < 7. See
4598                         // runtime/internal/atomic/sys_linux_arm.s.
4599                         cpuprof.lostAtomic++
4600                         return
4601                 }
4602         }
4603
4604         // Profiling runs concurrently with GC, so it must not allocate.
4605         // Set a trap in case the code does allocate.
4606         // Note that on windows, one thread takes profiles of all the
4607         // other threads, so mp is usually not getg().m.
4608         // In fact mp may not even be stopped.
4609         // See golang.org/issue/17165.
4610         getg().m.mallocing++
4611
4612         var stk [maxCPUProfStack]uintptr
4613         n := 0
4614         if mp.ncgo > 0 && mp.curg != nil && mp.curg.syscallpc != 0 && mp.curg.syscallsp != 0 {
4615                 cgoOff := 0
4616                 // Check cgoCallersUse to make sure that we are not
4617                 // interrupting other code that is fiddling with
4618                 // cgoCallers.  We are running in a signal handler
4619                 // with all signals blocked, so we don't have to worry
4620                 // about any other code interrupting us.
4621                 if atomic.Load(&mp.cgoCallersUse) == 0 && mp.cgoCallers != nil && mp.cgoCallers[0] != 0 {
4622                         for cgoOff < len(mp.cgoCallers) && mp.cgoCallers[cgoOff] != 0 {
4623                                 cgoOff++
4624                         }
4625                         copy(stk[:], mp.cgoCallers[:cgoOff])
4626                         mp.cgoCallers[0] = 0
4627                 }
4628
4629                 // Collect Go stack that leads to the cgo call.
4630                 n = gentraceback(mp.curg.syscallpc, mp.curg.syscallsp, 0, mp.curg, 0, &stk[cgoOff], len(stk)-cgoOff, nil, nil, 0)
4631                 if n > 0 {
4632                         n += cgoOff
4633                 }
4634         } else {
4635                 n = gentraceback(pc, sp, lr, gp, 0, &stk[0], len(stk), nil, nil, _TraceTrap|_TraceJumpStack)
4636         }
4637
4638         if n <= 0 {
4639                 // Normal traceback is impossible or has failed.
4640                 // See if it falls into several common cases.
4641                 n = 0
4642                 if usesLibcall() && mp.libcallg != 0 && mp.libcallpc != 0 && mp.libcallsp != 0 {
4643                         // Libcall, i.e. runtime syscall on windows.
4644                         // Collect Go stack that leads to the call.
4645                         n = gentraceback(mp.libcallpc, mp.libcallsp, 0, mp.libcallg.ptr(), 0, &stk[0], len(stk), nil, nil, 0)
4646                 }
4647                 if n == 0 && mp != nil && mp.vdsoSP != 0 {
4648                         n = gentraceback(mp.vdsoPC, mp.vdsoSP, 0, gp, 0, &stk[0], len(stk), nil, nil, _TraceTrap|_TraceJumpStack)
4649                 }
4650                 if n == 0 {
4651                         // If all of the above has failed, account it against abstract "System" or "GC".
4652                         n = 2
4653                         if inVDSOPage(pc) {
4654                                 pc = abi.FuncPCABIInternal(_VDSO) + sys.PCQuantum
4655                         } else if pc > firstmoduledata.etext {
4656                                 // "ExternalCode" is better than "etext".
4657                                 pc = abi.FuncPCABIInternal(_ExternalCode) + sys.PCQuantum
4658                         }
4659                         stk[0] = pc
4660                         if mp.preemptoff != "" {
4661                                 stk[1] = abi.FuncPCABIInternal(_GC) + sys.PCQuantum
4662                         } else {
4663                                 stk[1] = abi.FuncPCABIInternal(_System) + sys.PCQuantum
4664                         }
4665                 }
4666         }
4667
4668         if prof.hz.Load() != 0 {
4669                 // Note: it can happen on Windows that we interrupted a system thread
4670                 // with no g, so gp could nil. The other nil checks are done out of
4671                 // caution, but not expected to be nil in practice.
4672                 var tagPtr *unsafe.Pointer
4673                 if gp != nil && gp.m != nil && gp.m.curg != nil {
4674                         tagPtr = &gp.m.curg.labels
4675                 }
4676                 cpuprof.add(tagPtr, stk[:n])
4677
4678                 gprof := gp
4679                 var pp *p
4680                 if gp != nil && gp.m != nil {
4681                         if gp.m.curg != nil {
4682                                 gprof = gp.m.curg
4683                         }
4684                         pp = gp.m.p.ptr()
4685                 }
4686                 traceCPUSample(gprof, pp, stk[:n])
4687         }
4688         getg().m.mallocing--
4689 }
4690
4691 // setcpuprofilerate sets the CPU profiling rate to hz times per second.
4692 // If hz <= 0, setcpuprofilerate turns off CPU profiling.
4693 func setcpuprofilerate(hz int32) {
4694         // Force sane arguments.
4695         if hz < 0 {
4696                 hz = 0
4697         }
4698
4699         // Disable preemption, otherwise we can be rescheduled to another thread
4700         // that has profiling enabled.
4701         gp := getg()
4702         gp.m.locks++
4703
4704         // Stop profiler on this thread so that it is safe to lock prof.
4705         // if a profiling signal came in while we had prof locked,
4706         // it would deadlock.
4707         setThreadCPUProfiler(0)
4708
4709         for !prof.signalLock.CompareAndSwap(0, 1) {
4710                 osyield()
4711         }
4712         if prof.hz.Load() != hz {
4713                 setProcessCPUProfiler(hz)
4714                 prof.hz.Store(hz)
4715         }
4716         prof.signalLock.Store(0)
4717
4718         lock(&sched.lock)
4719         sched.profilehz = hz
4720         unlock(&sched.lock)
4721
4722         if hz != 0 {
4723                 setThreadCPUProfiler(hz)
4724         }
4725
4726         gp.m.locks--
4727 }
4728
4729 // init initializes pp, which may be a freshly allocated p or a
4730 // previously destroyed p, and transitions it to status _Pgcstop.
4731 func (pp *p) init(id int32) {
4732         pp.id = id
4733         pp.status = _Pgcstop
4734         pp.sudogcache = pp.sudogbuf[:0]
4735         pp.deferpool = pp.deferpoolbuf[:0]
4736         pp.wbBuf.reset()
4737         if pp.mcache == nil {
4738                 if id == 0 {
4739                         if mcache0 == nil {
4740                                 throw("missing mcache?")
4741                         }
4742                         // Use the bootstrap mcache0. Only one P will get
4743                         // mcache0: the one with ID 0.
4744                         pp.mcache = mcache0
4745                 } else {
4746                         pp.mcache = allocmcache()
4747                 }
4748         }
4749         if raceenabled && pp.raceprocctx == 0 {
4750                 if id == 0 {
4751                         pp.raceprocctx = raceprocctx0
4752                         raceprocctx0 = 0 // bootstrap
4753                 } else {
4754                         pp.raceprocctx = raceproccreate()
4755                 }
4756         }
4757         lockInit(&pp.timersLock, lockRankTimers)
4758
4759         // This P may get timers when it starts running. Set the mask here
4760         // since the P may not go through pidleget (notably P 0 on startup).
4761         timerpMask.set(id)
4762         // Similarly, we may not go through pidleget before this P starts
4763         // running if it is P 0 on startup.
4764         idlepMask.clear(id)
4765 }
4766
4767 // destroy releases all of the resources associated with pp and
4768 // transitions it to status _Pdead.
4769 //
4770 // sched.lock must be held and the world must be stopped.
4771 func (pp *p) destroy() {
4772         assertLockHeld(&sched.lock)
4773         assertWorldStopped()
4774
4775         // Move all runnable goroutines to the global queue
4776         for pp.runqhead != pp.runqtail {
4777                 // Pop from tail of local queue
4778                 pp.runqtail--
4779                 gp := pp.runq[pp.runqtail%uint32(len(pp.runq))].ptr()
4780                 // Push onto head of global queue
4781                 globrunqputhead(gp)
4782         }
4783         if pp.runnext != 0 {
4784                 globrunqputhead(pp.runnext.ptr())
4785                 pp.runnext = 0
4786         }
4787         if len(pp.timers) > 0 {
4788                 plocal := getg().m.p.ptr()
4789                 // The world is stopped, but we acquire timersLock to
4790                 // protect against sysmon calling timeSleepUntil.
4791                 // This is the only case where we hold the timersLock of
4792                 // more than one P, so there are no deadlock concerns.
4793                 lock(&plocal.timersLock)
4794                 lock(&pp.timersLock)
4795                 moveTimers(plocal, pp.timers)
4796                 pp.timers = nil
4797                 pp.numTimers = 0
4798                 pp.deletedTimers = 0
4799                 atomic.Store64(&pp.timer0When, 0)
4800                 unlock(&pp.timersLock)
4801                 unlock(&plocal.timersLock)
4802         }
4803         // Flush p's write barrier buffer.
4804         if gcphase != _GCoff {
4805                 wbBufFlush1(pp)
4806                 pp.gcw.dispose()
4807         }
4808         for i := range pp.sudogbuf {
4809                 pp.sudogbuf[i] = nil
4810         }
4811         pp.sudogcache = pp.sudogbuf[:0]
4812         for j := range pp.deferpoolbuf {
4813                 pp.deferpoolbuf[j] = nil
4814         }
4815         pp.deferpool = pp.deferpoolbuf[:0]
4816         systemstack(func() {
4817                 for i := 0; i < pp.mspancache.len; i++ {
4818                         // Safe to call since the world is stopped.
4819                         mheap_.spanalloc.free(unsafe.Pointer(pp.mspancache.buf[i]))
4820                 }
4821                 pp.mspancache.len = 0
4822                 lock(&mheap_.lock)
4823                 pp.pcache.flush(&mheap_.pages)
4824                 unlock(&mheap_.lock)
4825         })
4826         freemcache(pp.mcache)
4827         pp.mcache = nil
4828         gfpurge(pp)
4829         traceProcFree(pp)
4830         if raceenabled {
4831                 if pp.timerRaceCtx != 0 {
4832                         // The race detector code uses a callback to fetch
4833                         // the proc context, so arrange for that callback
4834                         // to see the right thing.
4835                         // This hack only works because we are the only
4836                         // thread running.
4837                         mp := getg().m
4838                         phold := mp.p.ptr()
4839                         mp.p.set(pp)
4840
4841                         racectxend(pp.timerRaceCtx)
4842                         pp.timerRaceCtx = 0
4843
4844                         mp.p.set(phold)
4845                 }
4846                 raceprocdestroy(pp.raceprocctx)
4847                 pp.raceprocctx = 0
4848         }
4849         pp.gcAssistTime = 0
4850         pp.status = _Pdead
4851 }
4852
4853 // Change number of processors.
4854 //
4855 // sched.lock must be held, and the world must be stopped.
4856 //
4857 // gcworkbufs must not be being modified by either the GC or the write barrier
4858 // code, so the GC must not be running if the number of Ps actually changes.
4859 //
4860 // Returns list of Ps with local work, they need to be scheduled by the caller.
4861 func procresize(nprocs int32) *p {
4862         assertLockHeld(&sched.lock)
4863         assertWorldStopped()
4864
4865         old := gomaxprocs
4866         if old < 0 || nprocs <= 0 {
4867                 throw("procresize: invalid arg")
4868         }
4869         if trace.enabled {
4870                 traceGomaxprocs(nprocs)
4871         }
4872
4873         // update statistics
4874         now := nanotime()
4875         if sched.procresizetime != 0 {
4876                 sched.totaltime += int64(old) * (now - sched.procresizetime)
4877         }
4878         sched.procresizetime = now
4879
4880         maskWords := (nprocs + 31) / 32
4881
4882         // Grow allp if necessary.
4883         if nprocs > int32(len(allp)) {
4884                 // Synchronize with retake, which could be running
4885                 // concurrently since it doesn't run on a P.
4886                 lock(&allpLock)
4887                 if nprocs <= int32(cap(allp)) {
4888                         allp = allp[:nprocs]
4889                 } else {
4890                         nallp := make([]*p, nprocs)
4891                         // Copy everything up to allp's cap so we
4892                         // never lose old allocated Ps.
4893                         copy(nallp, allp[:cap(allp)])
4894                         allp = nallp
4895                 }
4896
4897                 if maskWords <= int32(cap(idlepMask)) {
4898                         idlepMask = idlepMask[:maskWords]
4899                         timerpMask = timerpMask[:maskWords]
4900                 } else {
4901                         nidlepMask := make([]uint32, maskWords)
4902                         // No need to copy beyond len, old Ps are irrelevant.
4903                         copy(nidlepMask, idlepMask)
4904                         idlepMask = nidlepMask
4905
4906                         ntimerpMask := make([]uint32, maskWords)
4907                         copy(ntimerpMask, timerpMask)
4908                         timerpMask = ntimerpMask
4909                 }
4910                 unlock(&allpLock)
4911         }
4912
4913         // initialize new P's
4914         for i := old; i < nprocs; i++ {
4915                 pp := allp[i]
4916                 if pp == nil {
4917                         pp = new(p)
4918                 }
4919                 pp.init(i)
4920                 atomicstorep(unsafe.Pointer(&allp[i]), unsafe.Pointer(pp))
4921         }
4922
4923         gp := getg()
4924         if gp.m.p != 0 && gp.m.p.ptr().id < nprocs {
4925                 // continue to use the current P
4926                 gp.m.p.ptr().status = _Prunning
4927                 gp.m.p.ptr().mcache.prepareForSweep()
4928         } else {
4929                 // release the current P and acquire allp[0].
4930                 //
4931                 // We must do this before destroying our current P
4932                 // because p.destroy itself has write barriers, so we
4933                 // need to do that from a valid P.
4934                 if gp.m.p != 0 {
4935                         if trace.enabled {
4936                                 // Pretend that we were descheduled
4937                                 // and then scheduled again to keep
4938                                 // the trace sane.
4939                                 traceGoSched()
4940                                 traceProcStop(gp.m.p.ptr())
4941                         }
4942                         gp.m.p.ptr().m = 0
4943                 }
4944                 gp.m.p = 0
4945                 pp := allp[0]
4946                 pp.m = 0
4947                 pp.status = _Pidle
4948                 acquirep(pp)
4949                 if trace.enabled {
4950                         traceGoStart()
4951                 }
4952         }
4953
4954         // g.m.p is now set, so we no longer need mcache0 for bootstrapping.
4955         mcache0 = nil
4956
4957         // release resources from unused P's
4958         for i := nprocs; i < old; i++ {
4959                 pp := allp[i]
4960                 pp.destroy()
4961                 // can't free P itself because it can be referenced by an M in syscall
4962         }
4963
4964         // Trim allp.
4965         if int32(len(allp)) != nprocs {
4966                 lock(&allpLock)
4967                 allp = allp[:nprocs]
4968                 idlepMask = idlepMask[:maskWords]
4969                 timerpMask = timerpMask[:maskWords]
4970                 unlock(&allpLock)
4971         }
4972
4973         var runnablePs *p
4974         for i := nprocs - 1; i >= 0; i-- {
4975                 pp := allp[i]
4976                 if gp.m.p.ptr() == pp {
4977                         continue
4978                 }
4979                 pp.status = _Pidle
4980                 if runqempty(pp) {
4981                         pidleput(pp, now)
4982                 } else {
4983                         pp.m.set(mget())
4984                         pp.link.set(runnablePs)
4985                         runnablePs = pp
4986                 }
4987         }
4988         stealOrder.reset(uint32(nprocs))
4989         var int32p *int32 = &gomaxprocs // make compiler check that gomaxprocs is an int32
4990         atomic.Store((*uint32)(unsafe.Pointer(int32p)), uint32(nprocs))
4991         if old != nprocs {
4992                 // Notify the limiter that the amount of procs has changed.
4993                 gcCPULimiter.resetCapacity(now, nprocs)
4994         }
4995         return runnablePs
4996 }
4997
4998 // Associate p and the current m.
4999 //
5000 // This function is allowed to have write barriers even if the caller
5001 // isn't because it immediately acquires pp.
5002 //
5003 //go:yeswritebarrierrec
5004 func acquirep(pp *p) {
5005         // Do the part that isn't allowed to have write barriers.
5006         wirep(pp)
5007
5008         // Have p; write barriers now allowed.
5009
5010         // Perform deferred mcache flush before this P can allocate
5011         // from a potentially stale mcache.
5012         pp.mcache.prepareForSweep()
5013
5014         if trace.enabled {
5015                 traceProcStart()
5016         }
5017 }
5018
5019 // wirep is the first step of acquirep, which actually associates the
5020 // current M to pp. This is broken out so we can disallow write
5021 // barriers for this part, since we don't yet have a P.
5022 //
5023 //go:nowritebarrierrec
5024 //go:nosplit
5025 func wirep(pp *p) {
5026         gp := getg()
5027
5028         if gp.m.p != 0 {
5029                 throw("wirep: already in go")
5030         }
5031         if pp.m != 0 || pp.status != _Pidle {
5032                 id := int64(0)
5033                 if pp.m != 0 {
5034                         id = pp.m.ptr().id
5035                 }
5036                 print("wirep: p->m=", pp.m, "(", id, ") p->status=", pp.status, "\n")
5037                 throw("wirep: invalid p state")
5038         }
5039         gp.m.p.set(pp)
5040         pp.m.set(gp.m)
5041         pp.status = _Prunning
5042 }
5043
5044 // Disassociate p and the current m.
5045 func releasep() *p {
5046         gp := getg()
5047
5048         if gp.m.p == 0 {
5049                 throw("releasep: invalid arg")
5050         }
5051         pp := gp.m.p.ptr()
5052         if pp.m.ptr() != gp.m || pp.status != _Prunning {
5053                 print("releasep: m=", gp.m, " m->p=", gp.m.p.ptr(), " p->m=", hex(pp.m), " p->status=", pp.status, "\n")
5054                 throw("releasep: invalid p state")
5055         }
5056         if trace.enabled {
5057                 traceProcStop(gp.m.p.ptr())
5058         }
5059         gp.m.p = 0
5060         pp.m = 0
5061         pp.status = _Pidle
5062         return pp
5063 }
5064
5065 func incidlelocked(v int32) {
5066         lock(&sched.lock)
5067         sched.nmidlelocked += v
5068         if v > 0 {
5069                 checkdead()
5070         }
5071         unlock(&sched.lock)
5072 }
5073
5074 // Check for deadlock situation.
5075 // The check is based on number of running M's, if 0 -> deadlock.
5076 // sched.lock must be held.
5077 func checkdead() {
5078         assertLockHeld(&sched.lock)
5079
5080         // For -buildmode=c-shared or -buildmode=c-archive it's OK if
5081         // there are no running goroutines. The calling program is
5082         // assumed to be running.
5083         if islibrary || isarchive {
5084                 return
5085         }
5086
5087         // If we are dying because of a signal caught on an already idle thread,
5088         // freezetheworld will cause all running threads to block.
5089         // And runtime will essentially enter into deadlock state,
5090         // except that there is a thread that will call exit soon.
5091         if panicking.Load() > 0 {
5092                 return
5093         }
5094
5095         // If we are not running under cgo, but we have an extra M then account
5096         // for it. (It is possible to have an extra M on Windows without cgo to
5097         // accommodate callbacks created by syscall.NewCallback. See issue #6751
5098         // for details.)
5099         var run0 int32
5100         if !iscgo && cgoHasExtraM {
5101                 mp := lockextra(true)
5102                 haveExtraM := extraMCount > 0
5103                 unlockextra(mp)
5104                 if haveExtraM {
5105                         run0 = 1
5106                 }
5107         }
5108
5109         run := mcount() - sched.nmidle - sched.nmidlelocked - sched.nmsys
5110         if run > run0 {
5111                 return
5112         }
5113         if run < 0 {
5114                 print("runtime: checkdead: nmidle=", sched.nmidle, " nmidlelocked=", sched.nmidlelocked, " mcount=", mcount(), " nmsys=", sched.nmsys, "\n")
5115                 throw("checkdead: inconsistent counts")
5116         }
5117
5118         grunning := 0
5119         forEachG(func(gp *g) {
5120                 if isSystemGoroutine(gp, false) {
5121                         return
5122                 }
5123                 s := readgstatus(gp)
5124                 switch s &^ _Gscan {
5125                 case _Gwaiting,
5126                         _Gpreempted:
5127                         grunning++
5128                 case _Grunnable,
5129                         _Grunning,
5130                         _Gsyscall:
5131                         print("runtime: checkdead: find g ", gp.goid, " in status ", s, "\n")
5132                         throw("checkdead: runnable g")
5133                 }
5134         })
5135         if grunning == 0 { // possible if main goroutine calls runtime·Goexit()
5136                 unlock(&sched.lock) // unlock so that GODEBUG=scheddetail=1 doesn't hang
5137                 fatal("no goroutines (main called runtime.Goexit) - deadlock!")
5138         }
5139
5140         // Maybe jump time forward for playground.
5141         if faketime != 0 {
5142                 if when := timeSleepUntil(); when < maxWhen {
5143                         faketime = when
5144
5145                         // Start an M to steal the timer.
5146                         pp, _ := pidleget(faketime)
5147                         if pp == nil {
5148                                 // There should always be a free P since
5149                                 // nothing is running.
5150                                 throw("checkdead: no p for timer")
5151                         }
5152                         mp := mget()
5153                         if mp == nil {
5154                                 // There should always be a free M since
5155                                 // nothing is running.
5156                                 throw("checkdead: no m for timer")
5157                         }
5158                         // M must be spinning to steal. We set this to be
5159                         // explicit, but since this is the only M it would
5160                         // become spinning on its own anyways.
5161                         sched.nmspinning.Add(1)
5162                         mp.spinning = true
5163                         mp.nextp.set(pp)
5164                         notewakeup(&mp.park)
5165                         return
5166                 }
5167         }
5168
5169         // There are no goroutines running, so we can look at the P's.
5170         for _, pp := range allp {
5171                 if len(pp.timers) > 0 {
5172                         return
5173                 }
5174         }
5175
5176         unlock(&sched.lock) // unlock so that GODEBUG=scheddetail=1 doesn't hang
5177         fatal("all goroutines are asleep - deadlock!")
5178 }
5179
5180 // forcegcperiod is the maximum time in nanoseconds between garbage
5181 // collections. If we go this long without a garbage collection, one
5182 // is forced to run.
5183 //
5184 // This is a variable for testing purposes. It normally doesn't change.
5185 var forcegcperiod int64 = 2 * 60 * 1e9
5186
5187 // needSysmonWorkaround is true if the workaround for
5188 // golang.org/issue/42515 is needed on NetBSD.
5189 var needSysmonWorkaround bool = false
5190
5191 // Always runs without a P, so write barriers are not allowed.
5192 //
5193 //go:nowritebarrierrec
5194 func sysmon() {
5195         lock(&sched.lock)
5196         sched.nmsys++
5197         checkdead()
5198         unlock(&sched.lock)
5199
5200         lasttrace := int64(0)
5201         idle := 0 // how many cycles in succession we had not wokeup somebody
5202         delay := uint32(0)
5203
5204         for {
5205                 if idle == 0 { // start with 20us sleep...
5206                         delay = 20
5207                 } else if idle > 50 { // start doubling the sleep after 1ms...
5208                         delay *= 2
5209                 }
5210                 if delay > 10*1000 { // up to 10ms
5211                         delay = 10 * 1000
5212                 }
5213                 usleep(delay)
5214
5215                 // sysmon should not enter deep sleep if schedtrace is enabled so that
5216                 // it can print that information at the right time.
5217                 //
5218                 // It should also not enter deep sleep if there are any active P's so
5219                 // that it can retake P's from syscalls, preempt long running G's, and
5220                 // poll the network if all P's are busy for long stretches.
5221                 //
5222                 // It should wakeup from deep sleep if any P's become active either due
5223                 // to exiting a syscall or waking up due to a timer expiring so that it
5224                 // can resume performing those duties. If it wakes from a syscall it
5225                 // resets idle and delay as a bet that since it had retaken a P from a
5226                 // syscall before, it may need to do it again shortly after the
5227                 // application starts work again. It does not reset idle when waking
5228                 // from a timer to avoid adding system load to applications that spend
5229                 // most of their time sleeping.
5230                 now := nanotime()
5231                 if debug.schedtrace <= 0 && (sched.gcwaiting.Load() || sched.npidle.Load() == gomaxprocs) {
5232                         lock(&sched.lock)
5233                         if sched.gcwaiting.Load() || sched.npidle.Load() == gomaxprocs {
5234                                 syscallWake := false
5235                                 next := timeSleepUntil()
5236                                 if next > now {
5237                                         sched.sysmonwait.Store(true)
5238                                         unlock(&sched.lock)
5239                                         // Make wake-up period small enough
5240                                         // for the sampling to be correct.
5241                                         sleep := forcegcperiod / 2
5242                                         if next-now < sleep {
5243                                                 sleep = next - now
5244                                         }
5245                                         shouldRelax := sleep >= osRelaxMinNS
5246                                         if shouldRelax {
5247                                                 osRelax(true)
5248                                         }
5249                                         syscallWake = notetsleep(&sched.sysmonnote, sleep)
5250                                         if shouldRelax {
5251                                                 osRelax(false)
5252                                         }
5253                                         lock(&sched.lock)
5254                                         sched.sysmonwait.Store(false)
5255                                         noteclear(&sched.sysmonnote)
5256                                 }
5257                                 if syscallWake {
5258                                         idle = 0
5259                                         delay = 20
5260                                 }
5261                         }
5262                         unlock(&sched.lock)
5263                 }
5264
5265                 lock(&sched.sysmonlock)
5266                 // Update now in case we blocked on sysmonnote or spent a long time
5267                 // blocked on schedlock or sysmonlock above.
5268                 now = nanotime()
5269
5270                 // trigger libc interceptors if needed
5271                 if *cgo_yield != nil {
5272                         asmcgocall(*cgo_yield, nil)
5273                 }
5274                 // poll network if not polled for more than 10ms
5275                 lastpoll := sched.lastpoll.Load()
5276                 if netpollinited() && lastpoll != 0 && lastpoll+10*1000*1000 < now {
5277                         sched.lastpoll.CompareAndSwap(lastpoll, now)
5278                         list := netpoll(0) // non-blocking - returns list of goroutines
5279                         if !list.empty() {
5280                                 // Need to decrement number of idle locked M's
5281                                 // (pretending that one more is running) before injectglist.
5282                                 // Otherwise it can lead to the following situation:
5283                                 // injectglist grabs all P's but before it starts M's to run the P's,
5284                                 // another M returns from syscall, finishes running its G,
5285                                 // observes that there is no work to do and no other running M's
5286                                 // and reports deadlock.
5287                                 incidlelocked(-1)
5288                                 injectglist(&list)
5289                                 incidlelocked(1)
5290                         }
5291                 }
5292                 if GOOS == "netbsd" && needSysmonWorkaround {
5293                         // netpoll is responsible for waiting for timer
5294                         // expiration, so we typically don't have to worry
5295                         // about starting an M to service timers. (Note that
5296                         // sleep for timeSleepUntil above simply ensures sysmon
5297                         // starts running again when that timer expiration may
5298                         // cause Go code to run again).
5299                         //
5300                         // However, netbsd has a kernel bug that sometimes
5301                         // misses netpollBreak wake-ups, which can lead to
5302                         // unbounded delays servicing timers. If we detect this
5303                         // overrun, then startm to get something to handle the
5304                         // timer.
5305                         //
5306                         // See issue 42515 and
5307                         // https://gnats.netbsd.org/cgi-bin/query-pr-single.pl?number=50094.
5308                         if next := timeSleepUntil(); next < now {
5309                                 startm(nil, false)
5310                         }
5311                 }
5312                 if scavenger.sysmonWake.Load() != 0 {
5313                         // Kick the scavenger awake if someone requested it.
5314                         scavenger.wake()
5315                 }
5316                 // retake P's blocked in syscalls
5317                 // and preempt long running G's
5318                 if retake(now) != 0 {
5319                         idle = 0
5320                 } else {
5321                         idle++
5322                 }
5323                 // check if we need to force a GC
5324                 if t := (gcTrigger{kind: gcTriggerTime, now: now}); t.test() && atomic.Load(&forcegc.idle) != 0 {
5325                         lock(&forcegc.lock)
5326                         forcegc.idle = 0
5327                         var list gList
5328                         list.push(forcegc.g)
5329                         injectglist(&list)
5330                         unlock(&forcegc.lock)
5331                 }
5332                 if debug.schedtrace > 0 && lasttrace+int64(debug.schedtrace)*1000000 <= now {
5333                         lasttrace = now
5334                         schedtrace(debug.scheddetail > 0)
5335                 }
5336                 unlock(&sched.sysmonlock)
5337         }
5338 }
5339
5340 type sysmontick struct {
5341         schedtick   uint32
5342         schedwhen   int64
5343         syscalltick uint32
5344         syscallwhen int64
5345 }
5346
5347 // forcePreemptNS is the time slice given to a G before it is
5348 // preempted.
5349 const forcePreemptNS = 10 * 1000 * 1000 // 10ms
5350
5351 func retake(now int64) uint32 {
5352         n := 0
5353         // Prevent allp slice changes. This lock will be completely
5354         // uncontended unless we're already stopping the world.
5355         lock(&allpLock)
5356         // We can't use a range loop over allp because we may
5357         // temporarily drop the allpLock. Hence, we need to re-fetch
5358         // allp each time around the loop.
5359         for i := 0; i < len(allp); i++ {
5360                 pp := allp[i]
5361                 if pp == nil {
5362                         // This can happen if procresize has grown
5363                         // allp but not yet created new Ps.
5364                         continue
5365                 }
5366                 pd := &pp.sysmontick
5367                 s := pp.status
5368                 sysretake := false
5369                 if s == _Prunning || s == _Psyscall {
5370                         // Preempt G if it's running for too long.
5371                         t := int64(pp.schedtick)
5372                         if int64(pd.schedtick) != t {
5373                                 pd.schedtick = uint32(t)
5374                                 pd.schedwhen = now
5375                         } else if pd.schedwhen+forcePreemptNS <= now {
5376                                 preemptone(pp)
5377                                 // In case of syscall, preemptone() doesn't
5378                                 // work, because there is no M wired to P.
5379                                 sysretake = true
5380                         }
5381                 }
5382                 if s == _Psyscall {
5383                         // Retake P from syscall if it's there for more than 1 sysmon tick (at least 20us).
5384                         t := int64(pp.syscalltick)
5385                         if !sysretake && int64(pd.syscalltick) != t {
5386                                 pd.syscalltick = uint32(t)
5387                                 pd.syscallwhen = now
5388                                 continue
5389                         }
5390                         // On the one hand we don't want to retake Ps if there is no other work to do,
5391                         // but on the other hand we want to retake them eventually
5392                         // because they can prevent the sysmon thread from deep sleep.
5393                         if runqempty(pp) && sched.nmspinning.Load()+sched.npidle.Load() > 0 && pd.syscallwhen+10*1000*1000 > now {
5394                                 continue
5395                         }
5396                         // Drop allpLock so we can take sched.lock.
5397                         unlock(&allpLock)
5398                         // Need to decrement number of idle locked M's
5399                         // (pretending that one more is running) before the CAS.
5400                         // Otherwise the M from which we retake can exit the syscall,
5401                         // increment nmidle and report deadlock.
5402                         incidlelocked(-1)
5403                         if atomic.Cas(&pp.status, s, _Pidle) {
5404                                 if trace.enabled {
5405                                         traceGoSysBlock(pp)
5406                                         traceProcStop(pp)
5407                                 }
5408                                 n++
5409                                 pp.syscalltick++
5410                                 handoffp(pp)
5411                         }
5412                         incidlelocked(1)
5413                         lock(&allpLock)
5414                 }
5415         }
5416         unlock(&allpLock)
5417         return uint32(n)
5418 }
5419
5420 // Tell all goroutines that they have been preempted and they should stop.
5421 // This function is purely best-effort. It can fail to inform a goroutine if a
5422 // processor just started running it.
5423 // No locks need to be held.
5424 // Returns true if preemption request was issued to at least one goroutine.
5425 func preemptall() bool {
5426         res := false
5427         for _, pp := range allp {
5428                 if pp.status != _Prunning {
5429                         continue
5430                 }
5431                 if preemptone(pp) {
5432                         res = true
5433                 }
5434         }
5435         return res
5436 }
5437
5438 // Tell the goroutine running on processor P to stop.
5439 // This function is purely best-effort. It can incorrectly fail to inform the
5440 // goroutine. It can inform the wrong goroutine. Even if it informs the
5441 // correct goroutine, that goroutine might ignore the request if it is
5442 // simultaneously executing newstack.
5443 // No lock needs to be held.
5444 // Returns true if preemption request was issued.
5445 // The actual preemption will happen at some point in the future
5446 // and will be indicated by the gp->status no longer being
5447 // Grunning
5448 func preemptone(pp *p) bool {
5449         mp := pp.m.ptr()
5450         if mp == nil || mp == getg().m {
5451                 return false
5452         }
5453         gp := mp.curg
5454         if gp == nil || gp == mp.g0 {
5455                 return false
5456         }
5457
5458         gp.preempt = true
5459
5460         // Every call in a goroutine checks for stack overflow by
5461         // comparing the current stack pointer to gp->stackguard0.
5462         // Setting gp->stackguard0 to StackPreempt folds
5463         // preemption into the normal stack overflow check.
5464         gp.stackguard0 = stackPreempt
5465
5466         // Request an async preemption of this P.
5467         if preemptMSupported && debug.asyncpreemptoff == 0 {
5468                 pp.preempt = true
5469                 preemptM(mp)
5470         }
5471
5472         return true
5473 }
5474
5475 var starttime int64
5476
5477 func schedtrace(detailed bool) {
5478         now := nanotime()
5479         if starttime == 0 {
5480                 starttime = now
5481         }
5482
5483         lock(&sched.lock)
5484         print("SCHED ", (now-starttime)/1e6, "ms: gomaxprocs=", gomaxprocs, " idleprocs=", sched.npidle.Load(), " threads=", mcount(), " spinningthreads=", sched.nmspinning.Load(), " needspinning=", sched.needspinning.Load(), " idlethreads=", sched.nmidle, " runqueue=", sched.runqsize)
5485         if detailed {
5486                 print(" gcwaiting=", sched.gcwaiting.Load(), " nmidlelocked=", sched.nmidlelocked, " stopwait=", sched.stopwait, " sysmonwait=", sched.sysmonwait.Load(), "\n")
5487         }
5488         // We must be careful while reading data from P's, M's and G's.
5489         // Even if we hold schedlock, most data can be changed concurrently.
5490         // E.g. (p->m ? p->m->id : -1) can crash if p->m changes from non-nil to nil.
5491         for i, pp := range allp {
5492                 mp := pp.m.ptr()
5493                 h := atomic.Load(&pp.runqhead)
5494                 t := atomic.Load(&pp.runqtail)
5495                 if detailed {
5496                         print("  P", i, ": status=", pp.status, " schedtick=", pp.schedtick, " syscalltick=", pp.syscalltick, " m=")
5497                         if mp != nil {
5498                                 print(mp.id)
5499                         } else {
5500                                 print("nil")
5501                         }
5502                         print(" runqsize=", t-h, " gfreecnt=", pp.gFree.n, " timerslen=", len(pp.timers), "\n")
5503                 } else {
5504                         // In non-detailed mode format lengths of per-P run queues as:
5505                         // [len1 len2 len3 len4]
5506                         print(" ")
5507                         if i == 0 {
5508                                 print("[")
5509                         }
5510                         print(t - h)
5511                         if i == len(allp)-1 {
5512                                 print("]\n")
5513                         }
5514                 }
5515         }
5516
5517         if !detailed {
5518                 unlock(&sched.lock)
5519                 return
5520         }
5521
5522         for mp := allm; mp != nil; mp = mp.alllink {
5523                 pp := mp.p.ptr()
5524                 print("  M", mp.id, ": p=")
5525                 if pp != nil {
5526                         print(pp.id)
5527                 } else {
5528                         print("nil")
5529                 }
5530                 print(" curg=")
5531                 if mp.curg != nil {
5532                         print(mp.curg.goid)
5533                 } else {
5534                         print("nil")
5535                 }
5536                 print(" mallocing=", mp.mallocing, " throwing=", mp.throwing, " preemptoff=", mp.preemptoff, " locks=", mp.locks, " dying=", mp.dying, " spinning=", mp.spinning, " blocked=", mp.blocked, " lockedg=")
5537                 if lockedg := mp.lockedg.ptr(); lockedg != nil {
5538                         print(lockedg.goid)
5539                 } else {
5540                         print("nil")
5541                 }
5542                 print("\n")
5543         }
5544
5545         forEachG(func(gp *g) {
5546                 print("  G", gp.goid, ": status=", readgstatus(gp), "(", gp.waitreason.String(), ") m=")
5547                 if gp.m != nil {
5548                         print(gp.m.id)
5549                 } else {
5550                         print("nil")
5551                 }
5552                 print(" lockedm=")
5553                 if lockedm := gp.lockedm.ptr(); lockedm != nil {
5554                         print(lockedm.id)
5555                 } else {
5556                         print("nil")
5557                 }
5558                 print("\n")
5559         })
5560         unlock(&sched.lock)
5561 }
5562
5563 // schedEnableUser enables or disables the scheduling of user
5564 // goroutines.
5565 //
5566 // This does not stop already running user goroutines, so the caller
5567 // should first stop the world when disabling user goroutines.
5568 func schedEnableUser(enable bool) {
5569         lock(&sched.lock)
5570         if sched.disable.user == !enable {
5571                 unlock(&sched.lock)
5572                 return
5573         }
5574         sched.disable.user = !enable
5575         if enable {
5576                 n := sched.disable.n
5577                 sched.disable.n = 0
5578                 globrunqputbatch(&sched.disable.runnable, n)
5579                 unlock(&sched.lock)
5580                 for ; n != 0 && sched.npidle.Load() != 0; n-- {
5581                         startm(nil, false)
5582                 }
5583         } else {
5584                 unlock(&sched.lock)
5585         }
5586 }
5587
5588 // schedEnabled reports whether gp should be scheduled. It returns
5589 // false is scheduling of gp is disabled.
5590 //
5591 // sched.lock must be held.
5592 func schedEnabled(gp *g) bool {
5593         assertLockHeld(&sched.lock)
5594
5595         if sched.disable.user {
5596                 return isSystemGoroutine(gp, true)
5597         }
5598         return true
5599 }
5600
5601 // Put mp on midle list.
5602 // sched.lock must be held.
5603 // May run during STW, so write barriers are not allowed.
5604 //
5605 //go:nowritebarrierrec
5606 func mput(mp *m) {
5607         assertLockHeld(&sched.lock)
5608
5609         mp.schedlink = sched.midle
5610         sched.midle.set(mp)
5611         sched.nmidle++
5612         checkdead()
5613 }
5614
5615 // Try to get an m from midle list.
5616 // sched.lock must be held.
5617 // May run during STW, so write barriers are not allowed.
5618 //
5619 //go:nowritebarrierrec
5620 func mget() *m {
5621         assertLockHeld(&sched.lock)
5622
5623         mp := sched.midle.ptr()
5624         if mp != nil {
5625                 sched.midle = mp.schedlink
5626                 sched.nmidle--
5627         }
5628         return mp
5629 }
5630
5631 // Put gp on the global runnable queue.
5632 // sched.lock must be held.
5633 // May run during STW, so write barriers are not allowed.
5634 //
5635 //go:nowritebarrierrec
5636 func globrunqput(gp *g) {
5637         assertLockHeld(&sched.lock)
5638
5639         sched.runq.pushBack(gp)
5640         sched.runqsize++
5641 }
5642
5643 // Put gp at the head of the global runnable queue.
5644 // sched.lock must be held.
5645 // May run during STW, so write barriers are not allowed.
5646 //
5647 //go:nowritebarrierrec
5648 func globrunqputhead(gp *g) {
5649         assertLockHeld(&sched.lock)
5650
5651         sched.runq.push(gp)
5652         sched.runqsize++
5653 }
5654
5655 // Put a batch of runnable goroutines on the global runnable queue.
5656 // This clears *batch.
5657 // sched.lock must be held.
5658 // May run during STW, so write barriers are not allowed.
5659 //
5660 //go:nowritebarrierrec
5661 func globrunqputbatch(batch *gQueue, n int32) {
5662         assertLockHeld(&sched.lock)
5663
5664         sched.runq.pushBackAll(*batch)
5665         sched.runqsize += n
5666         *batch = gQueue{}
5667 }
5668
5669 // Try get a batch of G's from the global runnable queue.
5670 // sched.lock must be held.
5671 func globrunqget(pp *p, max int32) *g {
5672         assertLockHeld(&sched.lock)
5673
5674         if sched.runqsize == 0 {
5675                 return nil
5676         }
5677
5678         n := sched.runqsize/gomaxprocs + 1
5679         if n > sched.runqsize {
5680                 n = sched.runqsize
5681         }
5682         if max > 0 && n > max {
5683                 n = max
5684         }
5685         if n > int32(len(pp.runq))/2 {
5686                 n = int32(len(pp.runq)) / 2
5687         }
5688
5689         sched.runqsize -= n
5690
5691         gp := sched.runq.pop()
5692         n--
5693         for ; n > 0; n-- {
5694                 gp1 := sched.runq.pop()
5695                 runqput(pp, gp1, false)
5696         }
5697         return gp
5698 }
5699
5700 // pMask is an atomic bitstring with one bit per P.
5701 type pMask []uint32
5702
5703 // read returns true if P id's bit is set.
5704 func (p pMask) read(id uint32) bool {
5705         word := id / 32
5706         mask := uint32(1) << (id % 32)
5707         return (atomic.Load(&p[word]) & mask) != 0
5708 }
5709
5710 // set sets P id's bit.
5711 func (p pMask) set(id int32) {
5712         word := id / 32
5713         mask := uint32(1) << (id % 32)
5714         atomic.Or(&p[word], mask)
5715 }
5716
5717 // clear clears P id's bit.
5718 func (p pMask) clear(id int32) {
5719         word := id / 32
5720         mask := uint32(1) << (id % 32)
5721         atomic.And(&p[word], ^mask)
5722 }
5723
5724 // updateTimerPMask clears pp's timer mask if it has no timers on its heap.
5725 //
5726 // Ideally, the timer mask would be kept immediately consistent on any timer
5727 // operations. Unfortunately, updating a shared global data structure in the
5728 // timer hot path adds too much overhead in applications frequently switching
5729 // between no timers and some timers.
5730 //
5731 // As a compromise, the timer mask is updated only on pidleget / pidleput. A
5732 // running P (returned by pidleget) may add a timer at any time, so its mask
5733 // must be set. An idle P (passed to pidleput) cannot add new timers while
5734 // idle, so if it has no timers at that time, its mask may be cleared.
5735 //
5736 // Thus, we get the following effects on timer-stealing in findrunnable:
5737 //
5738 //   - Idle Ps with no timers when they go idle are never checked in findrunnable
5739 //     (for work- or timer-stealing; this is the ideal case).
5740 //   - Running Ps must always be checked.
5741 //   - Idle Ps whose timers are stolen must continue to be checked until they run
5742 //     again, even after timer expiration.
5743 //
5744 // When the P starts running again, the mask should be set, as a timer may be
5745 // added at any time.
5746 //
5747 // TODO(prattmic): Additional targeted updates may improve the above cases.
5748 // e.g., updating the mask when stealing a timer.
5749 func updateTimerPMask(pp *p) {
5750         if atomic.Load(&pp.numTimers) > 0 {
5751                 return
5752         }
5753
5754         // Looks like there are no timers, however another P may transiently
5755         // decrement numTimers when handling a timerModified timer in
5756         // checkTimers. We must take timersLock to serialize with these changes.
5757         lock(&pp.timersLock)
5758         if atomic.Load(&pp.numTimers) == 0 {
5759                 timerpMask.clear(pp.id)
5760         }
5761         unlock(&pp.timersLock)
5762 }
5763
5764 // pidleput puts p on the _Pidle list. now must be a relatively recent call
5765 // to nanotime or zero. Returns now or the current time if now was zero.
5766 //
5767 // This releases ownership of p. Once sched.lock is released it is no longer
5768 // safe to use p.
5769 //
5770 // sched.lock must be held.
5771 //
5772 // May run during STW, so write barriers are not allowed.
5773 //
5774 //go:nowritebarrierrec
5775 func pidleput(pp *p, now int64) int64 {
5776         assertLockHeld(&sched.lock)
5777
5778         if !runqempty(pp) {
5779                 throw("pidleput: P has non-empty run queue")
5780         }
5781         if now == 0 {
5782                 now = nanotime()
5783         }
5784         updateTimerPMask(pp) // clear if there are no timers.
5785         idlepMask.set(pp.id)
5786         pp.link = sched.pidle
5787         sched.pidle.set(pp)
5788         sched.npidle.Add(1)
5789         if !pp.limiterEvent.start(limiterEventIdle, now) {
5790                 throw("must be able to track idle limiter event")
5791         }
5792         return now
5793 }
5794
5795 // pidleget tries to get a p from the _Pidle list, acquiring ownership.
5796 //
5797 // sched.lock must be held.
5798 //
5799 // May run during STW, so write barriers are not allowed.
5800 //
5801 //go:nowritebarrierrec
5802 func pidleget(now int64) (*p, int64) {
5803         assertLockHeld(&sched.lock)
5804
5805         pp := sched.pidle.ptr()
5806         if pp != nil {
5807                 // Timer may get added at any time now.
5808                 if now == 0 {
5809                         now = nanotime()
5810                 }
5811                 timerpMask.set(pp.id)
5812                 idlepMask.clear(pp.id)
5813                 sched.pidle = pp.link
5814                 sched.npidle.Add(-1)
5815                 pp.limiterEvent.stop(limiterEventIdle, now)
5816         }
5817         return pp, now
5818 }
5819
5820 // pidlegetSpinning tries to get a p from the _Pidle list, acquiring ownership.
5821 // This is called by spinning Ms (or callers than need a spinning M) that have
5822 // found work. If no P is available, this must synchronized with non-spinning
5823 // Ms that may be preparing to drop their P without discovering this work.
5824 //
5825 // sched.lock must be held.
5826 //
5827 // May run during STW, so write barriers are not allowed.
5828 //
5829 //go:nowritebarrierrec
5830 func pidlegetSpinning(now int64) (*p, int64) {
5831         assertLockHeld(&sched.lock)
5832
5833         pp, now := pidleget(now)
5834         if pp == nil {
5835                 // See "Delicate dance" comment in findrunnable. We found work
5836                 // that we cannot take, we must synchronize with non-spinning
5837                 // Ms that may be preparing to drop their P.
5838                 sched.needspinning.Store(1)
5839                 return nil, now
5840         }
5841
5842         return pp, now
5843 }
5844
5845 // runqempty reports whether pp has no Gs on its local run queue.
5846 // It never returns true spuriously.
5847 func runqempty(pp *p) bool {
5848         // Defend against a race where 1) pp has G1 in runqnext but runqhead == runqtail,
5849         // 2) runqput on pp kicks G1 to the runq, 3) runqget on pp empties runqnext.
5850         // Simply observing that runqhead == runqtail and then observing that runqnext == nil
5851         // does not mean the queue is empty.
5852         for {
5853                 head := atomic.Load(&pp.runqhead)
5854                 tail := atomic.Load(&pp.runqtail)
5855                 runnext := atomic.Loaduintptr((*uintptr)(unsafe.Pointer(&pp.runnext)))
5856                 if tail == atomic.Load(&pp.runqtail) {
5857                         return head == tail && runnext == 0
5858                 }
5859         }
5860 }
5861
5862 // To shake out latent assumptions about scheduling order,
5863 // we introduce some randomness into scheduling decisions
5864 // when running with the race detector.
5865 // The need for this was made obvious by changing the
5866 // (deterministic) scheduling order in Go 1.5 and breaking
5867 // many poorly-written tests.
5868 // With the randomness here, as long as the tests pass
5869 // consistently with -race, they shouldn't have latent scheduling
5870 // assumptions.
5871 const randomizeScheduler = raceenabled
5872
5873 // runqput tries to put g on the local runnable queue.
5874 // If next is false, runqput adds g to the tail of the runnable queue.
5875 // If next is true, runqput puts g in the pp.runnext slot.
5876 // If the run queue is full, runnext puts g on the global queue.
5877 // Executed only by the owner P.
5878 func runqput(pp *p, gp *g, next bool) {
5879         if randomizeScheduler && next && fastrandn(2) == 0 {
5880                 next = false
5881         }
5882
5883         if next {
5884         retryNext:
5885                 oldnext := pp.runnext
5886                 if !pp.runnext.cas(oldnext, guintptr(unsafe.Pointer(gp))) {
5887                         goto retryNext
5888                 }
5889                 if oldnext == 0 {
5890                         return
5891                 }
5892                 // Kick the old runnext out to the regular run queue.
5893                 gp = oldnext.ptr()
5894         }
5895
5896 retry:
5897         h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with consumers
5898         t := pp.runqtail
5899         if t-h < uint32(len(pp.runq)) {
5900                 pp.runq[t%uint32(len(pp.runq))].set(gp)
5901                 atomic.StoreRel(&pp.runqtail, t+1) // store-release, makes the item available for consumption
5902                 return
5903         }
5904         if runqputslow(pp, gp, h, t) {
5905                 return
5906         }
5907         // the queue is not full, now the put above must succeed
5908         goto retry
5909 }
5910
5911 // Put g and a batch of work from local runnable queue on global queue.
5912 // Executed only by the owner P.
5913 func runqputslow(pp *p, gp *g, h, t uint32) bool {
5914         var batch [len(pp.runq)/2 + 1]*g
5915
5916         // First, grab a batch from local queue.
5917         n := t - h
5918         n = n / 2
5919         if n != uint32(len(pp.runq)/2) {
5920                 throw("runqputslow: queue is not full")
5921         }
5922         for i := uint32(0); i < n; i++ {
5923                 batch[i] = pp.runq[(h+i)%uint32(len(pp.runq))].ptr()
5924         }
5925         if !atomic.CasRel(&pp.runqhead, h, h+n) { // cas-release, commits consume
5926                 return false
5927         }
5928         batch[n] = gp
5929
5930         if randomizeScheduler {
5931                 for i := uint32(1); i <= n; i++ {
5932                         j := fastrandn(i + 1)
5933                         batch[i], batch[j] = batch[j], batch[i]
5934                 }
5935         }
5936
5937         // Link the goroutines.
5938         for i := uint32(0); i < n; i++ {
5939                 batch[i].schedlink.set(batch[i+1])
5940         }
5941         var q gQueue
5942         q.head.set(batch[0])
5943         q.tail.set(batch[n])
5944
5945         // Now put the batch on global queue.
5946         lock(&sched.lock)
5947         globrunqputbatch(&q, int32(n+1))
5948         unlock(&sched.lock)
5949         return true
5950 }
5951
5952 // runqputbatch tries to put all the G's on q on the local runnable queue.
5953 // If the queue is full, they are put on the global queue; in that case
5954 // this will temporarily acquire the scheduler lock.
5955 // Executed only by the owner P.
5956 func runqputbatch(pp *p, q *gQueue, qsize int) {
5957         h := atomic.LoadAcq(&pp.runqhead)
5958         t := pp.runqtail
5959         n := uint32(0)
5960         for !q.empty() && t-h < uint32(len(pp.runq)) {
5961                 gp := q.pop()
5962                 pp.runq[t%uint32(len(pp.runq))].set(gp)
5963                 t++
5964                 n++
5965         }
5966         qsize -= int(n)
5967
5968         if randomizeScheduler {
5969                 off := func(o uint32) uint32 {
5970                         return (pp.runqtail + o) % uint32(len(pp.runq))
5971                 }
5972                 for i := uint32(1); i < n; i++ {
5973                         j := fastrandn(i + 1)
5974                         pp.runq[off(i)], pp.runq[off(j)] = pp.runq[off(j)], pp.runq[off(i)]
5975                 }
5976         }
5977
5978         atomic.StoreRel(&pp.runqtail, t)
5979         if !q.empty() {
5980                 lock(&sched.lock)
5981                 globrunqputbatch(q, int32(qsize))
5982                 unlock(&sched.lock)
5983         }
5984 }
5985
5986 // Get g from local runnable queue.
5987 // If inheritTime is true, gp should inherit the remaining time in the
5988 // current time slice. Otherwise, it should start a new time slice.
5989 // Executed only by the owner P.
5990 func runqget(pp *p) (gp *g, inheritTime bool) {
5991         // If there's a runnext, it's the next G to run.
5992         next := pp.runnext
5993         // If the runnext is non-0 and the CAS fails, it could only have been stolen by another P,
5994         // because other Ps can race to set runnext to 0, but only the current P can set it to non-0.
5995         // Hence, there's no need to retry this CAS if it falls.
5996         if next != 0 && pp.runnext.cas(next, 0) {
5997                 return next.ptr(), true
5998         }
5999
6000         for {
6001                 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with other consumers
6002                 t := pp.runqtail
6003                 if t == h {
6004                         return nil, false
6005                 }
6006                 gp := pp.runq[h%uint32(len(pp.runq))].ptr()
6007                 if atomic.CasRel(&pp.runqhead, h, h+1) { // cas-release, commits consume
6008                         return gp, false
6009                 }
6010         }
6011 }
6012
6013 // runqdrain drains the local runnable queue of pp and returns all goroutines in it.
6014 // Executed only by the owner P.
6015 func runqdrain(pp *p) (drainQ gQueue, n uint32) {
6016         oldNext := pp.runnext
6017         if oldNext != 0 && pp.runnext.cas(oldNext, 0) {
6018                 drainQ.pushBack(oldNext.ptr())
6019                 n++
6020         }
6021
6022 retry:
6023         h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with other consumers
6024         t := pp.runqtail
6025         qn := t - h
6026         if qn == 0 {
6027                 return
6028         }
6029         if qn > uint32(len(pp.runq)) { // read inconsistent h and t
6030                 goto retry
6031         }
6032
6033         if !atomic.CasRel(&pp.runqhead, h, h+qn) { // cas-release, commits consume
6034                 goto retry
6035         }
6036
6037         // We've inverted the order in which it gets G's from the local P's runnable queue
6038         // and then advances the head pointer because we don't want to mess up the statuses of G's
6039         // while runqdrain() and runqsteal() are running in parallel.
6040         // Thus we should advance the head pointer before draining the local P into a gQueue,
6041         // so that we can update any gp.schedlink only after we take the full ownership of G,
6042         // meanwhile, other P's can't access to all G's in local P's runnable queue and steal them.
6043         // See https://groups.google.com/g/golang-dev/c/0pTKxEKhHSc/m/6Q85QjdVBQAJ for more details.
6044         for i := uint32(0); i < qn; i++ {
6045                 gp := pp.runq[(h+i)%uint32(len(pp.runq))].ptr()
6046                 drainQ.pushBack(gp)
6047                 n++
6048         }
6049         return
6050 }
6051
6052 // Grabs a batch of goroutines from pp's runnable queue into batch.
6053 // Batch is a ring buffer starting at batchHead.
6054 // Returns number of grabbed goroutines.
6055 // Can be executed by any P.
6056 func runqgrab(pp *p, batch *[256]guintptr, batchHead uint32, stealRunNextG bool) uint32 {
6057         for {
6058                 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with other consumers
6059                 t := atomic.LoadAcq(&pp.runqtail) // load-acquire, synchronize with the producer
6060                 n := t - h
6061                 n = n - n/2
6062                 if n == 0 {
6063                         if stealRunNextG {
6064                                 // Try to steal from pp.runnext.
6065                                 if next := pp.runnext; next != 0 {
6066                                         if pp.status == _Prunning {
6067                                                 // Sleep to ensure that pp isn't about to run the g
6068                                                 // we are about to steal.
6069                                                 // The important use case here is when the g running
6070                                                 // on pp ready()s another g and then almost
6071                                                 // immediately blocks. Instead of stealing runnext
6072                                                 // in this window, back off to give pp a chance to
6073                                                 // schedule runnext. This will avoid thrashing gs
6074                                                 // between different Ps.
6075                                                 // A sync chan send/recv takes ~50ns as of time of
6076                                                 // writing, so 3us gives ~50x overshoot.
6077                                                 if GOOS != "windows" && GOOS != "openbsd" && GOOS != "netbsd" {
6078                                                         usleep(3)
6079                                                 } else {
6080                                                         // On some platforms system timer granularity is
6081                                                         // 1-15ms, which is way too much for this
6082                                                         // optimization. So just yield.
6083                                                         osyield()
6084                                                 }
6085                                         }
6086                                         if !pp.runnext.cas(next, 0) {
6087                                                 continue
6088                                         }
6089                                         batch[batchHead%uint32(len(batch))] = next
6090                                         return 1
6091                                 }
6092                         }
6093                         return 0
6094                 }
6095                 if n > uint32(len(pp.runq)/2) { // read inconsistent h and t
6096                         continue
6097                 }
6098                 for i := uint32(0); i < n; i++ {
6099                         g := pp.runq[(h+i)%uint32(len(pp.runq))]
6100                         batch[(batchHead+i)%uint32(len(batch))] = g
6101                 }
6102                 if atomic.CasRel(&pp.runqhead, h, h+n) { // cas-release, commits consume
6103                         return n
6104                 }
6105         }
6106 }
6107
6108 // Steal half of elements from local runnable queue of p2
6109 // and put onto local runnable queue of p.
6110 // Returns one of the stolen elements (or nil if failed).
6111 func runqsteal(pp, p2 *p, stealRunNextG bool) *g {
6112         t := pp.runqtail
6113         n := runqgrab(p2, &pp.runq, t, stealRunNextG)
6114         if n == 0 {
6115                 return nil
6116         }
6117         n--
6118         gp := pp.runq[(t+n)%uint32(len(pp.runq))].ptr()
6119         if n == 0 {
6120                 return gp
6121         }
6122         h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with consumers
6123         if t-h+n >= uint32(len(pp.runq)) {
6124                 throw("runqsteal: runq overflow")
6125         }
6126         atomic.StoreRel(&pp.runqtail, t+n) // store-release, makes the item available for consumption
6127         return gp
6128 }
6129
6130 // A gQueue is a dequeue of Gs linked through g.schedlink. A G can only
6131 // be on one gQueue or gList at a time.
6132 type gQueue struct {
6133         head guintptr
6134         tail guintptr
6135 }
6136
6137 // empty reports whether q is empty.
6138 func (q *gQueue) empty() bool {
6139         return q.head == 0
6140 }
6141
6142 // push adds gp to the head of q.
6143 func (q *gQueue) push(gp *g) {
6144         gp.schedlink = q.head
6145         q.head.set(gp)
6146         if q.tail == 0 {
6147                 q.tail.set(gp)
6148         }
6149 }
6150
6151 // pushBack adds gp to the tail of q.
6152 func (q *gQueue) pushBack(gp *g) {
6153         gp.schedlink = 0
6154         if q.tail != 0 {
6155                 q.tail.ptr().schedlink.set(gp)
6156         } else {
6157                 q.head.set(gp)
6158         }
6159         q.tail.set(gp)
6160 }
6161
6162 // pushBackAll adds all Gs in q2 to the tail of q. After this q2 must
6163 // not be used.
6164 func (q *gQueue) pushBackAll(q2 gQueue) {
6165         if q2.tail == 0 {
6166                 return
6167         }
6168         q2.tail.ptr().schedlink = 0
6169         if q.tail != 0 {
6170                 q.tail.ptr().schedlink = q2.head
6171         } else {
6172                 q.head = q2.head
6173         }
6174         q.tail = q2.tail
6175 }
6176
6177 // pop removes and returns the head of queue q. It returns nil if
6178 // q is empty.
6179 func (q *gQueue) pop() *g {
6180         gp := q.head.ptr()
6181         if gp != nil {
6182                 q.head = gp.schedlink
6183                 if q.head == 0 {
6184                         q.tail = 0
6185                 }
6186         }
6187         return gp
6188 }
6189
6190 // popList takes all Gs in q and returns them as a gList.
6191 func (q *gQueue) popList() gList {
6192         stack := gList{q.head}
6193         *q = gQueue{}
6194         return stack
6195 }
6196
6197 // A gList is a list of Gs linked through g.schedlink. A G can only be
6198 // on one gQueue or gList at a time.
6199 type gList struct {
6200         head guintptr
6201 }
6202
6203 // empty reports whether l is empty.
6204 func (l *gList) empty() bool {
6205         return l.head == 0
6206 }
6207
6208 // push adds gp to the head of l.
6209 func (l *gList) push(gp *g) {
6210         gp.schedlink = l.head
6211         l.head.set(gp)
6212 }
6213
6214 // pushAll prepends all Gs in q to l.
6215 func (l *gList) pushAll(q gQueue) {
6216         if !q.empty() {
6217                 q.tail.ptr().schedlink = l.head
6218                 l.head = q.head
6219         }
6220 }
6221
6222 // pop removes and returns the head of l. If l is empty, it returns nil.
6223 func (l *gList) pop() *g {
6224         gp := l.head.ptr()
6225         if gp != nil {
6226                 l.head = gp.schedlink
6227         }
6228         return gp
6229 }
6230
6231 //go:linkname setMaxThreads runtime/debug.setMaxThreads
6232 func setMaxThreads(in int) (out int) {
6233         lock(&sched.lock)
6234         out = int(sched.maxmcount)
6235         if in > 0x7fffffff { // MaxInt32
6236                 sched.maxmcount = 0x7fffffff
6237         } else {
6238                 sched.maxmcount = int32(in)
6239         }
6240         checkmcount()
6241         unlock(&sched.lock)
6242         return
6243 }
6244
6245 //go:nosplit
6246 func procPin() int {
6247         gp := getg()
6248         mp := gp.m
6249
6250         mp.locks++
6251         return int(mp.p.ptr().id)
6252 }
6253
6254 //go:nosplit
6255 func procUnpin() {
6256         gp := getg()
6257         gp.m.locks--
6258 }
6259
6260 //go:linkname sync_runtime_procPin sync.runtime_procPin
6261 //go:nosplit
6262 func sync_runtime_procPin() int {
6263         return procPin()
6264 }
6265
6266 //go:linkname sync_runtime_procUnpin sync.runtime_procUnpin
6267 //go:nosplit
6268 func sync_runtime_procUnpin() {
6269         procUnpin()
6270 }
6271
6272 //go:linkname sync_atomic_runtime_procPin sync/atomic.runtime_procPin
6273 //go:nosplit
6274 func sync_atomic_runtime_procPin() int {
6275         return procPin()
6276 }
6277
6278 //go:linkname sync_atomic_runtime_procUnpin sync/atomic.runtime_procUnpin
6279 //go:nosplit
6280 func sync_atomic_runtime_procUnpin() {
6281         procUnpin()
6282 }
6283
6284 // Active spinning for sync.Mutex.
6285 //
6286 //go:linkname sync_runtime_canSpin sync.runtime_canSpin
6287 //go:nosplit
6288 func sync_runtime_canSpin(i int) bool {
6289         // sync.Mutex is cooperative, so we are conservative with spinning.
6290         // Spin only few times and only if running on a multicore machine and
6291         // GOMAXPROCS>1 and there is at least one other running P and local runq is empty.
6292         // As opposed to runtime mutex we don't do passive spinning here,
6293         // because there can be work on global runq or on other Ps.
6294         if i >= active_spin || ncpu <= 1 || gomaxprocs <= sched.npidle.Load()+sched.nmspinning.Load()+1 {
6295                 return false
6296         }
6297         if p := getg().m.p.ptr(); !runqempty(p) {
6298                 return false
6299         }
6300         return true
6301 }
6302
6303 //go:linkname sync_runtime_doSpin sync.runtime_doSpin
6304 //go:nosplit
6305 func sync_runtime_doSpin() {
6306         procyield(active_spin_cnt)
6307 }
6308
6309 var stealOrder randomOrder
6310
6311 // randomOrder/randomEnum are helper types for randomized work stealing.
6312 // They allow to enumerate all Ps in different pseudo-random orders without repetitions.
6313 // The algorithm is based on the fact that if we have X such that X and GOMAXPROCS
6314 // are coprime, then a sequences of (i + X) % GOMAXPROCS gives the required enumeration.
6315 type randomOrder struct {
6316         count    uint32
6317         coprimes []uint32
6318 }
6319
6320 type randomEnum struct {
6321         i     uint32
6322         count uint32
6323         pos   uint32
6324         inc   uint32
6325 }
6326
6327 func (ord *randomOrder) reset(count uint32) {
6328         ord.count = count
6329         ord.coprimes = ord.coprimes[:0]
6330         for i := uint32(1); i <= count; i++ {
6331                 if gcd(i, count) == 1 {
6332                         ord.coprimes = append(ord.coprimes, i)
6333                 }
6334         }
6335 }
6336
6337 func (ord *randomOrder) start(i uint32) randomEnum {
6338         return randomEnum{
6339                 count: ord.count,
6340                 pos:   i % ord.count,
6341                 inc:   ord.coprimes[i/ord.count%uint32(len(ord.coprimes))],
6342         }
6343 }
6344
6345 func (enum *randomEnum) done() bool {
6346         return enum.i == enum.count
6347 }
6348
6349 func (enum *randomEnum) next() {
6350         enum.i++
6351         enum.pos = (enum.pos + enum.inc) % enum.count
6352 }
6353
6354 func (enum *randomEnum) position() uint32 {
6355         return enum.pos
6356 }
6357
6358 func gcd(a, b uint32) uint32 {
6359         for b != 0 {
6360                 a, b = b, a%b
6361         }
6362         return a
6363 }
6364
6365 // An initTask represents the set of initializations that need to be done for a package.
6366 // Keep in sync with ../../test/initempty.go:initTask
6367 type initTask struct {
6368         // TODO: pack the first 3 fields more tightly?
6369         state uintptr // 0 = uninitialized, 1 = in progress, 2 = done
6370         ndeps uintptr
6371         nfns  uintptr
6372         // followed by ndeps instances of an *initTask, one per package depended on
6373         // followed by nfns pcs, one per init function to run
6374 }
6375
6376 // inittrace stores statistics for init functions which are
6377 // updated by malloc and newproc when active is true.
6378 var inittrace tracestat
6379
6380 type tracestat struct {
6381         active bool   // init tracing activation status
6382         id     uint64 // init goroutine id
6383         allocs uint64 // heap allocations
6384         bytes  uint64 // heap allocated bytes
6385 }
6386
6387 func doInit(t *initTask) {
6388         switch t.state {
6389         case 2: // fully initialized
6390                 return
6391         case 1: // initialization in progress
6392                 throw("recursive call during initialization - linker skew")
6393         default: // not initialized yet
6394                 t.state = 1 // initialization in progress
6395
6396                 for i := uintptr(0); i < t.ndeps; i++ {
6397                         p := add(unsafe.Pointer(t), (3+i)*goarch.PtrSize)
6398                         t2 := *(**initTask)(p)
6399                         doInit(t2)
6400                 }
6401
6402                 if t.nfns == 0 {
6403                         t.state = 2 // initialization done
6404                         return
6405                 }
6406
6407                 var (
6408                         start  int64
6409                         before tracestat
6410                 )
6411
6412                 if inittrace.active {
6413                         start = nanotime()
6414                         // Load stats non-atomically since tracinit is updated only by this init goroutine.
6415                         before = inittrace
6416                 }
6417
6418                 firstFunc := add(unsafe.Pointer(t), (3+t.ndeps)*goarch.PtrSize)
6419                 for i := uintptr(0); i < t.nfns; i++ {
6420                         p := add(firstFunc, i*goarch.PtrSize)
6421                         f := *(*func())(unsafe.Pointer(&p))
6422                         f()
6423                 }
6424
6425                 if inittrace.active {
6426                         end := nanotime()
6427                         // Load stats non-atomically since tracinit is updated only by this init goroutine.
6428                         after := inittrace
6429
6430                         f := *(*func())(unsafe.Pointer(&firstFunc))
6431                         pkg := funcpkgpath(findfunc(abi.FuncPCABIInternal(f)))
6432
6433                         var sbuf [24]byte
6434                         print("init ", pkg, " @")
6435                         print(string(fmtNSAsMS(sbuf[:], uint64(start-runtimeInitTime))), " ms, ")
6436                         print(string(fmtNSAsMS(sbuf[:], uint64(end-start))), " ms clock, ")
6437                         print(string(itoa(sbuf[:], after.bytes-before.bytes)), " bytes, ")
6438                         print(string(itoa(sbuf[:], after.allocs-before.allocs)), " allocs")
6439                         print("\n")
6440                 }
6441
6442                 t.state = 2 // initialization done
6443         }
6444 }