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