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