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.
11 "runtime/internal/atomic"
12 "runtime/internal/sys"
16 // set using cmd/go/internal/modload.ModInfoProg
19 // Goroutine scheduler
20 // The scheduler's job is to distribute ready-to-run goroutines over worker threads.
22 // The main concepts are:
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.
29 // Design doc at https://golang.org/s/go11sched.
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).
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
53 // The current approach:
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.
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.
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.
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
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.
86 // The general pattern for submission is:
87 // 1. Submit work to the local or global run queue, timer heap, or GC state.
88 // 2. #StoreLoad-style memory barrier.
89 // 3. Check sched.nmspinning.
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.
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.
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
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
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
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
131 //go:linkname main_main main.main
134 // mainStarted indicates that the main M has started.
137 // runtimeInitTime is the nanotime() at which the runtime started.
138 var runtimeInitTime int64
140 // Value to use for signal mask for newly created M's.
141 var initSigmask sigset
143 // The main goroutine.
147 // Racectx of m0->g0 is used only as the parent of the main goroutine.
148 // It must not be used for anything else.
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
157 maxstacksize = 250000000
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
165 // Allow newproc to start new Ms.
168 if GOARCH != "wasm" { // no threads on wasm yet, so no sysmon
170 newm(sysmon, nil, -1)
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.
183 throw("runtime.main not on m0")
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")
193 if debug.inittrace != 0 {
194 inittrace.id = getg().goid
195 inittrace.active = true
198 doInit(runtime_inittasks) // Must be before defer.
200 // Defer unlock so that runtime.Goexit during init does the unlock too.
210 main_init_done = make(chan bool)
212 if _cgo_pthread_key_created == nil {
213 throw("_cgo_pthread_key_created missing")
216 if _cgo_thread_start == nil {
217 throw("_cgo_thread_start missing")
219 if GOOS != "windows" {
220 if _cgo_setenv == nil {
221 throw("_cgo_setenv missing")
223 if _cgo_unsetenv == nil {
224 throw("_cgo_unsetenv missing")
227 if _cgo_notify_runtime_init_done == nil {
228 throw("_cgo_notify_runtime_init_done missing")
231 // Set the x_crosscall2_ptr C function pointer variable point to crosscall2.
232 if set_crosscall2 == nil {
233 throw("set_crosscall2 missing")
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)
243 // Run the initializing tasks. Depending on build mode this
244 // list can arrive a few different ways, but it will always
245 // contain the init tasks computed by the linker for all the
246 // packages in the program (excluding those added at runtime
247 // by package plugin). Run through the modules in dependency
248 // order (the order they are initialized by the dynamic
249 // loader, i.e. they are added to the moduledata linked list).
250 for m := &firstmoduledata; m != nil; m = m.next {
254 // Disable init tracing after main init done to avoid overhead
255 // of collecting statistics in malloc and newproc
256 inittrace.active = false
258 close(main_init_done)
263 if isarchive || islibrary {
264 // A program compiled with -buildmode=c-archive or c-shared
265 // has a main, but it is not executed.
268 fn := main_main // make an indirect call, as the linker doesn't know the address of the main package when laying down the runtime
271 runExitHooks(0) // run hooks now, since racefini does not return
275 // Make racy client program work: if panicking on
276 // another goroutine at the same time as main returns,
277 // let the other goroutine finish printing the panic trace.
278 // Once it does, it will exit. See issues 3934 and 20018.
279 if runningPanicDefers.Load() != 0 {
280 // Running deferred functions should not take long.
281 for c := 0; c < 1000; c++ {
282 if runningPanicDefers.Load() == 0 {
288 if panicking.Load() != 0 {
289 gopark(nil, nil, waitReasonPanicWait, traceBlockForever, 1)
300 // os_beforeExit is called from os.Exit(0).
302 //go:linkname os_beforeExit os.runtime_beforeExit
303 func os_beforeExit(exitCode int) {
304 runExitHooks(exitCode)
305 if exitCode == 0 && raceenabled {
310 // start forcegc helper goroutine
315 func forcegchelper() {
317 lockInit(&forcegc.lock, lockRankForcegc)
320 if forcegc.idle.Load() {
321 throw("forcegc: phase error")
323 forcegc.idle.Store(true)
324 goparkunlock(&forcegc.lock, waitReasonForceGCIdle, traceBlockSystemGoroutine, 1)
325 // this goroutine is explicitly resumed by sysmon
326 if debug.gctrace > 0 {
329 // Time-triggered, fully concurrent.
330 gcStart(gcTrigger{kind: gcTriggerTime, now: nanotime()})
334 // Gosched yields the processor, allowing other goroutines to run. It does not
335 // suspend the current goroutine, so execution resumes automatically.
343 // goschedguarded yields the processor like gosched, but also checks
344 // for forbidden states and opts out of the yield in those cases.
347 func goschedguarded() {
348 mcall(goschedguarded_m)
351 // goschedIfBusy yields the processor like gosched, but only does so if
352 // there are no idle Ps or if we're on the only P and there's nothing in
353 // the run queue. In both cases, there is freely available idle time.
356 func goschedIfBusy() {
358 // Call gosched if gp.preempt is set; we may be in a tight loop that
359 // doesn't otherwise yield.
360 if !gp.preempt && sched.npidle.Load() > 0 {
366 // Puts the current goroutine into a waiting state and calls unlockf on the
369 // If unlockf returns false, the goroutine is resumed.
371 // unlockf must not access this G's stack, as it may be moved between
372 // the call to gopark and the call to unlockf.
374 // Note that because unlockf is called after putting the G into a waiting
375 // state, the G may have already been readied by the time unlockf is called
376 // unless there is external synchronization preventing the G from being
377 // readied. If unlockf returns false, it must guarantee that the G cannot be
378 // externally readied.
380 // Reason explains why the goroutine has been parked. It is displayed in stack
381 // traces and heap dumps. Reasons should be unique and descriptive. Do not
382 // re-use reasons, add new ones.
383 func gopark(unlockf func(*g, unsafe.Pointer) bool, lock unsafe.Pointer, reason waitReason, traceReason traceBlockReason, traceskip int) {
384 if reason != waitReasonSleep {
385 checkTimeouts() // timeouts may expire while two goroutines keep the scheduler busy
389 status := readgstatus(gp)
390 if status != _Grunning && status != _Gscanrunning {
391 throw("gopark: bad g status")
394 mp.waitunlockf = unlockf
395 gp.waitreason = reason
396 mp.waitTraceBlockReason = traceReason
397 mp.waitTraceSkip = traceskip
399 // can't do anything that might move the G between Ms here.
403 // Puts the current goroutine into a waiting state and unlocks the lock.
404 // The goroutine can be made runnable again by calling goready(gp).
405 func goparkunlock(lock *mutex, reason waitReason, traceReason traceBlockReason, traceskip int) {
406 gopark(parkunlock_c, unsafe.Pointer(lock), reason, traceReason, traceskip)
409 func goready(gp *g, traceskip int) {
411 ready(gp, traceskip, true)
416 func acquireSudog() *sudog {
417 // Delicate dance: the semaphore implementation calls
418 // acquireSudog, acquireSudog calls new(sudog),
419 // new calls malloc, malloc can call the garbage collector,
420 // and the garbage collector calls the semaphore implementation
422 // Break the cycle by doing acquirem/releasem around new(sudog).
423 // The acquirem/releasem increments m.locks during new(sudog),
424 // which keeps the garbage collector from being invoked.
427 if len(pp.sudogcache) == 0 {
428 lock(&sched.sudoglock)
429 // First, try to grab a batch from central cache.
430 for len(pp.sudogcache) < cap(pp.sudogcache)/2 && sched.sudogcache != nil {
431 s := sched.sudogcache
432 sched.sudogcache = s.next
434 pp.sudogcache = append(pp.sudogcache, s)
436 unlock(&sched.sudoglock)
437 // If the central cache is empty, allocate a new one.
438 if len(pp.sudogcache) == 0 {
439 pp.sudogcache = append(pp.sudogcache, new(sudog))
442 n := len(pp.sudogcache)
443 s := pp.sudogcache[n-1]
444 pp.sudogcache[n-1] = nil
445 pp.sudogcache = pp.sudogcache[:n-1]
447 throw("acquireSudog: found s.elem != nil in cache")
454 func releaseSudog(s *sudog) {
456 throw("runtime: sudog with non-nil elem")
459 throw("runtime: sudog with non-false isSelect")
462 throw("runtime: sudog with non-nil next")
465 throw("runtime: sudog with non-nil prev")
467 if s.waitlink != nil {
468 throw("runtime: sudog with non-nil waitlink")
471 throw("runtime: sudog with non-nil c")
475 throw("runtime: releaseSudog with non-nil gp.param")
477 mp := acquirem() // avoid rescheduling to another P
479 if len(pp.sudogcache) == cap(pp.sudogcache) {
480 // Transfer half of local cache to the central cache.
481 var first, last *sudog
482 for len(pp.sudogcache) > cap(pp.sudogcache)/2 {
483 n := len(pp.sudogcache)
484 p := pp.sudogcache[n-1]
485 pp.sudogcache[n-1] = nil
486 pp.sudogcache = pp.sudogcache[:n-1]
494 lock(&sched.sudoglock)
495 last.next = sched.sudogcache
496 sched.sudogcache = first
497 unlock(&sched.sudoglock)
499 pp.sudogcache = append(pp.sudogcache, s)
503 // called from assembly.
504 func badmcall(fn func(*g)) {
505 throw("runtime: mcall called on m->g0 stack")
508 func badmcall2(fn func(*g)) {
509 throw("runtime: mcall function returned")
512 func badreflectcall() {
513 panic(plainError("arg size to reflect.call more than 1GB"))
517 //go:nowritebarrierrec
518 func badmorestackg0() {
519 if !crashStackImplemented {
520 writeErrStr("fatal: morestack on g0\n")
525 switchToCrashStack(func() {
526 print("runtime: morestack on g0, stack [", hex(g.stack.lo), " ", hex(g.stack.hi), "], sp=", hex(g.sched.sp), ", called from\n")
527 g.m.traceback = 2 // include pc and sp in stack trace
528 traceback1(g.sched.pc, g.sched.sp, g.sched.lr, g, 0)
531 throw("morestack on g0")
536 //go:nowritebarrierrec
537 func badmorestackgsignal() {
538 writeErrStr("fatal: morestack on gsignal\n")
546 // crashstack is a space that can be used as the stack when it is
547 // crashing on bad stack conditions, e.g. morestack on g0.
548 // gcrash is the corresponding (fake) g.
549 var crashstack [16384]byte
552 stack: stack{uintptr(unsafe.Pointer(&crashstack)), uintptr(unsafe.Pointer(&crashstack)) + unsafe.Sizeof(crashstack)},
553 stackguard0: uintptr(unsafe.Pointer(&crashstack)) + 1000,
554 stackguard1: uintptr(unsafe.Pointer(&crashstack)) + 1000,
557 var crashingG atomic.Pointer[g]
559 // Switch to crashstack and call fn, with special handling of
560 // concurrent and recursive cases.
562 // Nosplit as it is called in a bad stack condition (we know
563 // morestack would fail).
566 //go:nowritebarrierrec
567 func switchToCrashStack(fn func()) {
569 if crashingG.CompareAndSwapNoWB(nil, me) {
570 switchToCrashStack0(fn) // should never return
573 if crashingG.Load() == me {
574 // recursive crashing. too bad.
575 writeErrStr("fatal: recursive switchToCrashStack\n")
578 // Another g is crashing. Give it some time, hopefully it will finish traceback.
580 writeErrStr("fatal: concurrent switchToCrashStack\n")
584 const crashStackImplemented = GOARCH == "amd64" || GOARCH == "arm64"
587 func switchToCrashStack0(func()) // in assembly
589 func lockedOSThread() bool {
591 return gp.lockedm != 0 && gp.m.lockedg != 0
595 // allgs contains all Gs ever created (including dead Gs), and thus
598 // Access via the slice is protected by allglock or stop-the-world.
599 // Readers that cannot take the lock may (carefully!) use the atomic
604 // allglen and allgptr are atomic variables that contain len(allgs) and
605 // &allgs[0] respectively. Proper ordering depends on totally-ordered
606 // loads and stores. Writes are protected by allglock.
608 // allgptr is updated before allglen. Readers should read allglen
609 // before allgptr to ensure that allglen is always <= len(allgptr). New
610 // Gs appended during the race can be missed. For a consistent view of
611 // all Gs, allglock must be held.
613 // allgptr copies should always be stored as a concrete type or
614 // unsafe.Pointer, not uintptr, to ensure that GC can still reach it
615 // even if it points to a stale array.
620 func allgadd(gp *g) {
621 if readgstatus(gp) == _Gidle {
622 throw("allgadd: bad status Gidle")
626 allgs = append(allgs, gp)
627 if &allgs[0] != allgptr {
628 atomicstorep(unsafe.Pointer(&allgptr), unsafe.Pointer(&allgs[0]))
630 atomic.Storeuintptr(&allglen, uintptr(len(allgs)))
634 // allGsSnapshot returns a snapshot of the slice of all Gs.
636 // The world must be stopped or allglock must be held.
637 func allGsSnapshot() []*g {
638 assertWorldStoppedOrLockHeld(&allglock)
640 // Because the world is stopped or allglock is held, allgadd
641 // cannot happen concurrently with this. allgs grows
642 // monotonically and existing entries never change, so we can
643 // simply return a copy of the slice header. For added safety,
644 // we trim everything past len because that can still change.
645 return allgs[:len(allgs):len(allgs)]
648 // atomicAllG returns &allgs[0] and len(allgs) for use with atomicAllGIndex.
649 func atomicAllG() (**g, uintptr) {
650 length := atomic.Loaduintptr(&allglen)
651 ptr := (**g)(atomic.Loadp(unsafe.Pointer(&allgptr)))
655 // atomicAllGIndex returns ptr[i] with the allgptr returned from atomicAllG.
656 func atomicAllGIndex(ptr **g, i uintptr) *g {
657 return *(**g)(add(unsafe.Pointer(ptr), i*goarch.PtrSize))
660 // forEachG calls fn on every G from allgs.
662 // forEachG takes a lock to exclude concurrent addition of new Gs.
663 func forEachG(fn func(gp *g)) {
665 for _, gp := range allgs {
671 // forEachGRace calls fn on every G from allgs.
673 // forEachGRace avoids locking, but does not exclude addition of new Gs during
674 // execution, which may be missed.
675 func forEachGRace(fn func(gp *g)) {
676 ptr, length := atomicAllG()
677 for i := uintptr(0); i < length; i++ {
678 gp := atomicAllGIndex(ptr, i)
685 // Number of goroutine ids to grab from sched.goidgen to local per-P cache at once.
686 // 16 seems to provide enough amortization, but other than that it's mostly arbitrary number.
690 // cpuinit sets up CPU feature flags and calls internal/cpu.Initialize. env should be the complete
691 // value of the GODEBUG environment variable.
692 func cpuinit(env string) {
694 case "aix", "darwin", "ios", "dragonfly", "freebsd", "netbsd", "openbsd", "illumos", "solaris", "linux":
695 cpu.DebugOptions = true
699 // Support cpu feature variables are used in code generated by the compiler
700 // to guard execution of instructions that can not be assumed to be always supported.
703 x86HasPOPCNT = cpu.X86.HasPOPCNT
704 x86HasSSE41 = cpu.X86.HasSSE41
705 x86HasFMA = cpu.X86.HasFMA
708 armHasVFPv4 = cpu.ARM.HasVFPv4
711 arm64HasATOMICS = cpu.ARM64.HasATOMICS
715 // getGodebugEarly extracts the environment variable GODEBUG from the environment on
716 // Unix-like operating systems and returns it. This function exists to extract GODEBUG
717 // early before much of the runtime is initialized.
718 func getGodebugEarly() string {
719 const prefix = "GODEBUG="
722 case "aix", "darwin", "ios", "dragonfly", "freebsd", "netbsd", "openbsd", "illumos", "solaris", "linux":
723 // Similar to goenv_unix but extracts the environment value for
725 // TODO(moehrmann): remove when general goenvs() can be called before cpuinit()
727 for argv_index(argv, argc+1+n) != nil {
731 for i := int32(0); i < n; i++ {
732 p := argv_index(argv, argc+1+i)
733 s := unsafe.String(p, findnull(p))
735 if hasPrefix(s, prefix) {
736 env = gostring(p)[len(prefix):]
744 // The bootstrap sequence is:
748 // make & queue new G
749 // call runtime·mstart
751 // The new G calls runtime·main.
753 lockInit(&sched.lock, lockRankSched)
754 lockInit(&sched.sysmonlock, lockRankSysmon)
755 lockInit(&sched.deferlock, lockRankDefer)
756 lockInit(&sched.sudoglock, lockRankSudog)
757 lockInit(&deadlock, lockRankDeadlock)
758 lockInit(&paniclk, lockRankPanic)
759 lockInit(&allglock, lockRankAllg)
760 lockInit(&allpLock, lockRankAllp)
761 lockInit(&reflectOffs.lock, lockRankReflectOffs)
762 lockInit(&finlock, lockRankFin)
763 lockInit(&cpuprof.lock, lockRankCpuprof)
765 // Enforce that this lock is always a leaf lock.
766 // All of this lock's critical sections should be
768 lockInit(&memstats.heapStats.noPLock, lockRankLeafRank)
770 // raceinit must be the first call to race detector.
771 // In particular, it must be done before mallocinit below calls racemapshadow.
774 gp.racectx, raceprocctx0 = raceinit()
777 sched.maxmcount = 10000
779 // The world starts stopped.
785 godebug := getGodebugEarly()
786 initPageTrace(godebug) // must run after mallocinit but before anything allocates
787 cpuinit(godebug) // must run before alginit
788 alginit() // maps, hash, fastrand must not be used before this call
789 fastrandinit() // must run before mcommoninit
790 mcommoninit(gp.m, -1)
791 modulesinit() // provides activeModules
792 typelinksinit() // uses maps, activeModules
793 itabsinit() // uses activeModules
794 stkobjinit() // must run before GC starts
796 sigsave(&gp.m.sigmask)
797 initSigmask = gp.m.sigmask
806 // if disableMemoryProfiling is set, update MemProfileRate to 0 to turn off memprofile.
807 // Note: parsedebugvars may update MemProfileRate, but when disableMemoryProfiling is
808 // set to true by the linker, it means that nothing is consuming the profile, it is
809 // safe to set MemProfileRate to 0.
810 if disableMemoryProfiling {
815 sched.lastpoll.Store(nanotime())
817 if n, ok := atoi32(gogetenv("GOMAXPROCS")); ok && n > 0 {
820 if procresize(procs) != nil {
821 throw("unknown runnable goroutine during bootstrap")
825 // World is effectively started now, as P's can run.
828 if buildVersion == "" {
829 // Condition should never trigger. This code just serves
830 // to ensure runtime·buildVersion is kept in the resulting binary.
831 buildVersion = "unknown"
833 if len(modinfo) == 1 {
834 // Condition should never trigger. This code just serves
835 // to ensure runtime·modinfo is kept in the resulting binary.
840 func dumpgstatus(gp *g) {
842 print("runtime: gp: gp=", gp, ", goid=", gp.goid, ", gp->atomicstatus=", readgstatus(gp), "\n")
843 print("runtime: getg: g=", thisg, ", goid=", thisg.goid, ", g->atomicstatus=", readgstatus(thisg), "\n")
846 // sched.lock must be held.
848 assertLockHeld(&sched.lock)
850 // Exclude extra M's, which are used for cgocallback from threads
853 // The purpose of the SetMaxThreads limit is to avoid accidental fork
854 // bomb from something like millions of goroutines blocking on system
855 // calls, causing the runtime to create millions of threads. By
856 // definition, this isn't a problem for threads created in C, so we
857 // exclude them from the limit. See https://go.dev/issue/60004.
858 count := mcount() - int32(extraMInUse.Load()) - int32(extraMLength.Load())
859 if count > sched.maxmcount {
860 print("runtime: program exceeds ", sched.maxmcount, "-thread limit\n")
861 throw("thread exhaustion")
865 // mReserveID returns the next ID to use for a new m. This new m is immediately
866 // considered 'running' by checkdead.
868 // sched.lock must be held.
869 func mReserveID() int64 {
870 assertLockHeld(&sched.lock)
872 if sched.mnext+1 < sched.mnext {
873 throw("runtime: thread ID overflow")
881 // Pre-allocated ID may be passed as 'id', or omitted by passing -1.
882 func mcommoninit(mp *m, id int64) {
885 // g0 stack won't make sense for user (and is not necessary unwindable).
887 callers(1, mp.createstack[:])
898 lo := uint32(int64Hash(uint64(mp.id), fastrandseed))
899 hi := uint32(int64Hash(uint64(cputicks()), ^fastrandseed))
903 // Same behavior as for 1.17.
904 // TODO: Simplify this.
905 if goarch.BigEndian {
906 mp.fastrand = uint64(lo)<<32 | uint64(hi)
908 mp.fastrand = uint64(hi)<<32 | uint64(lo)
912 if mp.gsignal != nil {
913 mp.gsignal.stackguard1 = mp.gsignal.stack.lo + stackGuard
916 // Add to allm so garbage collector doesn't free g->m
917 // when it is just in a register or thread-local storage.
920 // NumCgoCall() iterates over allm w/o schedlock,
921 // so we need to publish it safely.
922 atomicstorep(unsafe.Pointer(&allm), unsafe.Pointer(mp))
925 // Allocate memory to hold a cgo traceback if the cgo call crashes.
926 if iscgo || GOOS == "solaris" || GOOS == "illumos" || GOOS == "windows" {
927 mp.cgoCallers = new(cgoCallers)
931 func (mp *m) becomeSpinning() {
933 sched.nmspinning.Add(1)
934 sched.needspinning.Store(0)
937 func (mp *m) hasCgoOnStack() bool {
938 return mp.ncgo > 0 || mp.isextra
941 var fastrandseed uintptr
943 func fastrandinit() {
944 s := (*[unsafe.Sizeof(fastrandseed)]byte)(unsafe.Pointer(&fastrandseed))[:]
948 // Mark gp ready to run.
949 func ready(gp *g, traceskip int, next bool) {
951 traceGoUnpark(gp, traceskip)
954 status := readgstatus(gp)
957 mp := acquirem() // disable preemption because it can be holding p in a local var
958 if status&^_Gscan != _Gwaiting {
960 throw("bad g->status in ready")
963 // status is Gwaiting or Gscanwaiting, make Grunnable and put on runq
964 casgstatus(gp, _Gwaiting, _Grunnable)
965 runqput(mp.p.ptr(), gp, next)
970 // freezeStopWait is a large value that freezetheworld sets
971 // sched.stopwait to in order to request that all Gs permanently stop.
972 const freezeStopWait = 0x7fffffff
974 // freezing is set to non-zero if the runtime is trying to freeze the
976 var freezing atomic.Bool
978 // Similar to stopTheWorld but best-effort and can be called several times.
979 // There is no reverse operation, used during crashing.
980 // This function must not lock any mutexes.
981 func freezetheworld() {
983 if debug.dontfreezetheworld > 0 {
984 // Don't prempt Ps to stop goroutines. That will perturb
985 // scheduler state, making debugging more difficult. Instead,
986 // allow goroutines to continue execution.
988 // fatalpanic will tracebackothers to trace all goroutines. It
989 // is unsafe to trace a running goroutine, so tracebackothers
990 // will skip running goroutines. That is OK and expected, we
991 // expect users of dontfreezetheworld to use core files anyway.
993 // However, allowing the scheduler to continue running free
994 // introduces a race: a goroutine may be stopped when
995 // tracebackothers checks its status, and then start running
996 // later when we are in the middle of traceback, potentially
999 // To mitigate this, when an M naturally enters the scheduler,
1000 // schedule checks if freezing is set and if so stops
1001 // execution. This guarantees that while Gs can transition from
1002 // running to stopped, they can never transition from stopped
1005 // The sleep here allows racing Ms that missed freezing and are
1006 // about to run a G to complete the transition to running
1007 // before we start traceback.
1012 // stopwait and preemption requests can be lost
1013 // due to races with concurrently executing threads,
1014 // so try several times
1015 for i := 0; i < 5; i++ {
1016 // this should tell the scheduler to not start any new goroutines
1017 sched.stopwait = freezeStopWait
1018 sched.gcwaiting.Store(true)
1019 // this should stop running goroutines
1021 break // no running goroutines
1031 // All reads and writes of g's status go through readgstatus, casgstatus
1032 // castogscanstatus, casfrom_Gscanstatus.
1035 func readgstatus(gp *g) uint32 {
1036 return gp.atomicstatus.Load()
1039 // The Gscanstatuses are acting like locks and this releases them.
1040 // If it proves to be a performance hit we should be able to make these
1041 // simple atomic stores but for now we are going to throw if
1042 // we see an inconsistent state.
1043 func casfrom_Gscanstatus(gp *g, oldval, newval uint32) {
1046 // Check that transition is valid.
1049 print("runtime: casfrom_Gscanstatus bad oldval gp=", gp, ", oldval=", hex(oldval), ", newval=", hex(newval), "\n")
1051 throw("casfrom_Gscanstatus:top gp->status is not in scan state")
1052 case _Gscanrunnable,
1057 if newval == oldval&^_Gscan {
1058 success = gp.atomicstatus.CompareAndSwap(oldval, newval)
1062 print("runtime: casfrom_Gscanstatus failed gp=", gp, ", oldval=", hex(oldval), ", newval=", hex(newval), "\n")
1064 throw("casfrom_Gscanstatus: gp->status is not in scan state")
1066 releaseLockRank(lockRankGscan)
1069 // This will return false if the gp is not in the expected status and the cas fails.
1070 // This acts like a lock acquire while the casfromgstatus acts like a lock release.
1071 func castogscanstatus(gp *g, oldval, newval uint32) bool {
1077 if newval == oldval|_Gscan {
1078 r := gp.atomicstatus.CompareAndSwap(oldval, newval)
1080 acquireLockRank(lockRankGscan)
1086 print("runtime: castogscanstatus oldval=", hex(oldval), " newval=", hex(newval), "\n")
1087 throw("castogscanstatus")
1088 panic("not reached")
1091 // casgstatusAlwaysTrack is a debug flag that causes casgstatus to always track
1092 // various latencies on every transition instead of sampling them.
1093 var casgstatusAlwaysTrack = false
1095 // If asked to move to or from a Gscanstatus this will throw. Use the castogscanstatus
1096 // and casfrom_Gscanstatus instead.
1097 // casgstatus will loop if the g->atomicstatus is in a Gscan status until the routine that
1098 // put it in the Gscan state is finished.
1101 func casgstatus(gp *g, oldval, newval uint32) {
1102 if (oldval&_Gscan != 0) || (newval&_Gscan != 0) || oldval == newval {
1103 systemstack(func() {
1104 print("runtime: casgstatus: oldval=", hex(oldval), " newval=", hex(newval), "\n")
1105 throw("casgstatus: bad incoming values")
1109 acquireLockRank(lockRankGscan)
1110 releaseLockRank(lockRankGscan)
1112 // See https://golang.org/cl/21503 for justification of the yield delay.
1113 const yieldDelay = 5 * 1000
1116 // loop if gp->atomicstatus is in a scan state giving
1117 // GC time to finish and change the state to oldval.
1118 for i := 0; !gp.atomicstatus.CompareAndSwap(oldval, newval); i++ {
1119 if oldval == _Gwaiting && gp.atomicstatus.Load() == _Grunnable {
1120 throw("casgstatus: waiting for Gwaiting but is Grunnable")
1123 nextYield = nanotime() + yieldDelay
1125 if nanotime() < nextYield {
1126 for x := 0; x < 10 && gp.atomicstatus.Load() != oldval; x++ {
1131 nextYield = nanotime() + yieldDelay/2
1135 if oldval == _Grunning {
1136 // Track every gTrackingPeriod time a goroutine transitions out of running.
1137 if casgstatusAlwaysTrack || gp.trackingSeq%gTrackingPeriod == 0 {
1146 // Handle various kinds of tracking.
1149 // - Time spent in runnable.
1150 // - Time spent blocked on a sync.Mutex or sync.RWMutex.
1153 // We transitioned out of runnable, so measure how much
1154 // time we spent in this state and add it to
1157 gp.runnableTime += now - gp.trackingStamp
1158 gp.trackingStamp = 0
1160 if !gp.waitreason.isMutexWait() {
1161 // Not blocking on a lock.
1164 // Blocking on a lock, measure it. Note that because we're
1165 // sampling, we have to multiply by our sampling period to get
1166 // a more representative estimate of the absolute value.
1167 // gTrackingPeriod also represents an accurate sampling period
1168 // because we can only enter this state from _Grunning.
1170 sched.totalMutexWaitTime.Add((now - gp.trackingStamp) * gTrackingPeriod)
1171 gp.trackingStamp = 0
1175 if !gp.waitreason.isMutexWait() {
1176 // Not blocking on a lock.
1179 // Blocking on a lock. Write down the timestamp.
1181 gp.trackingStamp = now
1183 // We just transitioned into runnable, so record what
1184 // time that happened.
1186 gp.trackingStamp = now
1188 // We're transitioning into running, so turn off
1189 // tracking and record how much time we spent in
1192 sched.timeToRun.record(gp.runnableTime)
1197 // casGToWaiting transitions gp from old to _Gwaiting, and sets the wait reason.
1199 // Use this over casgstatus when possible to ensure that a waitreason is set.
1200 func casGToWaiting(gp *g, old uint32, reason waitReason) {
1201 // Set the wait reason before calling casgstatus, because casgstatus will use it.
1202 gp.waitreason = reason
1203 casgstatus(gp, old, _Gwaiting)
1206 // casgstatus(gp, oldstatus, Gcopystack), assuming oldstatus is Gwaiting or Grunnable.
1207 // Returns old status. Cannot call casgstatus directly, because we are racing with an
1208 // async wakeup that might come in from netpoll. If we see Gwaiting from the readgstatus,
1209 // it might have become Grunnable by the time we get to the cas. If we called casgstatus,
1210 // it would loop waiting for the status to go back to Gwaiting, which it never will.
1213 func casgcopystack(gp *g) uint32 {
1215 oldstatus := readgstatus(gp) &^ _Gscan
1216 if oldstatus != _Gwaiting && oldstatus != _Grunnable {
1217 throw("copystack: bad status, not Gwaiting or Grunnable")
1219 if gp.atomicstatus.CompareAndSwap(oldstatus, _Gcopystack) {
1225 // casGToPreemptScan transitions gp from _Grunning to _Gscan|_Gpreempted.
1227 // TODO(austin): This is the only status operation that both changes
1228 // the status and locks the _Gscan bit. Rethink this.
1229 func casGToPreemptScan(gp *g, old, new uint32) {
1230 if old != _Grunning || new != _Gscan|_Gpreempted {
1231 throw("bad g transition")
1233 acquireLockRank(lockRankGscan)
1234 for !gp.atomicstatus.CompareAndSwap(_Grunning, _Gscan|_Gpreempted) {
1238 // casGFromPreempted attempts to transition gp from _Gpreempted to
1239 // _Gwaiting. If successful, the caller is responsible for
1240 // re-scheduling gp.
1241 func casGFromPreempted(gp *g, old, new uint32) bool {
1242 if old != _Gpreempted || new != _Gwaiting {
1243 throw("bad g transition")
1245 gp.waitreason = waitReasonPreempted
1246 return gp.atomicstatus.CompareAndSwap(_Gpreempted, _Gwaiting)
1249 // stwReason is an enumeration of reasons the world is stopping.
1250 type stwReason uint8
1252 // Reasons to stop-the-world.
1254 // Avoid reusing reasons and add new ones instead.
1256 stwUnknown stwReason = iota // "unknown"
1257 stwGCMarkTerm // "GC mark termination"
1258 stwGCSweepTerm // "GC sweep termination"
1259 stwWriteHeapDump // "write heap dump"
1260 stwGoroutineProfile // "goroutine profile"
1261 stwGoroutineProfileCleanup // "goroutine profile cleanup"
1262 stwAllGoroutinesStack // "all goroutines stack trace"
1263 stwReadMemStats // "read mem stats"
1264 stwAllThreadsSyscall // "AllThreadsSyscall"
1265 stwGOMAXPROCS // "GOMAXPROCS"
1266 stwStartTrace // "start trace"
1267 stwStopTrace // "stop trace"
1268 stwForTestCountPagesInUse // "CountPagesInUse (test)"
1269 stwForTestReadMetricsSlow // "ReadMetricsSlow (test)"
1270 stwForTestReadMemStatsSlow // "ReadMemStatsSlow (test)"
1271 stwForTestPageCachePagesLeaked // "PageCachePagesLeaked (test)"
1272 stwForTestResetDebugLog // "ResetDebugLog (test)"
1275 func (r stwReason) String() string {
1276 return stwReasonStrings[r]
1279 // If you add to this list, also add it to src/internal/trace/parser.go.
1280 // If you change the values of any of the stw* constants, bump the trace
1281 // version number and make a copy of this.
1282 var stwReasonStrings = [...]string{
1283 stwUnknown: "unknown",
1284 stwGCMarkTerm: "GC mark termination",
1285 stwGCSweepTerm: "GC sweep termination",
1286 stwWriteHeapDump: "write heap dump",
1287 stwGoroutineProfile: "goroutine profile",
1288 stwGoroutineProfileCleanup: "goroutine profile cleanup",
1289 stwAllGoroutinesStack: "all goroutines stack trace",
1290 stwReadMemStats: "read mem stats",
1291 stwAllThreadsSyscall: "AllThreadsSyscall",
1292 stwGOMAXPROCS: "GOMAXPROCS",
1293 stwStartTrace: "start trace",
1294 stwStopTrace: "stop trace",
1295 stwForTestCountPagesInUse: "CountPagesInUse (test)",
1296 stwForTestReadMetricsSlow: "ReadMetricsSlow (test)",
1297 stwForTestReadMemStatsSlow: "ReadMemStatsSlow (test)",
1298 stwForTestPageCachePagesLeaked: "PageCachePagesLeaked (test)",
1299 stwForTestResetDebugLog: "ResetDebugLog (test)",
1302 // stopTheWorld stops all P's from executing goroutines, interrupting
1303 // all goroutines at GC safe points and records reason as the reason
1304 // for the stop. On return, only the current goroutine's P is running.
1305 // stopTheWorld must not be called from a system stack and the caller
1306 // must not hold worldsema. The caller must call startTheWorld when
1307 // other P's should resume execution.
1309 // stopTheWorld is safe for multiple goroutines to call at the
1310 // same time. Each will execute its own stop, and the stops will
1313 // This is also used by routines that do stack dumps. If the system is
1314 // in panic or being exited, this may not reliably stop all
1316 func stopTheWorld(reason stwReason) {
1317 semacquire(&worldsema)
1319 gp.m.preemptoff = reason.String()
1320 systemstack(func() {
1321 // Mark the goroutine which called stopTheWorld preemptible so its
1322 // stack may be scanned.
1323 // This lets a mark worker scan us while we try to stop the world
1324 // since otherwise we could get in a mutual preemption deadlock.
1325 // We must not modify anything on the G stack because a stack shrink
1326 // may occur. A stack shrink is otherwise OK though because in order
1327 // to return from this function (and to leave the system stack) we
1328 // must have preempted all goroutines, including any attempting
1329 // to scan our stack, in which case, any stack shrinking will
1330 // have already completed by the time we exit.
1331 // Don't provide a wait reason because we're still executing.
1332 casGToWaiting(gp, _Grunning, waitReasonStoppingTheWorld)
1333 stopTheWorldWithSema(reason)
1334 casgstatus(gp, _Gwaiting, _Grunning)
1338 // startTheWorld undoes the effects of stopTheWorld.
1339 func startTheWorld() {
1340 systemstack(func() { startTheWorldWithSema() })
1342 // worldsema must be held over startTheWorldWithSema to ensure
1343 // gomaxprocs cannot change while worldsema is held.
1345 // Release worldsema with direct handoff to the next waiter, but
1346 // acquirem so that semrelease1 doesn't try to yield our time.
1348 // Otherwise if e.g. ReadMemStats is being called in a loop,
1349 // it might stomp on other attempts to stop the world, such as
1350 // for starting or ending GC. The operation this blocks is
1351 // so heavy-weight that we should just try to be as fair as
1354 // We don't want to just allow us to get preempted between now
1355 // and releasing the semaphore because then we keep everyone
1356 // (including, for example, GCs) waiting longer.
1359 semrelease1(&worldsema, true, 0)
1363 // stopTheWorldGC has the same effect as stopTheWorld, but blocks
1364 // until the GC is not running. It also blocks a GC from starting
1365 // until startTheWorldGC is called.
1366 func stopTheWorldGC(reason stwReason) {
1368 stopTheWorld(reason)
1371 // startTheWorldGC undoes the effects of stopTheWorldGC.
1372 func startTheWorldGC() {
1377 // Holding worldsema grants an M the right to try to stop the world.
1378 var worldsema uint32 = 1
1380 // Holding gcsema grants the M the right to block a GC, and blocks
1381 // until the current GC is done. In particular, it prevents gomaxprocs
1382 // from changing concurrently.
1384 // TODO(mknyszek): Once gomaxprocs and the execution tracer can handle
1385 // being changed/enabled during a GC, remove this.
1386 var gcsema uint32 = 1
1388 // stopTheWorldWithSema is the core implementation of stopTheWorld.
1389 // The caller is responsible for acquiring worldsema and disabling
1390 // preemption first and then should stopTheWorldWithSema on the system
1393 // semacquire(&worldsema, 0)
1394 // m.preemptoff = "reason"
1395 // systemstack(stopTheWorldWithSema)
1397 // When finished, the caller must either call startTheWorld or undo
1398 // these three operations separately:
1400 // m.preemptoff = ""
1401 // systemstack(startTheWorldWithSema)
1402 // semrelease(&worldsema)
1404 // It is allowed to acquire worldsema once and then execute multiple
1405 // startTheWorldWithSema/stopTheWorldWithSema pairs.
1406 // Other P's are able to execute between successive calls to
1407 // startTheWorldWithSema and stopTheWorldWithSema.
1408 // Holding worldsema causes any other goroutines invoking
1409 // stopTheWorld to block.
1410 func stopTheWorldWithSema(reason stwReason) {
1412 traceSTWStart(reason)
1416 // If we hold a lock, then we won't be able to stop another M
1417 // that is blocked trying to acquire the lock.
1419 throw("stopTheWorld: holding locks")
1423 sched.stopwait = gomaxprocs
1424 sched.gcwaiting.Store(true)
1427 gp.m.p.ptr().status = _Pgcstop // Pgcstop is only diagnostic.
1429 // try to retake all P's in Psyscall status
1430 for _, pp := range allp {
1432 if s == _Psyscall && atomic.Cas(&pp.status, s, _Pgcstop) {
1444 pp, _ := pidleget(now)
1448 pp.status = _Pgcstop
1451 wait := sched.stopwait > 0
1454 // wait for remaining P's to stop voluntarily
1457 // wait for 100us, then try to re-preempt in case of any races
1458 if notetsleep(&sched.stopnote, 100*1000) {
1459 noteclear(&sched.stopnote)
1468 if sched.stopwait != 0 {
1469 bad = "stopTheWorld: not stopped (stopwait != 0)"
1471 for _, pp := range allp {
1472 if pp.status != _Pgcstop {
1473 bad = "stopTheWorld: not stopped (status != _Pgcstop)"
1477 if freezing.Load() {
1478 // Some other thread is panicking. This can cause the
1479 // sanity checks above to fail if the panic happens in
1480 // the signal handler on a stopped thread. Either way,
1481 // we should halt this thread.
1492 func startTheWorldWithSema() int64 {
1493 assertWorldStopped()
1495 mp := acquirem() // disable preemption because it can be holding p in a local var
1496 if netpollinited() {
1497 list, delta := netpoll(0) // non-blocking
1499 netpollAdjustWaiters(delta)
1508 p1 := procresize(procs)
1509 sched.gcwaiting.Store(false)
1510 if sched.sysmonwait.Load() {
1511 sched.sysmonwait.Store(false)
1512 notewakeup(&sched.sysmonnote)
1525 throw("startTheWorld: inconsistent mp->nextp")
1528 notewakeup(&mp.park)
1530 // Start M to run P. Do not start another M below.
1535 // Capture start-the-world time before doing clean-up tasks.
1536 startTime := nanotime()
1541 // Wakeup an additional proc in case we have excessive runnable goroutines
1542 // in local queues or in the global queue. If we don't, the proc will park itself.
1543 // If we have lots of excessive work, resetspinning will unpark additional procs as necessary.
1551 // usesLibcall indicates whether this runtime performs system calls
1553 func usesLibcall() bool {
1555 case "aix", "darwin", "illumos", "ios", "solaris", "windows":
1558 return GOARCH != "mips64"
1563 // mStackIsSystemAllocated indicates whether this runtime starts on a
1564 // system-allocated stack.
1565 func mStackIsSystemAllocated() bool {
1567 case "aix", "darwin", "plan9", "illumos", "ios", "solaris", "windows":
1570 return GOARCH != "mips64"
1575 // mstart is the entry-point for new Ms.
1576 // It is written in assembly, uses ABI0, is marked TOPFRAME, and calls mstart0.
1579 // mstart0 is the Go entry-point for new Ms.
1580 // This must not split the stack because we may not even have stack
1581 // bounds set up yet.
1583 // May run during STW (because it doesn't have a P yet), so write
1584 // barriers are not allowed.
1587 //go:nowritebarrierrec
1591 osStack := gp.stack.lo == 0
1593 // Initialize stack bounds from system stack.
1594 // Cgo may have left stack size in stack.hi.
1595 // minit may update the stack bounds.
1597 // Note: these bounds may not be very accurate.
1598 // We set hi to &size, but there are things above
1599 // it. The 1024 is supposed to compensate this,
1600 // but is somewhat arbitrary.
1603 size = 16384 * sys.StackGuardMultiplier
1605 gp.stack.hi = uintptr(noescape(unsafe.Pointer(&size)))
1606 gp.stack.lo = gp.stack.hi - size + 1024
1608 // Initialize stack guard so that we can start calling regular
1610 gp.stackguard0 = gp.stack.lo + stackGuard
1611 // This is the g0, so we can also call go:systemstack
1612 // functions, which check stackguard1.
1613 gp.stackguard1 = gp.stackguard0
1616 // Exit this thread.
1617 if mStackIsSystemAllocated() {
1618 // Windows, Solaris, illumos, Darwin, AIX and Plan 9 always system-allocate
1619 // the stack, but put it in gp.stack before mstart,
1620 // so the logic above hasn't set osStack yet.
1626 // The go:noinline is to guarantee the getcallerpc/getcallersp below are safe,
1627 // so that we can set up g0.sched to return to the call of mstart1 above.
1634 throw("bad runtime·mstart")
1637 // Set up m.g0.sched as a label returning to just
1638 // after the mstart1 call in mstart0 above, for use by goexit0 and mcall.
1639 // We're never coming back to mstart1 after we call schedule,
1640 // so other calls can reuse the current frame.
1641 // And goexit0 does a gogo that needs to return from mstart1
1642 // and let mstart0 exit the thread.
1643 gp.sched.g = guintptr(unsafe.Pointer(gp))
1644 gp.sched.pc = getcallerpc()
1645 gp.sched.sp = getcallersp()
1650 // Install signal handlers; after minit so that minit can
1651 // prepare the thread to be able to handle the signals.
1656 if fn := gp.m.mstartfn; fn != nil {
1661 acquirep(gp.m.nextp.ptr())
1667 // mstartm0 implements part of mstart1 that only runs on the m0.
1669 // Write barriers are allowed here because we know the GC can't be
1670 // running yet, so they'll be no-ops.
1672 //go:yeswritebarrierrec
1674 // Create an extra M for callbacks on threads not created by Go.
1675 // An extra M is also needed on Windows for callbacks created by
1676 // syscall.NewCallback. See issue #6751 for details.
1677 if (iscgo || GOOS == "windows") && !cgoHasExtraM {
1684 // mPark causes a thread to park itself, returning once woken.
1689 notesleep(&gp.m.park)
1690 noteclear(&gp.m.park)
1693 // mexit tears down and exits the current thread.
1695 // Don't call this directly to exit the thread, since it must run at
1696 // the top of the thread stack. Instead, use gogo(&gp.m.g0.sched) to
1697 // unwind the stack to the point that exits the thread.
1699 // It is entered with m.p != nil, so write barriers are allowed. It
1700 // will release the P before exiting.
1702 //go:yeswritebarrierrec
1703 func mexit(osStack bool) {
1707 // This is the main thread. Just wedge it.
1709 // On Linux, exiting the main thread puts the process
1710 // into a non-waitable zombie state. On Plan 9,
1711 // exiting the main thread unblocks wait even though
1712 // other threads are still running. On Solaris we can
1713 // neither exitThread nor return from mstart. Other
1714 // bad things probably happen on other platforms.
1716 // We could try to clean up this M more before wedging
1717 // it, but that complicates signal handling.
1718 handoffp(releasep())
1724 throw("locked m0 woke up")
1730 // Free the gsignal stack.
1731 if mp.gsignal != nil {
1732 stackfree(mp.gsignal.stack)
1733 // On some platforms, when calling into VDSO (e.g. nanotime)
1734 // we store our g on the gsignal stack, if there is one.
1735 // Now the stack is freed, unlink it from the m, so we
1736 // won't write to it when calling VDSO code.
1740 // Remove m from allm.
1742 for pprev := &allm; *pprev != nil; pprev = &(*pprev).alllink {
1748 throw("m not found in allm")
1750 // Delay reaping m until it's done with the stack.
1752 // Put mp on the free list, though it will not be reaped while freeWait
1753 // is freeMWait. mp is no longer reachable via allm, so even if it is
1754 // on an OS stack, we must keep a reference to mp alive so that the GC
1755 // doesn't free mp while we are still using it.
1757 // Note that the free list must not be linked through alllink because
1758 // some functions walk allm without locking, so may be using alllink.
1759 mp.freeWait.Store(freeMWait)
1760 mp.freelink = sched.freem
1764 atomic.Xadd64(&ncgocall, int64(mp.ncgocall))
1767 handoffp(releasep())
1768 // After this point we must not have write barriers.
1770 // Invoke the deadlock detector. This must happen after
1771 // handoffp because it may have started a new M to take our
1778 if GOOS == "darwin" || GOOS == "ios" {
1779 // Make sure pendingPreemptSignals is correct when an M exits.
1781 if mp.signalPending.Load() != 0 {
1782 pendingPreemptSignals.Add(-1)
1786 // Destroy all allocated resources. After this is called, we may no
1787 // longer take any locks.
1791 // No more uses of mp, so it is safe to drop the reference.
1792 mp.freeWait.Store(freeMRef)
1794 // Return from mstart and let the system thread
1795 // library free the g0 stack and terminate the thread.
1799 // mstart is the thread's entry point, so there's nothing to
1800 // return to. Exit the thread directly. exitThread will clear
1801 // m.freeWait when it's done with the stack and the m can be
1803 exitThread(&mp.freeWait)
1806 // forEachP calls fn(p) for every P p when p reaches a GC safe point.
1807 // If a P is currently executing code, this will bring the P to a GC
1808 // safe point and execute fn on that P. If the P is not executing code
1809 // (it is idle or in a syscall), this will call fn(p) directly while
1810 // preventing the P from exiting its state. This does not ensure that
1811 // fn will run on every CPU executing Go code, but it acts as a global
1812 // memory barrier. GC uses this as a "ragged barrier."
1814 // The caller must hold worldsema.
1817 func forEachP(fn func(*p)) {
1819 pp := getg().m.p.ptr()
1822 if sched.safePointWait != 0 {
1823 throw("forEachP: sched.safePointWait != 0")
1825 sched.safePointWait = gomaxprocs - 1
1826 sched.safePointFn = fn
1828 // Ask all Ps to run the safe point function.
1829 for _, p2 := range allp {
1831 atomic.Store(&p2.runSafePointFn, 1)
1836 // Any P entering _Pidle or _Psyscall from now on will observe
1837 // p.runSafePointFn == 1 and will call runSafePointFn when
1838 // changing its status to _Pidle/_Psyscall.
1840 // Run safe point function for all idle Ps. sched.pidle will
1841 // not change because we hold sched.lock.
1842 for p := sched.pidle.ptr(); p != nil; p = p.link.ptr() {
1843 if atomic.Cas(&p.runSafePointFn, 1, 0) {
1845 sched.safePointWait--
1849 wait := sched.safePointWait > 0
1852 // Run fn for the current P.
1855 // Force Ps currently in _Psyscall into _Pidle and hand them
1856 // off to induce safe point function execution.
1857 for _, p2 := range allp {
1859 if s == _Psyscall && p2.runSafePointFn == 1 && atomic.Cas(&p2.status, s, _Pidle) {
1869 // Wait for remaining Ps to run fn.
1872 // Wait for 100us, then try to re-preempt in
1873 // case of any races.
1875 // Requires system stack.
1876 if notetsleep(&sched.safePointNote, 100*1000) {
1877 noteclear(&sched.safePointNote)
1883 if sched.safePointWait != 0 {
1884 throw("forEachP: not done")
1886 for _, p2 := range allp {
1887 if p2.runSafePointFn != 0 {
1888 throw("forEachP: P did not run fn")
1893 sched.safePointFn = nil
1898 // runSafePointFn runs the safe point function, if any, for this P.
1899 // This should be called like
1901 // if getg().m.p.runSafePointFn != 0 {
1905 // runSafePointFn must be checked on any transition in to _Pidle or
1906 // _Psyscall to avoid a race where forEachP sees that the P is running
1907 // just before the P goes into _Pidle/_Psyscall and neither forEachP
1908 // nor the P run the safe-point function.
1909 func runSafePointFn() {
1910 p := getg().m.p.ptr()
1911 // Resolve the race between forEachP running the safe-point
1912 // function on this P's behalf and this P running the
1913 // safe-point function directly.
1914 if !atomic.Cas(&p.runSafePointFn, 1, 0) {
1917 sched.safePointFn(p)
1919 sched.safePointWait--
1920 if sched.safePointWait == 0 {
1921 notewakeup(&sched.safePointNote)
1926 // When running with cgo, we call _cgo_thread_start
1927 // to start threads for us so that we can play nicely with
1929 var cgoThreadStart unsafe.Pointer
1931 type cgothreadstart struct {
1937 // Allocate a new m unassociated with any thread.
1938 // Can use p for allocation context if needed.
1939 // fn is recorded as the new m's m.mstartfn.
1940 // id is optional pre-allocated m ID. Omit by passing -1.
1942 // This function is allowed to have write barriers even if the caller
1943 // isn't because it borrows pp.
1945 //go:yeswritebarrierrec
1946 func allocm(pp *p, fn func(), id int64) *m {
1949 // The caller owns pp, but we may borrow (i.e., acquirep) it. We must
1950 // disable preemption to ensure it is not stolen, which would make the
1951 // caller lose ownership.
1956 acquirep(pp) // temporarily borrow p for mallocs in this function
1959 // Release the free M list. We need to do this somewhere and
1960 // this may free up a stack we can use.
1961 if sched.freem != nil {
1964 for freem := sched.freem; freem != nil; {
1965 wait := freem.freeWait.Load()
1966 if wait == freeMWait {
1967 next := freem.freelink
1968 freem.freelink = newList
1973 // Free the stack if needed. For freeMRef, there is
1974 // nothing to do except drop freem from the sched.freem
1976 if wait == freeMStack {
1977 // stackfree must be on the system stack, but allocm is
1978 // reachable off the system stack transitively from
1980 systemstack(func() {
1981 stackfree(freem.g0.stack)
1984 freem = freem.freelink
1986 sched.freem = newList
1994 // In case of cgo or Solaris or illumos or Darwin, pthread_create will make us a stack.
1995 // Windows and Plan 9 will layout sched stack on OS stack.
1996 if iscgo || mStackIsSystemAllocated() {
1999 mp.g0 = malg(16384 * sys.StackGuardMultiplier)
2003 if pp == gp.m.p.ptr() {
2008 allocmLock.runlock()
2012 // needm is called when a cgo callback happens on a
2013 // thread without an m (a thread not created by Go).
2014 // In this case, needm is expected to find an m to use
2015 // and return with m, g initialized correctly.
2016 // Since m and g are not set now (likely nil, but see below)
2017 // needm is limited in what routines it can call. In particular
2018 // it can only call nosplit functions (textflag 7) and cannot
2019 // do any scheduling that requires an m.
2021 // In order to avoid needing heavy lifting here, we adopt
2022 // the following strategy: there is a stack of available m's
2023 // that can be stolen. Using compare-and-swap
2024 // to pop from the stack has ABA races, so we simulate
2025 // a lock by doing an exchange (via Casuintptr) to steal the stack
2026 // head and replace the top pointer with MLOCKED (1).
2027 // This serves as a simple spin lock that we can use even
2028 // without an m. The thread that locks the stack in this way
2029 // unlocks the stack by storing a valid stack head pointer.
2031 // In order to make sure that there is always an m structure
2032 // available to be stolen, we maintain the invariant that there
2033 // is always one more than needed. At the beginning of the
2034 // program (if cgo is in use) the list is seeded with a single m.
2035 // If needm finds that it has taken the last m off the list, its job
2036 // is - once it has installed its own m so that it can do things like
2037 // allocate memory - to create a spare m and put it on the list.
2039 // Each of these extra m's also has a g0 and a curg that are
2040 // pressed into service as the scheduling stack and current
2041 // goroutine for the duration of the cgo callback.
2043 // It calls dropm to put the m back on the list,
2044 // 1. when the callback is done with the m in non-pthread platforms,
2045 // 2. or when the C thread exiting on pthread platforms.
2047 // The signal argument indicates whether we're called from a signal
2051 func needm(signal bool) {
2052 if (iscgo || GOOS == "windows") && !cgoHasExtraM {
2053 // Can happen if C/C++ code calls Go from a global ctor.
2054 // Can also happen on Windows if a global ctor uses a
2055 // callback created by syscall.NewCallback. See issue #6751
2058 // Can not throw, because scheduler is not initialized yet.
2059 writeErrStr("fatal error: cgo callback before cgo call\n")
2063 // Save and block signals before getting an M.
2064 // The signal handler may call needm itself,
2065 // and we must avoid a deadlock. Also, once g is installed,
2066 // any incoming signals will try to execute,
2067 // but we won't have the sigaltstack settings and other data
2068 // set up appropriately until the end of minit, which will
2069 // unblock the signals. This is the same dance as when
2070 // starting a new m to run Go code via newosproc.
2075 // getExtraM is safe here because of the invariant above,
2076 // that the extra list always contains or will soon contain
2078 mp, last := getExtraM()
2080 // Set needextram when we've just emptied the list,
2081 // so that the eventual call into cgocallbackg will
2082 // allocate a new m for the extra list. We delay the
2083 // allocation until then so that it can be done
2084 // after exitsyscall makes sure it is okay to be
2085 // running at all (that is, there's no garbage collection
2086 // running right now).
2087 mp.needextram = last
2089 // Store the original signal mask for use by minit.
2090 mp.sigmask = sigmask
2092 // Install TLS on some platforms (previously setg
2093 // would do this if necessary).
2096 // Install g (= m->g0) and set the stack bounds
2097 // to match the current stack.
2100 callbackUpdateSystemStack(mp, sp, signal)
2102 // Should mark we are already in Go now.
2103 // Otherwise, we may call needm again when we get a signal, before cgocallbackg1,
2104 // which means the extram list may be empty, that will cause a deadlock.
2105 mp.isExtraInC = false
2107 // Initialize this thread to use the m.
2111 // mp.curg is now a real goroutine.
2112 casgstatus(mp.curg, _Gdead, _Gsyscall)
2116 // Acquire an extra m and bind it to the C thread when a pthread key has been created.
2119 func needAndBindM() {
2122 if _cgo_pthread_key_created != nil && *(*uintptr)(_cgo_pthread_key_created) != 0 {
2127 // newextram allocates m's and puts them on the extra list.
2128 // It is called with a working local m, so that it can do things
2129 // like call schedlock and allocate.
2131 c := extraMWaiters.Swap(0)
2133 for i := uint32(0); i < c; i++ {
2136 } else if extraMLength.Load() == 0 {
2137 // Make sure there is at least one extra M.
2142 // oneNewExtraM allocates an m and puts it on the extra list.
2143 func oneNewExtraM() {
2144 // Create extra goroutine locked to extra m.
2145 // The goroutine is the context in which the cgo callback will run.
2146 // The sched.pc will never be returned to, but setting it to
2147 // goexit makes clear to the traceback routines where
2148 // the goroutine stack ends.
2149 mp := allocm(nil, nil, -1)
2151 gp.sched.pc = abi.FuncPCABI0(goexit) + sys.PCQuantum
2152 gp.sched.sp = gp.stack.hi
2153 gp.sched.sp -= 4 * goarch.PtrSize // extra space in case of reads slightly beyond frame
2155 gp.sched.g = guintptr(unsafe.Pointer(gp))
2156 gp.syscallpc = gp.sched.pc
2157 gp.syscallsp = gp.sched.sp
2158 gp.stktopsp = gp.sched.sp
2159 // malg returns status as _Gidle. Change to _Gdead before
2160 // adding to allg where GC can see it. We use _Gdead to hide
2161 // this from tracebacks and stack scans since it isn't a
2162 // "real" goroutine until needm grabs it.
2163 casgstatus(gp, _Gidle, _Gdead)
2167 // mark we are in C by default.
2168 mp.isExtraInC = true
2172 gp.goid = sched.goidgen.Add(1)
2174 gp.racectx = racegostart(abi.FuncPCABIInternal(newextram) + sys.PCQuantum)
2177 traceOneNewExtraM(gp)
2179 // put on allg for garbage collector
2182 // gp is now on the allg list, but we don't want it to be
2183 // counted by gcount. It would be more "proper" to increment
2184 // sched.ngfree, but that requires locking. Incrementing ngsys
2185 // has the same effect.
2188 // Add m to the extra list.
2192 // dropm puts the current m back onto the extra list.
2194 // 1. On systems without pthreads, like Windows
2195 // dropm is called when a cgo callback has called needm but is now
2196 // done with the callback and returning back into the non-Go thread.
2198 // The main expense here is the call to signalstack to release the
2199 // m's signal stack, and then the call to needm on the next callback
2200 // from this thread. It is tempting to try to save the m for next time,
2201 // which would eliminate both these costs, but there might not be
2202 // a next time: the current thread (which Go does not control) might exit.
2203 // If we saved the m for that thread, there would be an m leak each time
2204 // such a thread exited. Instead, we acquire and release an m on each
2205 // call. These should typically not be scheduling operations, just a few
2206 // atomics, so the cost should be small.
2208 // 2. On systems with pthreads
2209 // dropm is called while a non-Go thread is exiting.
2210 // We allocate a pthread per-thread variable using pthread_key_create,
2211 // to register a thread-exit-time destructor.
2212 // And store the g into a thread-specific value associated with the pthread key,
2213 // when first return back to C.
2214 // So that the destructor would invoke dropm while the non-Go thread is exiting.
2215 // This is much faster since it avoids expensive signal-related syscalls.
2217 // This always runs without a P, so //go:nowritebarrierrec is required.
2219 // This may run with a different stack than was recorded in g0 (there is no
2220 // call to callbackUpdateSystemStack prior to dropm), so this must be
2221 // //go:nosplit to avoid the stack bounds check.
2223 //go:nowritebarrierrec
2226 // Clear m and g, and return m to the extra list.
2227 // After the call to setg we can only call nosplit functions
2228 // with no pointer manipulation.
2231 // Return mp.curg to dead state.
2232 casgstatus(mp.curg, _Gsyscall, _Gdead)
2233 mp.curg.preemptStop = false
2236 // Block signals before unminit.
2237 // Unminit unregisters the signal handling stack (but needs g on some systems).
2238 // Setg(nil) clears g, which is the signal handler's cue not to run Go handlers.
2239 // It's important not to try to handle a signal between those two steps.
2240 sigmask := mp.sigmask
2246 // Clear g0 stack bounds to ensure that needm always refreshes the
2247 // bounds when reusing this M.
2256 msigrestore(sigmask)
2259 // bindm store the g0 of the current m into a thread-specific value.
2261 // We allocate a pthread per-thread variable using pthread_key_create,
2262 // to register a thread-exit-time destructor.
2263 // We are here setting the thread-specific value of the pthread key, to enable the destructor.
2264 // So that the pthread_key_destructor would dropm while the C thread is exiting.
2266 // And the saved g will be used in pthread_key_destructor,
2267 // since the g stored in the TLS by Go might be cleared in some platforms,
2268 // before the destructor invoked, so, we restore g by the stored g, before dropm.
2270 // We store g0 instead of m, to make the assembly code simpler,
2271 // since we need to restore g0 in runtime.cgocallback.
2273 // On systems without pthreads, like Windows, bindm shouldn't be used.
2275 // NOTE: this always runs without a P, so, nowritebarrierrec required.
2278 //go:nowritebarrierrec
2280 if GOOS == "windows" || GOOS == "plan9" {
2281 fatal("bindm in unexpected GOOS")
2285 fatal("the current g is not g0")
2287 if _cgo_bindm != nil {
2288 asmcgocall(_cgo_bindm, unsafe.Pointer(g))
2292 // A helper function for EnsureDropM.
2293 func getm() uintptr {
2294 return uintptr(unsafe.Pointer(getg().m))
2298 // Locking linked list of extra M's, via mp.schedlink. Must be accessed
2299 // only via lockextra/unlockextra.
2301 // Can't be atomic.Pointer[m] because we use an invalid pointer as a
2302 // "locked" sentinel value. M's on this list remain visible to the GC
2303 // because their mp.curg is on allgs.
2304 extraM atomic.Uintptr
2305 // Number of M's in the extraM list.
2306 extraMLength atomic.Uint32
2307 // Number of waiters in lockextra.
2308 extraMWaiters atomic.Uint32
2310 // Number of extra M's in use by threads.
2311 extraMInUse atomic.Uint32
2314 // lockextra locks the extra list and returns the list head.
2315 // The caller must unlock the list by storing a new list head
2316 // to extram. If nilokay is true, then lockextra will
2317 // return a nil list head if that's what it finds. If nilokay is false,
2318 // lockextra will keep waiting until the list head is no longer nil.
2321 func lockextra(nilokay bool) *m {
2326 old := extraM.Load()
2331 if old == 0 && !nilokay {
2333 // Add 1 to the number of threads
2334 // waiting for an M.
2335 // This is cleared by newextram.
2336 extraMWaiters.Add(1)
2342 if extraM.CompareAndSwap(old, locked) {
2343 return (*m)(unsafe.Pointer(old))
2351 func unlockextra(mp *m, delta int32) {
2352 extraMLength.Add(delta)
2353 extraM.Store(uintptr(unsafe.Pointer(mp)))
2356 // Return an M from the extra M list. Returns last == true if the list becomes
2357 // empty because of this call.
2359 // Spins waiting for an extra M, so caller must ensure that the list always
2360 // contains or will soon contain at least one M.
2363 func getExtraM() (mp *m, last bool) {
2364 mp = lockextra(false)
2366 unlockextra(mp.schedlink.ptr(), -1)
2367 return mp, mp.schedlink.ptr() == nil
2370 // Returns an extra M back to the list. mp must be from getExtraM. Newly
2371 // allocated M's should use addExtraM.
2374 func putExtraM(mp *m) {
2379 // Adds a newly allocated M to the extra M list.
2382 func addExtraM(mp *m) {
2383 mnext := lockextra(true)
2384 mp.schedlink.set(mnext)
2389 // allocmLock is locked for read when creating new Ms in allocm and their
2390 // addition to allm. Thus acquiring this lock for write blocks the
2391 // creation of new Ms.
2394 // execLock serializes exec and clone to avoid bugs or unspecified
2395 // behaviour around exec'ing while creating/destroying threads. See
2400 // These errors are reported (via writeErrStr) by some OS-specific
2401 // versions of newosproc and newosproc0.
2403 failthreadcreate = "runtime: failed to create new OS thread\n"
2404 failallocatestack = "runtime: failed to allocate stack for the new OS thread\n"
2407 // newmHandoff contains a list of m structures that need new OS threads.
2408 // This is used by newm in situations where newm itself can't safely
2409 // start an OS thread.
2410 var newmHandoff struct {
2413 // newm points to a list of M structures that need new OS
2414 // threads. The list is linked through m.schedlink.
2417 // waiting indicates that wake needs to be notified when an m
2418 // is put on the list.
2422 // haveTemplateThread indicates that the templateThread has
2423 // been started. This is not protected by lock. Use cas to set
2425 haveTemplateThread uint32
2428 // Create a new m. It will start off with a call to fn, or else the scheduler.
2429 // fn needs to be static and not a heap allocated closure.
2430 // May run with m.p==nil, so write barriers are not allowed.
2432 // id is optional pre-allocated m ID. Omit by passing -1.
2434 //go:nowritebarrierrec
2435 func newm(fn func(), pp *p, id int64) {
2436 // allocm adds a new M to allm, but they do not start until created by
2437 // the OS in newm1 or the template thread.
2439 // doAllThreadsSyscall requires that every M in allm will eventually
2440 // start and be signal-able, even with a STW.
2442 // Disable preemption here until we start the thread to ensure that
2443 // newm is not preempted between allocm and starting the new thread,
2444 // ensuring that anything added to allm is guaranteed to eventually
2448 mp := allocm(pp, fn, id)
2450 mp.sigmask = initSigmask
2451 if gp := getg(); gp != nil && gp.m != nil && (gp.m.lockedExt != 0 || gp.m.incgo) && GOOS != "plan9" {
2452 // We're on a locked M or a thread that may have been
2453 // started by C. The kernel state of this thread may
2454 // be strange (the user may have locked it for that
2455 // purpose). We don't want to clone that into another
2456 // thread. Instead, ask a known-good thread to create
2457 // the thread for us.
2459 // This is disabled on Plan 9. See golang.org/issue/22227.
2461 // TODO: This may be unnecessary on Windows, which
2462 // doesn't model thread creation off fork.
2463 lock(&newmHandoff.lock)
2464 if newmHandoff.haveTemplateThread == 0 {
2465 throw("on a locked thread with no template thread")
2467 mp.schedlink = newmHandoff.newm
2468 newmHandoff.newm.set(mp)
2469 if newmHandoff.waiting {
2470 newmHandoff.waiting = false
2471 notewakeup(&newmHandoff.wake)
2473 unlock(&newmHandoff.lock)
2474 // The M has not started yet, but the template thread does not
2475 // participate in STW, so it will always process queued Ms and
2476 // it is safe to releasem.
2486 var ts cgothreadstart
2487 if _cgo_thread_start == nil {
2488 throw("_cgo_thread_start missing")
2491 ts.tls = (*uint64)(unsafe.Pointer(&mp.tls[0]))
2492 ts.fn = unsafe.Pointer(abi.FuncPCABI0(mstart))
2494 msanwrite(unsafe.Pointer(&ts), unsafe.Sizeof(ts))
2497 asanwrite(unsafe.Pointer(&ts), unsafe.Sizeof(ts))
2499 execLock.rlock() // Prevent process clone.
2500 asmcgocall(_cgo_thread_start, unsafe.Pointer(&ts))
2504 execLock.rlock() // Prevent process clone.
2509 // startTemplateThread starts the template thread if it is not already
2512 // The calling thread must itself be in a known-good state.
2513 func startTemplateThread() {
2514 if GOARCH == "wasm" { // no threads on wasm yet
2518 // Disable preemption to guarantee that the template thread will be
2519 // created before a park once haveTemplateThread is set.
2521 if !atomic.Cas(&newmHandoff.haveTemplateThread, 0, 1) {
2525 newm(templateThread, nil, -1)
2529 // templateThread is a thread in a known-good state that exists solely
2530 // to start new threads in known-good states when the calling thread
2531 // may not be in a good state.
2533 // Many programs never need this, so templateThread is started lazily
2534 // when we first enter a state that might lead to running on a thread
2535 // in an unknown state.
2537 // templateThread runs on an M without a P, so it must not have write
2540 //go:nowritebarrierrec
2541 func templateThread() {
2548 lock(&newmHandoff.lock)
2549 for newmHandoff.newm != 0 {
2550 newm := newmHandoff.newm.ptr()
2551 newmHandoff.newm = 0
2552 unlock(&newmHandoff.lock)
2554 next := newm.schedlink.ptr()
2559 lock(&newmHandoff.lock)
2561 newmHandoff.waiting = true
2562 noteclear(&newmHandoff.wake)
2563 unlock(&newmHandoff.lock)
2564 notesleep(&newmHandoff.wake)
2568 // Stops execution of the current m until new work is available.
2569 // Returns with acquired P.
2573 if gp.m.locks != 0 {
2574 throw("stopm holding locks")
2577 throw("stopm holding p")
2580 throw("stopm spinning")
2587 acquirep(gp.m.nextp.ptr())
2592 // startm's caller incremented nmspinning. Set the new M's spinning.
2593 getg().m.spinning = true
2596 // Schedules some M to run the p (creates an M if necessary).
2597 // If p==nil, tries to get an idle P, if no idle P's does nothing.
2598 // May run with m.p==nil, so write barriers are not allowed.
2599 // If spinning is set, the caller has incremented nmspinning and must provide a
2600 // P. startm will set m.spinning in the newly started M.
2602 // Callers passing a non-nil P must call from a non-preemptible context. See
2603 // comment on acquirem below.
2605 // Argument lockheld indicates whether the caller already acquired the
2606 // scheduler lock. Callers holding the lock when making the call must pass
2607 // true. The lock might be temporarily dropped, but will be reacquired before
2610 // Must not have write barriers because this may be called without a P.
2612 //go:nowritebarrierrec
2613 func startm(pp *p, spinning, lockheld bool) {
2614 // Disable preemption.
2616 // Every owned P must have an owner that will eventually stop it in the
2617 // event of a GC stop request. startm takes transient ownership of a P
2618 // (either from argument or pidleget below) and transfers ownership to
2619 // a started M, which will be responsible for performing the stop.
2621 // Preemption must be disabled during this transient ownership,
2622 // otherwise the P this is running on may enter GC stop while still
2623 // holding the transient P, leaving that P in limbo and deadlocking the
2626 // Callers passing a non-nil P must already be in non-preemptible
2627 // context, otherwise such preemption could occur on function entry to
2628 // startm. Callers passing a nil P may be preemptible, so we must
2629 // disable preemption before acquiring a P from pidleget below.
2636 // TODO(prattmic): All remaining calls to this function
2637 // with _p_ == nil could be cleaned up to find a P
2638 // before calling startm.
2639 throw("startm: P required for spinning=true")
2652 // No M is available, we must drop sched.lock and call newm.
2653 // However, we already own a P to assign to the M.
2655 // Once sched.lock is released, another G (e.g., in a syscall),
2656 // could find no idle P while checkdead finds a runnable G but
2657 // no running M's because this new M hasn't started yet, thus
2658 // throwing in an apparent deadlock.
2659 // This apparent deadlock is possible when startm is called
2660 // from sysmon, which doesn't count as a running M.
2662 // Avoid this situation by pre-allocating the ID for the new M,
2663 // thus marking it as 'running' before we drop sched.lock. This
2664 // new M will eventually run the scheduler to execute any
2671 // The caller incremented nmspinning, so set m.spinning in the new M.
2679 // Ownership transfer of pp committed by start in newm.
2680 // Preemption is now safe.
2688 throw("startm: m is spinning")
2691 throw("startm: m has p")
2693 if spinning && !runqempty(pp) {
2694 throw("startm: p has runnable gs")
2696 // The caller incremented nmspinning, so set m.spinning in the new M.
2697 nmp.spinning = spinning
2699 notewakeup(&nmp.park)
2700 // Ownership transfer of pp committed by wakeup. Preemption is now
2705 // Hands off P from syscall or locked M.
2706 // Always runs without a P, so write barriers are not allowed.
2708 //go:nowritebarrierrec
2709 func handoffp(pp *p) {
2710 // handoffp must start an M in any situation where
2711 // findrunnable would return a G to run on pp.
2713 // if it has local work, start it straight away
2714 if !runqempty(pp) || sched.runqsize != 0 {
2715 startm(pp, false, false)
2718 // if there's trace work to do, start it straight away
2719 if (traceEnabled() || traceShuttingDown()) && traceReaderAvailable() != nil {
2720 startm(pp, false, false)
2723 // if it has GC work, start it straight away
2724 if gcBlackenEnabled != 0 && gcMarkWorkAvailable(pp) {
2725 startm(pp, false, false)
2728 // no local work, check that there are no spinning/idle M's,
2729 // otherwise our help is not required
2730 if sched.nmspinning.Load()+sched.npidle.Load() == 0 && sched.nmspinning.CompareAndSwap(0, 1) { // TODO: fast atomic
2731 sched.needspinning.Store(0)
2732 startm(pp, true, false)
2736 if sched.gcwaiting.Load() {
2737 pp.status = _Pgcstop
2739 if sched.stopwait == 0 {
2740 notewakeup(&sched.stopnote)
2745 if pp.runSafePointFn != 0 && atomic.Cas(&pp.runSafePointFn, 1, 0) {
2746 sched.safePointFn(pp)
2747 sched.safePointWait--
2748 if sched.safePointWait == 0 {
2749 notewakeup(&sched.safePointNote)
2752 if sched.runqsize != 0 {
2754 startm(pp, false, false)
2757 // If this is the last running P and nobody is polling network,
2758 // need to wakeup another M to poll network.
2759 if sched.npidle.Load() == gomaxprocs-1 && sched.lastpoll.Load() != 0 {
2761 startm(pp, false, false)
2765 // The scheduler lock cannot be held when calling wakeNetPoller below
2766 // because wakeNetPoller may call wakep which may call startm.
2767 when := nobarrierWakeTime(pp)
2776 // Tries to add one more P to execute G's.
2777 // Called when a G is made runnable (newproc, ready).
2778 // Must be called with a P.
2780 // Be conservative about spinning threads, only start one if none exist
2782 if sched.nmspinning.Load() != 0 || !sched.nmspinning.CompareAndSwap(0, 1) {
2786 // Disable preemption until ownership of pp transfers to the next M in
2787 // startm. Otherwise preemption here would leave pp stuck waiting to
2790 // See preemption comment on acquirem in startm for more details.
2795 pp, _ = pidlegetSpinning(0)
2797 if sched.nmspinning.Add(-1) < 0 {
2798 throw("wakep: negative nmspinning")
2804 // Since we always have a P, the race in the "No M is available"
2805 // comment in startm doesn't apply during the small window between the
2806 // unlock here and lock in startm. A checkdead in between will always
2807 // see at least one running M (ours).
2810 startm(pp, true, false)
2815 // Stops execution of the current m that is locked to a g until the g is runnable again.
2816 // Returns with acquired P.
2817 func stoplockedm() {
2820 if gp.m.lockedg == 0 || gp.m.lockedg.ptr().lockedm.ptr() != gp.m {
2821 throw("stoplockedm: inconsistent locking")
2824 // Schedule another M to run this p.
2829 // Wait until another thread schedules lockedg again.
2831 status := readgstatus(gp.m.lockedg.ptr())
2832 if status&^_Gscan != _Grunnable {
2833 print("runtime:stoplockedm: lockedg (atomicstatus=", status, ") is not Grunnable or Gscanrunnable\n")
2834 dumpgstatus(gp.m.lockedg.ptr())
2835 throw("stoplockedm: not runnable")
2837 acquirep(gp.m.nextp.ptr())
2841 // Schedules the locked m to run the locked gp.
2842 // May run during STW, so write barriers are not allowed.
2844 //go:nowritebarrierrec
2845 func startlockedm(gp *g) {
2846 mp := gp.lockedm.ptr()
2848 throw("startlockedm: locked to me")
2851 throw("startlockedm: m has p")
2853 // directly handoff current P to the locked m
2857 notewakeup(&mp.park)
2861 // Stops the current m for stopTheWorld.
2862 // Returns when the world is restarted.
2866 if !sched.gcwaiting.Load() {
2867 throw("gcstopm: not waiting for gc")
2870 gp.m.spinning = false
2871 // OK to just drop nmspinning here,
2872 // startTheWorld will unpark threads as necessary.
2873 if sched.nmspinning.Add(-1) < 0 {
2874 throw("gcstopm: negative nmspinning")
2879 pp.status = _Pgcstop
2881 if sched.stopwait == 0 {
2882 notewakeup(&sched.stopnote)
2888 // Schedules gp to run on the current M.
2889 // If inheritTime is true, gp inherits the remaining time in the
2890 // current time slice. Otherwise, it starts a new time slice.
2893 // Write barriers are allowed because this is called immediately after
2894 // acquiring a P in several places.
2896 //go:yeswritebarrierrec
2897 func execute(gp *g, inheritTime bool) {
2900 if goroutineProfile.active {
2901 // Make sure that gp has had its stack written out to the goroutine
2902 // profile, exactly as it was when the goroutine profiler first stopped
2904 tryRecordGoroutineProfile(gp, osyield)
2907 // Assign gp.m before entering _Grunning so running Gs have an
2911 casgstatus(gp, _Grunnable, _Grunning)
2914 gp.stackguard0 = gp.stack.lo + stackGuard
2916 mp.p.ptr().schedtick++
2919 // Check whether the profiler needs to be turned on or off.
2920 hz := sched.profilehz
2921 if mp.profilehz != hz {
2922 setThreadCPUProfiler(hz)
2926 // GoSysExit has to happen when we have a P, but before GoStart.
2927 // So we emit it here.
2928 if gp.syscallsp != 0 {
2937 // Finds a runnable goroutine to execute.
2938 // Tries to steal from other P's, get g from local or global queue, poll network.
2939 // tryWakeP indicates that the returned goroutine is not normal (GC worker, trace
2940 // reader) so the caller should try to wake a P.
2941 func findRunnable() (gp *g, inheritTime, tryWakeP bool) {
2944 // The conditions here and in handoffp must agree: if
2945 // findrunnable would return a G to run, handoffp must start
2950 if sched.gcwaiting.Load() {
2954 if pp.runSafePointFn != 0 {
2958 // now and pollUntil are saved for work stealing later,
2959 // which may steal timers. It's important that between now
2960 // and then, nothing blocks, so these numbers remain mostly
2962 now, pollUntil, _ := checkTimers(pp, 0)
2964 // Try to schedule the trace reader.
2965 if traceEnabled() || traceShuttingDown() {
2968 casgstatus(gp, _Gwaiting, _Grunnable)
2969 traceGoUnpark(gp, 0)
2970 return gp, false, true
2974 // Try to schedule a GC worker.
2975 if gcBlackenEnabled != 0 {
2976 gp, tnow := gcController.findRunnableGCWorker(pp, now)
2978 return gp, false, true
2983 // Check the global runnable queue once in a while to ensure fairness.
2984 // Otherwise two goroutines can completely occupy the local runqueue
2985 // by constantly respawning each other.
2986 if pp.schedtick%61 == 0 && sched.runqsize > 0 {
2988 gp := globrunqget(pp, 1)
2991 return gp, false, false
2995 // Wake up the finalizer G.
2996 if fingStatus.Load()&(fingWait|fingWake) == fingWait|fingWake {
2997 if gp := wakefing(); gp != nil {
3001 if *cgo_yield != nil {
3002 asmcgocall(*cgo_yield, nil)
3006 if gp, inheritTime := runqget(pp); gp != nil {
3007 return gp, inheritTime, false
3011 if sched.runqsize != 0 {
3013 gp := globrunqget(pp, 0)
3016 return gp, false, false
3021 // This netpoll is only an optimization before we resort to stealing.
3022 // We can safely skip it if there are no waiters or a thread is blocked
3023 // in netpoll already. If there is any kind of logical race with that
3024 // blocked thread (e.g. it has already returned from netpoll, but does
3025 // not set lastpoll yet), this thread will do blocking netpoll below
3027 if netpollinited() && netpollAnyWaiters() && sched.lastpoll.Load() != 0 {
3028 if list, delta := netpoll(0); !list.empty() { // non-blocking
3031 netpollAdjustWaiters(delta)
3032 casgstatus(gp, _Gwaiting, _Grunnable)
3034 traceGoUnpark(gp, 0)
3036 return gp, false, false
3040 // Spinning Ms: steal work from other Ps.
3042 // Limit the number of spinning Ms to half the number of busy Ps.
3043 // This is necessary to prevent excessive CPU consumption when
3044 // GOMAXPROCS>>1 but the program parallelism is low.
3045 if mp.spinning || 2*sched.nmspinning.Load() < gomaxprocs-sched.npidle.Load() {
3050 gp, inheritTime, tnow, w, newWork := stealWork(now)
3052 // Successfully stole.
3053 return gp, inheritTime, false
3056 // There may be new timer or GC work; restart to
3062 if w != 0 && (pollUntil == 0 || w < pollUntil) {
3063 // Earlier timer to wait for.
3068 // We have nothing to do.
3070 // If we're in the GC mark phase, can safely scan and blacken objects,
3071 // and have work to do, run idle-time marking rather than give up the P.
3072 if gcBlackenEnabled != 0 && gcMarkWorkAvailable(pp) && gcController.addIdleMarkWorker() {
3073 node := (*gcBgMarkWorkerNode)(gcBgMarkWorkerPool.pop())
3075 pp.gcMarkWorkerMode = gcMarkWorkerIdleMode
3077 casgstatus(gp, _Gwaiting, _Grunnable)
3079 traceGoUnpark(gp, 0)
3081 return gp, false, false
3083 gcController.removeIdleMarkWorker()
3087 // If a callback returned and no other goroutine is awake,
3088 // then wake event handler goroutine which pauses execution
3089 // until a callback was triggered.
3090 gp, otherReady := beforeIdle(now, pollUntil)
3092 casgstatus(gp, _Gwaiting, _Grunnable)
3094 traceGoUnpark(gp, 0)
3096 return gp, false, false
3102 // Before we drop our P, make a snapshot of the allp slice,
3103 // which can change underfoot once we no longer block
3104 // safe-points. We don't need to snapshot the contents because
3105 // everything up to cap(allp) is immutable.
3106 allpSnapshot := allp
3107 // Also snapshot masks. Value changes are OK, but we can't allow
3108 // len to change out from under us.
3109 idlepMaskSnapshot := idlepMask
3110 timerpMaskSnapshot := timerpMask
3112 // return P and block
3114 if sched.gcwaiting.Load() || pp.runSafePointFn != 0 {
3118 if sched.runqsize != 0 {
3119 gp := globrunqget(pp, 0)
3121 return gp, false, false
3123 if !mp.spinning && sched.needspinning.Load() == 1 {
3124 // See "Delicate dance" comment below.
3129 if releasep() != pp {
3130 throw("findrunnable: wrong p")
3132 now = pidleput(pp, now)
3135 // Delicate dance: thread transitions from spinning to non-spinning
3136 // state, potentially concurrently with submission of new work. We must
3137 // drop nmspinning first and then check all sources again (with
3138 // #StoreLoad memory barrier in between). If we do it the other way
3139 // around, another thread can submit work after we've checked all
3140 // sources but before we drop nmspinning; as a result nobody will
3141 // unpark a thread to run the work.
3143 // This applies to the following sources of work:
3145 // * Goroutines added to the global or a per-P run queue.
3146 // * New/modified-earlier timers on a per-P timer heap.
3147 // * Idle-priority GC work (barring golang.org/issue/19112).
3149 // If we discover new work below, we need to restore m.spinning as a
3150 // signal for resetspinning to unpark a new worker thread (because
3151 // there can be more than one starving goroutine).
3153 // However, if after discovering new work we also observe no idle Ps
3154 // (either here or in resetspinning), we have a problem. We may be
3155 // racing with a non-spinning M in the block above, having found no
3156 // work and preparing to release its P and park. Allowing that P to go
3157 // idle will result in loss of work conservation (idle P while there is
3158 // runnable work). This could result in complete deadlock in the
3159 // unlikely event that we discover new work (from netpoll) right as we
3160 // are racing with _all_ other Ps going idle.
3162 // We use sched.needspinning to synchronize with non-spinning Ms going
3163 // idle. If needspinning is set when they are about to drop their P,
3164 // they abort the drop and instead become a new spinning M on our
3165 // behalf. If we are not racing and the system is truly fully loaded
3166 // then no spinning threads are required, and the next thread to
3167 // naturally become spinning will clear the flag.
3169 // Also see "Worker thread parking/unparking" comment at the top of the
3171 wasSpinning := mp.spinning
3174 if sched.nmspinning.Add(-1) < 0 {
3175 throw("findrunnable: negative nmspinning")
3178 // Note the for correctness, only the last M transitioning from
3179 // spinning to non-spinning must perform these rechecks to
3180 // ensure no missed work. However, the runtime has some cases
3181 // of transient increments of nmspinning that are decremented
3182 // without going through this path, so we must be conservative
3183 // and perform the check on all spinning Ms.
3185 // See https://go.dev/issue/43997.
3187 // Check global and P runqueues again.
3190 if sched.runqsize != 0 {
3191 pp, _ := pidlegetSpinning(0)
3193 gp := globrunqget(pp, 0)
3195 throw("global runq empty with non-zero runqsize")
3200 return gp, false, false
3205 pp := checkRunqsNoP(allpSnapshot, idlepMaskSnapshot)
3212 // Check for idle-priority GC work again.
3213 pp, gp := checkIdleGCNoP()
3218 // Run the idle worker.
3219 pp.gcMarkWorkerMode = gcMarkWorkerIdleMode
3220 casgstatus(gp, _Gwaiting, _Grunnable)
3222 traceGoUnpark(gp, 0)
3224 return gp, false, false
3227 // Finally, check for timer creation or expiry concurrently with
3228 // transitioning from spinning to non-spinning.
3230 // Note that we cannot use checkTimers here because it calls
3231 // adjusttimers which may need to allocate memory, and that isn't
3232 // allowed when we don't have an active P.
3233 pollUntil = checkTimersNoP(allpSnapshot, timerpMaskSnapshot, pollUntil)
3236 // Poll network until next timer.
3237 if netpollinited() && (netpollAnyWaiters() || pollUntil != 0) && sched.lastpoll.Swap(0) != 0 {
3238 sched.pollUntil.Store(pollUntil)
3240 throw("findrunnable: netpoll with p")
3243 throw("findrunnable: netpoll with spinning")
3250 delay = pollUntil - now
3256 // When using fake time, just poll.
3259 list, delta := netpoll(delay) // block until new work is available
3260 // Refresh now again, after potentially blocking.
3262 sched.pollUntil.Store(0)
3263 sched.lastpoll.Store(now)
3264 if faketime != 0 && list.empty() {
3265 // Using fake time and nothing is ready; stop M.
3266 // When all M's stop, checkdead will call timejump.
3271 pp, _ := pidleget(now)
3275 netpollAdjustWaiters(delta)
3281 netpollAdjustWaiters(delta)
3282 casgstatus(gp, _Gwaiting, _Grunnable)
3284 traceGoUnpark(gp, 0)
3286 return gp, false, false
3293 } else if pollUntil != 0 && netpollinited() {
3294 pollerPollUntil := sched.pollUntil.Load()
3295 if pollerPollUntil == 0 || pollerPollUntil > pollUntil {
3303 // pollWork reports whether there is non-background work this P could
3304 // be doing. This is a fairly lightweight check to be used for
3305 // background work loops, like idle GC. It checks a subset of the
3306 // conditions checked by the actual scheduler.
3307 func pollWork() bool {
3308 if sched.runqsize != 0 {
3311 p := getg().m.p.ptr()
3315 if netpollinited() && netpollAnyWaiters() && sched.lastpoll.Load() != 0 {
3316 if list, delta := netpoll(0); !list.empty() {
3318 netpollAdjustWaiters(delta)
3325 // stealWork attempts to steal a runnable goroutine or timer from any P.
3327 // If newWork is true, new work may have been readied.
3329 // If now is not 0 it is the current time. stealWork returns the passed time or
3330 // the current time if now was passed as 0.
3331 func stealWork(now int64) (gp *g, inheritTime bool, rnow, pollUntil int64, newWork bool) {
3332 pp := getg().m.p.ptr()
3336 const stealTries = 4
3337 for i := 0; i < stealTries; i++ {
3338 stealTimersOrRunNextG := i == stealTries-1
3340 for enum := stealOrder.start(fastrand()); !enum.done(); enum.next() {
3341 if sched.gcwaiting.Load() {
3342 // GC work may be available.
3343 return nil, false, now, pollUntil, true
3345 p2 := allp[enum.position()]
3350 // Steal timers from p2. This call to checkTimers is the only place
3351 // where we might hold a lock on a different P's timers. We do this
3352 // once on the last pass before checking runnext because stealing
3353 // from the other P's runnext should be the last resort, so if there
3354 // are timers to steal do that first.
3356 // We only check timers on one of the stealing iterations because
3357 // the time stored in now doesn't change in this loop and checking
3358 // the timers for each P more than once with the same value of now
3359 // is probably a waste of time.
3361 // timerpMask tells us whether the P may have timers at all. If it
3362 // can't, no need to check at all.
3363 if stealTimersOrRunNextG && timerpMask.read(enum.position()) {
3364 tnow, w, ran := checkTimers(p2, now)
3366 if w != 0 && (pollUntil == 0 || w < pollUntil) {
3370 // Running the timers may have
3371 // made an arbitrary number of G's
3372 // ready and added them to this P's
3373 // local run queue. That invalidates
3374 // the assumption of runqsteal
3375 // that it always has room to add
3376 // stolen G's. So check now if there
3377 // is a local G to run.
3378 if gp, inheritTime := runqget(pp); gp != nil {
3379 return gp, inheritTime, now, pollUntil, ranTimer
3385 // Don't bother to attempt to steal if p2 is idle.
3386 if !idlepMask.read(enum.position()) {
3387 if gp := runqsteal(pp, p2, stealTimersOrRunNextG); gp != nil {
3388 return gp, false, now, pollUntil, ranTimer
3394 // No goroutines found to steal. Regardless, running a timer may have
3395 // made some goroutine ready that we missed. Indicate the next timer to
3397 return nil, false, now, pollUntil, ranTimer
3400 // Check all Ps for a runnable G to steal.
3402 // On entry we have no P. If a G is available to steal and a P is available,
3403 // the P is returned which the caller should acquire and attempt to steal the
3405 func checkRunqsNoP(allpSnapshot []*p, idlepMaskSnapshot pMask) *p {
3406 for id, p2 := range allpSnapshot {
3407 if !idlepMaskSnapshot.read(uint32(id)) && !runqempty(p2) {
3409 pp, _ := pidlegetSpinning(0)
3411 // Can't get a P, don't bother checking remaining Ps.
3420 // No work available.
3424 // Check all Ps for a timer expiring sooner than pollUntil.
3426 // Returns updated pollUntil value.
3427 func checkTimersNoP(allpSnapshot []*p, timerpMaskSnapshot pMask, pollUntil int64) int64 {
3428 for id, p2 := range allpSnapshot {
3429 if timerpMaskSnapshot.read(uint32(id)) {
3430 w := nobarrierWakeTime(p2)
3431 if w != 0 && (pollUntil == 0 || w < pollUntil) {
3440 // Check for idle-priority GC, without a P on entry.
3442 // If some GC work, a P, and a worker G are all available, the P and G will be
3443 // returned. The returned P has not been wired yet.
3444 func checkIdleGCNoP() (*p, *g) {
3445 // N.B. Since we have no P, gcBlackenEnabled may change at any time; we
3446 // must check again after acquiring a P. As an optimization, we also check
3447 // if an idle mark worker is needed at all. This is OK here, because if we
3448 // observe that one isn't needed, at least one is currently running. Even if
3449 // it stops running, its own journey into the scheduler should schedule it
3450 // again, if need be (at which point, this check will pass, if relevant).
3451 if atomic.Load(&gcBlackenEnabled) == 0 || !gcController.needIdleMarkWorker() {
3454 if !gcMarkWorkAvailable(nil) {
3458 // Work is available; we can start an idle GC worker only if there is
3459 // an available P and available worker G.
3461 // We can attempt to acquire these in either order, though both have
3462 // synchronization concerns (see below). Workers are almost always
3463 // available (see comment in findRunnableGCWorker for the one case
3464 // there may be none). Since we're slightly less likely to find a P,
3465 // check for that first.
3467 // Synchronization: note that we must hold sched.lock until we are
3468 // committed to keeping it. Otherwise we cannot put the unnecessary P
3469 // back in sched.pidle without performing the full set of idle
3470 // transition checks.
3472 // If we were to check gcBgMarkWorkerPool first, we must somehow handle
3473 // the assumption in gcControllerState.findRunnableGCWorker that an
3474 // empty gcBgMarkWorkerPool is only possible if gcMarkDone is running.
3476 pp, now := pidlegetSpinning(0)
3482 // Now that we own a P, gcBlackenEnabled can't change (as it requires STW).
3483 if gcBlackenEnabled == 0 || !gcController.addIdleMarkWorker() {
3489 node := (*gcBgMarkWorkerNode)(gcBgMarkWorkerPool.pop())
3493 gcController.removeIdleMarkWorker()
3499 return pp, node.gp.ptr()
3502 // wakeNetPoller wakes up the thread sleeping in the network poller if it isn't
3503 // going to wake up before the when argument; or it wakes an idle P to service
3504 // timers and the network poller if there isn't one already.
3505 func wakeNetPoller(when int64) {
3506 if sched.lastpoll.Load() == 0 {
3507 // In findrunnable we ensure that when polling the pollUntil
3508 // field is either zero or the time to which the current
3509 // poll is expected to run. This can have a spurious wakeup
3510 // but should never miss a wakeup.
3511 pollerPollUntil := sched.pollUntil.Load()
3512 if pollerPollUntil == 0 || pollerPollUntil > when {
3516 // There are no threads in the network poller, try to get
3517 // one there so it can handle new timers.
3518 if GOOS != "plan9" { // Temporary workaround - see issue #42303.
3524 func resetspinning() {
3527 throw("resetspinning: not a spinning m")
3529 gp.m.spinning = false
3530 nmspinning := sched.nmspinning.Add(-1)
3532 throw("findrunnable: negative nmspinning")
3534 // M wakeup policy is deliberately somewhat conservative, so check if we
3535 // need to wakeup another P here. See "Worker thread parking/unparking"
3536 // comment at the top of the file for details.
3540 // injectglist adds each runnable G on the list to some run queue,
3541 // and clears glist. If there is no current P, they are added to the
3542 // global queue, and up to npidle M's are started to run them.
3543 // Otherwise, for each idle P, this adds a G to the global queue
3544 // and starts an M. Any remaining G's are added to the current P's
3546 // This may temporarily acquire sched.lock.
3547 // Can run concurrently with GC.
3548 func injectglist(glist *gList) {
3553 for gp := glist.head.ptr(); gp != nil; gp = gp.schedlink.ptr() {
3554 traceGoUnpark(gp, 0)
3558 // Mark all the goroutines as runnable before we put them
3559 // on the run queues.
3560 head := glist.head.ptr()
3563 for gp := head; gp != nil; gp = gp.schedlink.ptr() {
3566 casgstatus(gp, _Gwaiting, _Grunnable)
3569 // Turn the gList into a gQueue.
3575 startIdle := func(n int) {
3576 for i := 0; i < n; i++ {
3577 mp := acquirem() // See comment in startm.
3580 pp, _ := pidlegetSpinning(0)
3587 startm(pp, false, true)
3593 pp := getg().m.p.ptr()
3596 globrunqputbatch(&q, int32(qsize))
3602 npidle := int(sched.npidle.Load())
3605 for n = 0; n < npidle && !q.empty(); n++ {
3611 globrunqputbatch(&globq, int32(n))
3618 runqputbatch(pp, &q, qsize)
3622 // One round of scheduler: find a runnable goroutine and execute it.
3628 throw("schedule: holding locks")
3631 if mp.lockedg != 0 {
3633 execute(mp.lockedg.ptr(), false) // Never returns.
3636 // We should not schedule away from a g that is executing a cgo call,
3637 // since the cgo call is using the m's g0 stack.
3639 throw("schedule: in cgo")
3646 // Safety check: if we are spinning, the run queue should be empty.
3647 // Check this before calling checkTimers, as that might call
3648 // goready to put a ready goroutine on the local run queue.
3649 if mp.spinning && (pp.runnext != 0 || pp.runqhead != pp.runqtail) {
3650 throw("schedule: spinning with local work")
3653 gp, inheritTime, tryWakeP := findRunnable() // blocks until work is available
3655 if debug.dontfreezetheworld > 0 && freezing.Load() {
3656 // See comment in freezetheworld. We don't want to perturb
3657 // scheduler state, so we didn't gcstopm in findRunnable, but
3658 // also don't want to allow new goroutines to run.
3660 // Deadlock here rather than in the findRunnable loop so if
3661 // findRunnable is stuck in a loop we don't perturb that
3667 // This thread is going to run a goroutine and is not spinning anymore,
3668 // so if it was marked as spinning we need to reset it now and potentially
3669 // start a new spinning M.
3674 if sched.disable.user && !schedEnabled(gp) {
3675 // Scheduling of this goroutine is disabled. Put it on
3676 // the list of pending runnable goroutines for when we
3677 // re-enable user scheduling and look again.
3679 if schedEnabled(gp) {
3680 // Something re-enabled scheduling while we
3681 // were acquiring the lock.
3684 sched.disable.runnable.pushBack(gp)
3691 // If about to schedule a not-normal goroutine (a GCworker or tracereader),
3692 // wake a P if there is one.
3696 if gp.lockedm != 0 {
3697 // Hands off own p to the locked m,
3698 // then blocks waiting for a new p.
3703 execute(gp, inheritTime)
3706 // dropg removes the association between m and the current goroutine m->curg (gp for short).
3707 // Typically a caller sets gp's status away from Grunning and then
3708 // immediately calls dropg to finish the job. The caller is also responsible
3709 // for arranging that gp will be restarted using ready at an
3710 // appropriate time. After calling dropg and arranging for gp to be
3711 // readied later, the caller can do other work but eventually should
3712 // call schedule to restart the scheduling of goroutines on this m.
3716 setMNoWB(&gp.m.curg.m, nil)
3717 setGNoWB(&gp.m.curg, nil)
3720 // checkTimers runs any timers for the P that are ready.
3721 // If now is not 0 it is the current time.
3722 // It returns the passed time or the current time if now was passed as 0.
3723 // and the time when the next timer should run or 0 if there is no next timer,
3724 // and reports whether it ran any timers.
3725 // If the time when the next timer should run is not 0,
3726 // it is always larger than the returned time.
3727 // We pass now in and out to avoid extra calls of nanotime.
3729 //go:yeswritebarrierrec
3730 func checkTimers(pp *p, now int64) (rnow, pollUntil int64, ran bool) {
3731 // If it's not yet time for the first timer, or the first adjusted
3732 // timer, then there is nothing to do.
3733 next := pp.timer0When.Load()
3734 nextAdj := pp.timerModifiedEarliest.Load()
3735 if next == 0 || (nextAdj != 0 && nextAdj < next) {
3740 // No timers to run or adjust.
3741 return now, 0, false
3748 // Next timer is not ready to run, but keep going
3749 // if we would clear deleted timers.
3750 // This corresponds to the condition below where
3751 // we decide whether to call clearDeletedTimers.
3752 if pp != getg().m.p.ptr() || int(pp.deletedTimers.Load()) <= int(pp.numTimers.Load()/4) {
3753 return now, next, false
3757 lock(&pp.timersLock)
3759 if len(pp.timers) > 0 {
3760 adjusttimers(pp, now)
3761 for len(pp.timers) > 0 {
3762 // Note that runtimer may temporarily unlock
3764 if tw := runtimer(pp, now); tw != 0 {
3774 // If this is the local P, and there are a lot of deleted timers,
3775 // clear them out. We only do this for the local P to reduce
3776 // lock contention on timersLock.
3777 if pp == getg().m.p.ptr() && int(pp.deletedTimers.Load()) > len(pp.timers)/4 {
3778 clearDeletedTimers(pp)
3781 unlock(&pp.timersLock)
3783 return now, pollUntil, ran
3786 func parkunlock_c(gp *g, lock unsafe.Pointer) bool {
3787 unlock((*mutex)(lock))
3791 // park continuation on g0.
3792 func park_m(gp *g) {
3796 traceGoPark(mp.waitTraceBlockReason, mp.waitTraceSkip)
3799 // N.B. Not using casGToWaiting here because the waitreason is
3800 // set by park_m's caller.
3801 casgstatus(gp, _Grunning, _Gwaiting)
3804 if fn := mp.waitunlockf; fn != nil {
3805 ok := fn(gp, mp.waitlock)
3806 mp.waitunlockf = nil
3810 traceGoUnpark(gp, 2)
3812 casgstatus(gp, _Gwaiting, _Grunnable)
3813 execute(gp, true) // Schedule it back, never returns.
3819 func goschedImpl(gp *g) {
3820 status := readgstatus(gp)
3821 if status&^_Gscan != _Grunning {
3823 throw("bad g status")
3825 casgstatus(gp, _Grunning, _Grunnable)
3838 // Gosched continuation on g0.
3839 func gosched_m(gp *g) {
3846 // goschedguarded is a forbidden-states-avoided version of gosched_m.
3847 func goschedguarded_m(gp *g) {
3849 if !canPreemptM(gp.m) {
3850 gogo(&gp.sched) // never return
3859 func gopreempt_m(gp *g) {
3866 // preemptPark parks gp and puts it in _Gpreempted.
3869 func preemptPark(gp *g) {
3871 traceGoPark(traceBlockPreempted, 0)
3873 status := readgstatus(gp)
3874 if status&^_Gscan != _Grunning {
3876 throw("bad g status")
3879 if gp.asyncSafePoint {
3880 // Double-check that async preemption does not
3881 // happen in SPWRITE assembly functions.
3882 // isAsyncSafePoint must exclude this case.
3883 f := findfunc(gp.sched.pc)
3885 throw("preempt at unknown pc")
3887 if f.flag&abi.FuncFlagSPWrite != 0 {
3888 println("runtime: unexpected SPWRITE function", funcname(f), "in async preempt")
3889 throw("preempt SPWRITE")
3893 // Transition from _Grunning to _Gscan|_Gpreempted. We can't
3894 // be in _Grunning when we dropg because then we'd be running
3895 // without an M, but the moment we're in _Gpreempted,
3896 // something could claim this G before we've fully cleaned it
3897 // up. Hence, we set the scan bit to lock down further
3898 // transitions until we can dropg.
3899 casGToPreemptScan(gp, _Grunning, _Gscan|_Gpreempted)
3901 casfrom_Gscanstatus(gp, _Gscan|_Gpreempted, _Gpreempted)
3905 // goyield is like Gosched, but it:
3906 // - emits a GoPreempt trace event instead of a GoSched trace event
3907 // - puts the current G on the runq of the current P instead of the globrunq
3913 func goyield_m(gp *g) {
3918 casgstatus(gp, _Grunning, _Grunnable)
3920 runqput(pp, gp, false)
3924 // Finishes execution of the current goroutine.
3935 // goexit continuation on g0.
3936 func goexit0(gp *g) {
3940 casgstatus(gp, _Grunning, _Gdead)
3941 gcController.addScannableStack(pp, -int64(gp.stack.hi-gp.stack.lo))
3942 if isSystemGoroutine(gp, false) {
3946 locked := gp.lockedm != 0
3949 gp.preemptStop = false
3950 gp.paniconfault = false
3951 gp._defer = nil // should be true already but just in case.
3952 gp._panic = nil // non-nil for Goexit during panic. points at stack-allocated data.
3954 gp.waitreason = waitReasonZero
3959 if gcBlackenEnabled != 0 && gp.gcAssistBytes > 0 {
3960 // Flush assist credit to the global pool. This gives
3961 // better information to pacing if the application is
3962 // rapidly creating an exiting goroutines.
3963 assistWorkPerByte := gcController.assistWorkPerByte.Load()
3964 scanCredit := int64(assistWorkPerByte * float64(gp.gcAssistBytes))
3965 gcController.bgScanCredit.Add(scanCredit)
3966 gp.gcAssistBytes = 0
3971 if GOARCH == "wasm" { // no threads yet on wasm
3973 schedule() // never returns
3976 if mp.lockedInt != 0 {
3977 print("invalid m->lockedInt = ", mp.lockedInt, "\n")
3978 throw("internal lockOSThread error")
3982 // The goroutine may have locked this thread because
3983 // it put it in an unusual kernel state. Kill it
3984 // rather than returning it to the thread pool.
3986 // Return to mstart, which will release the P and exit
3988 if GOOS != "plan9" { // See golang.org/issue/22227.
3991 // Clear lockedExt on plan9 since we may end up re-using
3999 // save updates getg().sched to refer to pc and sp so that a following
4000 // gogo will restore pc and sp.
4002 // save must not have write barriers because invoking a write barrier
4003 // can clobber getg().sched.
4006 //go:nowritebarrierrec
4007 func save(pc, sp uintptr) {
4010 if gp == gp.m.g0 || gp == gp.m.gsignal {
4011 // m.g0.sched is special and must describe the context
4012 // for exiting the thread. mstart1 writes to it directly.
4013 // m.gsignal.sched should not be used at all.
4014 // This check makes sure save calls do not accidentally
4015 // run in contexts where they'd write to system g's.
4016 throw("save on system g not allowed")
4023 // We need to ensure ctxt is zero, but can't have a write
4024 // barrier here. However, it should always already be zero.
4026 if gp.sched.ctxt != nil {
4031 // The goroutine g is about to enter a system call.
4032 // Record that it's not using the cpu anymore.
4033 // This is called only from the go syscall library and cgocall,
4034 // not from the low-level system calls used by the runtime.
4036 // Entersyscall cannot split the stack: the save must
4037 // make g->sched refer to the caller's stack segment, because
4038 // entersyscall is going to return immediately after.
4040 // Nothing entersyscall calls can split the stack either.
4041 // We cannot safely move the stack during an active call to syscall,
4042 // because we do not know which of the uintptr arguments are
4043 // really pointers (back into the stack).
4044 // In practice, this means that we make the fast path run through
4045 // entersyscall doing no-split things, and the slow path has to use systemstack
4046 // to run bigger things on the system stack.
4048 // reentersyscall is the entry point used by cgo callbacks, where explicitly
4049 // saved SP and PC are restored. This is needed when exitsyscall will be called
4050 // from a function further up in the call stack than the parent, as g->syscallsp
4051 // must always point to a valid stack frame. entersyscall below is the normal
4052 // entry point for syscalls, which obtains the SP and PC from the caller.
4055 // At the start of a syscall we emit traceGoSysCall to capture the stack trace.
4056 // If the syscall does not block, that is it, we do not emit any other events.
4057 // If the syscall blocks (that is, P is retaken), retaker emits traceGoSysBlock;
4058 // when syscall returns we emit traceGoSysExit and when the goroutine starts running
4059 // (potentially instantly, if exitsyscallfast returns true) we emit traceGoStart.
4060 // To ensure that traceGoSysExit is emitted strictly after traceGoSysBlock,
4061 // we remember current value of syscalltick in m (gp.m.syscalltick = gp.m.p.ptr().syscalltick),
4062 // whoever emits traceGoSysBlock increments p.syscalltick afterwards;
4063 // and we wait for the increment before emitting traceGoSysExit.
4064 // Note that the increment is done even if tracing is not enabled,
4065 // because tracing can be enabled in the middle of syscall. We don't want the wait to hang.
4068 func reentersyscall(pc, sp uintptr) {
4071 // Disable preemption because during this function g is in Gsyscall status,
4072 // but can have inconsistent g->sched, do not let GC observe it.
4075 // Entersyscall must not call any function that might split/grow the stack.
4076 // (See details in comment above.)
4077 // Catch calls that might, by replacing the stack guard with something that
4078 // will trip any stack check and leaving a flag to tell newstack to die.
4079 gp.stackguard0 = stackPreempt
4080 gp.throwsplit = true
4082 // Leave SP around for GC and traceback.
4086 casgstatus(gp, _Grunning, _Gsyscall)
4087 if staticLockRanking {
4088 // When doing static lock ranking casgstatus can call
4089 // systemstack which clobbers g.sched.
4092 if gp.syscallsp < gp.stack.lo || gp.stack.hi < gp.syscallsp {
4093 systemstack(func() {
4094 print("entersyscall inconsistent ", hex(gp.syscallsp), " [", hex(gp.stack.lo), ",", hex(gp.stack.hi), "]\n")
4095 throw("entersyscall")
4100 systemstack(traceGoSysCall)
4101 // systemstack itself clobbers g.sched.{pc,sp} and we might
4102 // need them later when the G is genuinely blocked in a
4107 if sched.sysmonwait.Load() {
4108 systemstack(entersyscall_sysmon)
4112 if gp.m.p.ptr().runSafePointFn != 0 {
4113 // runSafePointFn may stack split if run on this stack
4114 systemstack(runSafePointFn)
4118 gp.m.syscalltick = gp.m.p.ptr().syscalltick
4123 atomic.Store(&pp.status, _Psyscall)
4124 if sched.gcwaiting.Load() {
4125 systemstack(entersyscall_gcwait)
4132 // Standard syscall entry used by the go syscall library and normal cgo calls.
4134 // This is exported via linkname to assembly in the syscall package and x/sys.
4137 //go:linkname entersyscall
4138 func entersyscall() {
4139 reentersyscall(getcallerpc(), getcallersp())
4142 func entersyscall_sysmon() {
4144 if sched.sysmonwait.Load() {
4145 sched.sysmonwait.Store(false)
4146 notewakeup(&sched.sysmonnote)
4151 func entersyscall_gcwait() {
4153 pp := gp.m.oldp.ptr()
4156 if sched.stopwait > 0 && atomic.Cas(&pp.status, _Psyscall, _Pgcstop) {
4162 if sched.stopwait--; sched.stopwait == 0 {
4163 notewakeup(&sched.stopnote)
4169 // The same as entersyscall(), but with a hint that the syscall is blocking.
4172 func entersyscallblock() {
4175 gp.m.locks++ // see comment in entersyscall
4176 gp.throwsplit = true
4177 gp.stackguard0 = stackPreempt // see comment in entersyscall
4178 gp.m.syscalltick = gp.m.p.ptr().syscalltick
4179 gp.m.p.ptr().syscalltick++
4181 // Leave SP around for GC and traceback.
4185 gp.syscallsp = gp.sched.sp
4186 gp.syscallpc = gp.sched.pc
4187 if gp.syscallsp < gp.stack.lo || gp.stack.hi < gp.syscallsp {
4191 systemstack(func() {
4192 print("entersyscallblock inconsistent ", hex(sp1), " ", hex(sp2), " ", hex(sp3), " [", hex(gp.stack.lo), ",", hex(gp.stack.hi), "]\n")
4193 throw("entersyscallblock")
4196 casgstatus(gp, _Grunning, _Gsyscall)
4197 if gp.syscallsp < gp.stack.lo || gp.stack.hi < gp.syscallsp {
4198 systemstack(func() {
4199 print("entersyscallblock inconsistent ", hex(sp), " ", hex(gp.sched.sp), " ", hex(gp.syscallsp), " [", hex(gp.stack.lo), ",", hex(gp.stack.hi), "]\n")
4200 throw("entersyscallblock")
4204 systemstack(entersyscallblock_handoff)
4206 // Resave for traceback during blocked call.
4207 save(getcallerpc(), getcallersp())
4212 func entersyscallblock_handoff() {
4215 traceGoSysBlock(getg().m.p.ptr())
4217 handoffp(releasep())
4220 // The goroutine g exited its system call.
4221 // Arrange for it to run on a cpu again.
4222 // This is called only from the go syscall library, not
4223 // from the low-level system calls used by the runtime.
4225 // Write barriers are not allowed because our P may have been stolen.
4227 // This is exported via linkname to assembly in the syscall package.
4230 //go:nowritebarrierrec
4231 //go:linkname exitsyscall
4232 func exitsyscall() {
4235 gp.m.locks++ // see comment in entersyscall
4236 if getcallersp() > gp.syscallsp {
4237 throw("exitsyscall: syscall frame is no longer valid")
4241 oldp := gp.m.oldp.ptr()
4243 if exitsyscallfast(oldp) {
4244 // When exitsyscallfast returns success, we have a P so can now use
4246 if goroutineProfile.active {
4247 // Make sure that gp has had its stack written out to the goroutine
4248 // profile, exactly as it was when the goroutine profiler first
4249 // stopped the world.
4250 systemstack(func() {
4251 tryRecordGoroutineProfileWB(gp)
4255 if oldp != gp.m.p.ptr() || gp.m.syscalltick != gp.m.p.ptr().syscalltick {
4256 systemstack(traceGoStart)
4259 // There's a cpu for us, so we can run.
4260 gp.m.p.ptr().syscalltick++
4261 // We need to cas the status and scan before resuming...
4262 casgstatus(gp, _Gsyscall, _Grunning)
4264 // Garbage collector isn't running (since we are),
4265 // so okay to clear syscallsp.
4269 // restore the preemption request in case we've cleared it in newstack
4270 gp.stackguard0 = stackPreempt
4272 // otherwise restore the real stackGuard, we've spoiled it in entersyscall/entersyscallblock
4273 gp.stackguard0 = gp.stack.lo + stackGuard
4275 gp.throwsplit = false
4277 if sched.disable.user && !schedEnabled(gp) {
4278 // Scheduling of this goroutine is disabled.
4286 // Wait till traceGoSysBlock event is emitted.
4287 // This ensures consistency of the trace (the goroutine is started after it is blocked).
4288 for oldp != nil && oldp.syscalltick == gp.m.syscalltick {
4291 // We can't trace syscall exit right now because we don't have a P.
4292 // Tracing code can invoke write barriers that cannot run without a P.
4293 // So instead we remember the syscall exit time and emit the event
4294 // in execute when we have a P.
4295 gp.trace.sysExitTime = traceClockNow()
4300 // Call the scheduler.
4303 // Scheduler returned, so we're allowed to run now.
4304 // Delete the syscallsp information that we left for
4305 // the garbage collector during the system call.
4306 // Must wait until now because until gosched returns
4307 // we don't know for sure that the garbage collector
4310 gp.m.p.ptr().syscalltick++
4311 gp.throwsplit = false
4315 func exitsyscallfast(oldp *p) bool {
4318 // Freezetheworld sets stopwait but does not retake P's.
4319 if sched.stopwait == freezeStopWait {
4323 // Try to re-acquire the last P.
4324 if oldp != nil && oldp.status == _Psyscall && atomic.Cas(&oldp.status, _Psyscall, _Pidle) {
4325 // There's a cpu for us, so we can run.
4327 exitsyscallfast_reacquired()
4331 // Try to get any other idle P.
4332 if sched.pidle != 0 {
4334 systemstack(func() {
4335 ok = exitsyscallfast_pidle()
4336 if ok && traceEnabled() {
4338 // Wait till traceGoSysBlock event is emitted.
4339 // This ensures consistency of the trace (the goroutine is started after it is blocked).
4340 for oldp.syscalltick == gp.m.syscalltick {
4354 // exitsyscallfast_reacquired is the exitsyscall path on which this G
4355 // has successfully reacquired the P it was running on before the
4359 func exitsyscallfast_reacquired() {
4361 if gp.m.syscalltick != gp.m.p.ptr().syscalltick {
4363 // The p was retaken and then enter into syscall again (since gp.m.syscalltick has changed).
4364 // traceGoSysBlock for this syscall was already emitted,
4365 // but here we effectively retake the p from the new syscall running on the same p.
4366 systemstack(func() {
4367 // Denote blocking of the new syscall.
4368 traceGoSysBlock(gp.m.p.ptr())
4369 // Denote completion of the current syscall.
4373 gp.m.p.ptr().syscalltick++
4377 func exitsyscallfast_pidle() bool {
4379 pp, _ := pidleget(0)
4380 if pp != nil && sched.sysmonwait.Load() {
4381 sched.sysmonwait.Store(false)
4382 notewakeup(&sched.sysmonnote)
4392 // exitsyscall slow path on g0.
4393 // Failed to acquire P, enqueue gp as runnable.
4395 // Called via mcall, so gp is the calling g from this M.
4397 //go:nowritebarrierrec
4398 func exitsyscall0(gp *g) {
4399 casgstatus(gp, _Gsyscall, _Grunnable)
4403 if schedEnabled(gp) {
4410 // Below, we stoplockedm if gp is locked. globrunqput releases
4411 // ownership of gp, so we must check if gp is locked prior to
4412 // committing the release by unlocking sched.lock, otherwise we
4413 // could race with another M transitioning gp from unlocked to
4415 locked = gp.lockedm != 0
4416 } else if sched.sysmonwait.Load() {
4417 sched.sysmonwait.Store(false)
4418 notewakeup(&sched.sysmonnote)
4423 execute(gp, false) // Never returns.
4426 // Wait until another thread schedules gp and so m again.
4428 // N.B. lockedm must be this M, as this g was running on this M
4429 // before entersyscall.
4431 execute(gp, false) // Never returns.
4434 schedule() // Never returns.
4437 // Called from syscall package before fork.
4439 //go:linkname syscall_runtime_BeforeFork syscall.runtime_BeforeFork
4441 func syscall_runtime_BeforeFork() {
4444 // Block signals during a fork, so that the child does not run
4445 // a signal handler before exec if a signal is sent to the process
4446 // group. See issue #18600.
4448 sigsave(&gp.m.sigmask)
4451 // This function is called before fork in syscall package.
4452 // Code between fork and exec must not allocate memory nor even try to grow stack.
4453 // Here we spoil g.stackguard0 to reliably detect any attempts to grow stack.
4454 // runtime_AfterFork will undo this in parent process, but not in child.
4455 gp.stackguard0 = stackFork
4458 // Called from syscall package after fork in parent.
4460 //go:linkname syscall_runtime_AfterFork syscall.runtime_AfterFork
4462 func syscall_runtime_AfterFork() {
4465 // See the comments in beforefork.
4466 gp.stackguard0 = gp.stack.lo + stackGuard
4468 msigrestore(gp.m.sigmask)
4473 // inForkedChild is true while manipulating signals in the child process.
4474 // This is used to avoid calling libc functions in case we are using vfork.
4475 var inForkedChild bool
4477 // Called from syscall package after fork in child.
4478 // It resets non-sigignored signals to the default handler, and
4479 // restores the signal mask in preparation for the exec.
4481 // Because this might be called during a vfork, and therefore may be
4482 // temporarily sharing address space with the parent process, this must
4483 // not change any global variables or calling into C code that may do so.
4485 //go:linkname syscall_runtime_AfterForkInChild syscall.runtime_AfterForkInChild
4487 //go:nowritebarrierrec
4488 func syscall_runtime_AfterForkInChild() {
4489 // It's OK to change the global variable inForkedChild here
4490 // because we are going to change it back. There is no race here,
4491 // because if we are sharing address space with the parent process,
4492 // then the parent process can not be running concurrently.
4493 inForkedChild = true
4495 clearSignalHandlers()
4497 // When we are the child we are the only thread running,
4498 // so we know that nothing else has changed gp.m.sigmask.
4499 msigrestore(getg().m.sigmask)
4501 inForkedChild = false
4504 // pendingPreemptSignals is the number of preemption signals
4505 // that have been sent but not received. This is only used on Darwin.
4507 var pendingPreemptSignals atomic.Int32
4509 // Called from syscall package before Exec.
4511 //go:linkname syscall_runtime_BeforeExec syscall.runtime_BeforeExec
4512 func syscall_runtime_BeforeExec() {
4513 // Prevent thread creation during exec.
4516 // On Darwin, wait for all pending preemption signals to
4517 // be received. See issue #41702.
4518 if GOOS == "darwin" || GOOS == "ios" {
4519 for pendingPreemptSignals.Load() > 0 {
4525 // Called from syscall package after Exec.
4527 //go:linkname syscall_runtime_AfterExec syscall.runtime_AfterExec
4528 func syscall_runtime_AfterExec() {
4532 // Allocate a new g, with a stack big enough for stacksize bytes.
4533 func malg(stacksize int32) *g {
4536 stacksize = round2(stackSystem + stacksize)
4537 systemstack(func() {
4538 newg.stack = stackalloc(uint32(stacksize))
4540 newg.stackguard0 = newg.stack.lo + stackGuard
4541 newg.stackguard1 = ^uintptr(0)
4542 // Clear the bottom word of the stack. We record g
4543 // there on gsignal stack during VDSO on ARM and ARM64.
4544 *(*uintptr)(unsafe.Pointer(newg.stack.lo)) = 0
4549 // Create a new g running fn.
4550 // Put it on the queue of g's waiting to run.
4551 // The compiler turns a go statement into a call to this.
4552 func newproc(fn *funcval) {
4555 systemstack(func() {
4556 newg := newproc1(fn, gp, pc)
4558 pp := getg().m.p.ptr()
4559 runqput(pp, newg, true)
4567 // Create a new g in state _Grunnable, starting at fn. callerpc is the
4568 // address of the go statement that created this. The caller is responsible
4569 // for adding the new g to the scheduler.
4570 func newproc1(fn *funcval, callergp *g, callerpc uintptr) *g {
4572 fatal("go of nil func value")
4575 mp := acquirem() // disable preemption because we hold M and P in local vars.
4579 newg = malg(stackMin)
4580 casgstatus(newg, _Gidle, _Gdead)
4581 allgadd(newg) // publishes with a g->status of Gdead so GC scanner doesn't look at uninitialized stack.
4583 if newg.stack.hi == 0 {
4584 throw("newproc1: newg missing stack")
4587 if readgstatus(newg) != _Gdead {
4588 throw("newproc1: new g is not Gdead")
4591 totalSize := uintptr(4*goarch.PtrSize + sys.MinFrameSize) // extra space in case of reads slightly beyond frame
4592 totalSize = alignUp(totalSize, sys.StackAlign)
4593 sp := newg.stack.hi - totalSize
4596 *(*uintptr)(unsafe.Pointer(sp)) = 0
4599 if GOARCH == "arm64" {
4601 *(*uintptr)(unsafe.Pointer(sp - goarch.PtrSize)) = 0
4604 memclrNoHeapPointers(unsafe.Pointer(&newg.sched), unsafe.Sizeof(newg.sched))
4607 newg.sched.pc = abi.FuncPCABI0(goexit) + sys.PCQuantum // +PCQuantum so that previous instruction is in same function
4608 newg.sched.g = guintptr(unsafe.Pointer(newg))
4609 gostartcallfn(&newg.sched, fn)
4610 newg.parentGoid = callergp.goid
4611 newg.gopc = callerpc
4612 newg.ancestors = saveAncestors(callergp)
4613 newg.startpc = fn.fn
4614 if isSystemGoroutine(newg, false) {
4617 // Only user goroutines inherit pprof labels.
4619 newg.labels = mp.curg.labels
4621 if goroutineProfile.active {
4622 // A concurrent goroutine profile is running. It should include
4623 // exactly the set of goroutines that were alive when the goroutine
4624 // profiler first stopped the world. That does not include newg, so
4625 // mark it as not needing a profile before transitioning it from
4627 newg.goroutineProfiled.Store(goroutineProfileSatisfied)
4630 // Track initial transition?
4631 newg.trackingSeq = uint8(fastrand())
4632 if newg.trackingSeq%gTrackingPeriod == 0 {
4633 newg.tracking = true
4635 casgstatus(newg, _Gdead, _Grunnable)
4636 gcController.addScannableStack(pp, int64(newg.stack.hi-newg.stack.lo))
4638 if pp.goidcache == pp.goidcacheend {
4639 // Sched.goidgen is the last allocated id,
4640 // this batch must be [sched.goidgen+1, sched.goidgen+GoidCacheBatch].
4641 // At startup sched.goidgen=0, so main goroutine receives goid=1.
4642 pp.goidcache = sched.goidgen.Add(_GoidCacheBatch)
4643 pp.goidcache -= _GoidCacheBatch - 1
4644 pp.goidcacheend = pp.goidcache + _GoidCacheBatch
4646 newg.goid = pp.goidcache
4649 newg.racectx = racegostart(callerpc)
4651 if newg.labels != nil {
4652 // See note in proflabel.go on labelSync's role in synchronizing
4653 // with the reads in the signal handler.
4654 racereleasemergeg(newg, unsafe.Pointer(&labelSync))
4658 traceGoCreate(newg, newg.startpc)
4665 // saveAncestors copies previous ancestors of the given caller g and
4666 // includes info for the current caller into a new set of tracebacks for
4667 // a g being created.
4668 func saveAncestors(callergp *g) *[]ancestorInfo {
4669 // Copy all prior info, except for the root goroutine (goid 0).
4670 if debug.tracebackancestors <= 0 || callergp.goid == 0 {
4673 var callerAncestors []ancestorInfo
4674 if callergp.ancestors != nil {
4675 callerAncestors = *callergp.ancestors
4677 n := int32(len(callerAncestors)) + 1
4678 if n > debug.tracebackancestors {
4679 n = debug.tracebackancestors
4681 ancestors := make([]ancestorInfo, n)
4682 copy(ancestors[1:], callerAncestors)
4684 var pcs [tracebackInnerFrames]uintptr
4685 npcs := gcallers(callergp, 0, pcs[:])
4686 ipcs := make([]uintptr, npcs)
4688 ancestors[0] = ancestorInfo{
4690 goid: callergp.goid,
4691 gopc: callergp.gopc,
4694 ancestorsp := new([]ancestorInfo)
4695 *ancestorsp = ancestors
4699 // Put on gfree list.
4700 // If local list is too long, transfer a batch to the global list.
4701 func gfput(pp *p, gp *g) {
4702 if readgstatus(gp) != _Gdead {
4703 throw("gfput: bad status (not Gdead)")
4706 stksize := gp.stack.hi - gp.stack.lo
4708 if stksize != uintptr(startingStackSize) {
4709 // non-standard stack size - free it.
4718 if pp.gFree.n >= 64 {
4724 for pp.gFree.n >= 32 {
4725 gp := pp.gFree.pop()
4727 if gp.stack.lo == 0 {
4734 lock(&sched.gFree.lock)
4735 sched.gFree.noStack.pushAll(noStackQ)
4736 sched.gFree.stack.pushAll(stackQ)
4737 sched.gFree.n += inc
4738 unlock(&sched.gFree.lock)
4742 // Get from gfree list.
4743 // If local list is empty, grab a batch from global list.
4744 func gfget(pp *p) *g {
4746 if pp.gFree.empty() && (!sched.gFree.stack.empty() || !sched.gFree.noStack.empty()) {
4747 lock(&sched.gFree.lock)
4748 // Move a batch of free Gs to the P.
4749 for pp.gFree.n < 32 {
4750 // Prefer Gs with stacks.
4751 gp := sched.gFree.stack.pop()
4753 gp = sched.gFree.noStack.pop()
4762 unlock(&sched.gFree.lock)
4765 gp := pp.gFree.pop()
4770 if gp.stack.lo != 0 && gp.stack.hi-gp.stack.lo != uintptr(startingStackSize) {
4771 // Deallocate old stack. We kept it in gfput because it was the
4772 // right size when the goroutine was put on the free list, but
4773 // the right size has changed since then.
4774 systemstack(func() {
4781 if gp.stack.lo == 0 {
4782 // Stack was deallocated in gfput or just above. Allocate a new one.
4783 systemstack(func() {
4784 gp.stack = stackalloc(startingStackSize)
4786 gp.stackguard0 = gp.stack.lo + stackGuard
4789 racemalloc(unsafe.Pointer(gp.stack.lo), gp.stack.hi-gp.stack.lo)
4792 msanmalloc(unsafe.Pointer(gp.stack.lo), gp.stack.hi-gp.stack.lo)
4795 asanunpoison(unsafe.Pointer(gp.stack.lo), gp.stack.hi-gp.stack.lo)
4801 // Purge all cached G's from gfree list to the global list.
4802 func gfpurge(pp *p) {
4808 for !pp.gFree.empty() {
4809 gp := pp.gFree.pop()
4811 if gp.stack.lo == 0 {
4818 lock(&sched.gFree.lock)
4819 sched.gFree.noStack.pushAll(noStackQ)
4820 sched.gFree.stack.pushAll(stackQ)
4821 sched.gFree.n += inc
4822 unlock(&sched.gFree.lock)
4825 // Breakpoint executes a breakpoint trap.
4830 // dolockOSThread is called by LockOSThread and lockOSThread below
4831 // after they modify m.locked. Do not allow preemption during this call,
4832 // or else the m might be different in this function than in the caller.
4835 func dolockOSThread() {
4836 if GOARCH == "wasm" {
4837 return // no threads on wasm yet
4840 gp.m.lockedg.set(gp)
4841 gp.lockedm.set(gp.m)
4844 // LockOSThread wires the calling goroutine to its current operating system thread.
4845 // The calling goroutine will always execute in that thread,
4846 // and no other goroutine will execute in it,
4847 // until the calling goroutine has made as many calls to
4848 // UnlockOSThread as to LockOSThread.
4849 // If the calling goroutine exits without unlocking the thread,
4850 // the thread will be terminated.
4852 // All init functions are run on the startup thread. Calling LockOSThread
4853 // from an init function will cause the main function to be invoked on
4856 // A goroutine should call LockOSThread before calling OS services or
4857 // non-Go library functions that depend on per-thread state.
4860 func LockOSThread() {
4861 if atomic.Load(&newmHandoff.haveTemplateThread) == 0 && GOOS != "plan9" {
4862 // If we need to start a new thread from the locked
4863 // thread, we need the template thread. Start it now
4864 // while we're in a known-good state.
4865 startTemplateThread()
4869 if gp.m.lockedExt == 0 {
4871 panic("LockOSThread nesting overflow")
4877 func lockOSThread() {
4878 getg().m.lockedInt++
4882 // dounlockOSThread is called by UnlockOSThread and unlockOSThread below
4883 // after they update m->locked. Do not allow preemption during this call,
4884 // or else the m might be in different in this function than in the caller.
4887 func dounlockOSThread() {
4888 if GOARCH == "wasm" {
4889 return // no threads on wasm yet
4892 if gp.m.lockedInt != 0 || gp.m.lockedExt != 0 {
4899 // UnlockOSThread undoes an earlier call to LockOSThread.
4900 // If this drops the number of active LockOSThread calls on the
4901 // calling goroutine to zero, it unwires the calling goroutine from
4902 // its fixed operating system thread.
4903 // If there are no active LockOSThread calls, this is a no-op.
4905 // Before calling UnlockOSThread, the caller must ensure that the OS
4906 // thread is suitable for running other goroutines. If the caller made
4907 // any permanent changes to the state of the thread that would affect
4908 // other goroutines, it should not call this function and thus leave
4909 // the goroutine locked to the OS thread until the goroutine (and
4910 // hence the thread) exits.
4913 func UnlockOSThread() {
4915 if gp.m.lockedExt == 0 {
4923 func unlockOSThread() {
4925 if gp.m.lockedInt == 0 {
4926 systemstack(badunlockosthread)
4932 func badunlockosthread() {
4933 throw("runtime: internal error: misuse of lockOSThread/unlockOSThread")
4936 func gcount() int32 {
4937 n := int32(atomic.Loaduintptr(&allglen)) - sched.gFree.n - sched.ngsys.Load()
4938 for _, pp := range allp {
4942 // All these variables can be changed concurrently, so the result can be inconsistent.
4943 // But at least the current goroutine is running.
4950 func mcount() int32 {
4951 return int32(sched.mnext - sched.nmfreed)
4955 signalLock atomic.Uint32
4957 // Must hold signalLock to write. Reads may be lock-free, but
4958 // signalLock should be taken to synchronize with changes.
4962 func _System() { _System() }
4963 func _ExternalCode() { _ExternalCode() }
4964 func _LostExternalCode() { _LostExternalCode() }
4965 func _GC() { _GC() }
4966 func _LostSIGPROFDuringAtomic64() { _LostSIGPROFDuringAtomic64() }
4967 func _VDSO() { _VDSO() }
4969 // Called if we receive a SIGPROF signal.
4970 // Called by the signal handler, may run during STW.
4972 //go:nowritebarrierrec
4973 func sigprof(pc, sp, lr uintptr, gp *g, mp *m) {
4974 if prof.hz.Load() == 0 {
4978 // If mp.profilehz is 0, then profiling is not enabled for this thread.
4979 // We must check this to avoid a deadlock between setcpuprofilerate
4980 // and the call to cpuprof.add, below.
4981 if mp != nil && mp.profilehz == 0 {
4985 // On mips{,le}/arm, 64bit atomics are emulated with spinlocks, in
4986 // runtime/internal/atomic. If SIGPROF arrives while the program is inside
4987 // the critical section, it creates a deadlock (when writing the sample).
4988 // As a workaround, create a counter of SIGPROFs while in critical section
4989 // to store the count, and pass it to sigprof.add() later when SIGPROF is
4990 // received from somewhere else (with _LostSIGPROFDuringAtomic64 as pc).
4991 if GOARCH == "mips" || GOARCH == "mipsle" || GOARCH == "arm" {
4992 if f := findfunc(pc); f.valid() {
4993 if hasPrefix(funcname(f), "runtime/internal/atomic") {
4994 cpuprof.lostAtomic++
4998 if GOARCH == "arm" && goarm < 7 && GOOS == "linux" && pc&0xffff0000 == 0xffff0000 {
4999 // runtime/internal/atomic functions call into kernel
5000 // helpers on arm < 7. See
5001 // runtime/internal/atomic/sys_linux_arm.s.
5002 cpuprof.lostAtomic++
5007 // Profiling runs concurrently with GC, so it must not allocate.
5008 // Set a trap in case the code does allocate.
5009 // Note that on windows, one thread takes profiles of all the
5010 // other threads, so mp is usually not getg().m.
5011 // In fact mp may not even be stopped.
5012 // See golang.org/issue/17165.
5013 getg().m.mallocing++
5016 var stk [maxCPUProfStack]uintptr
5018 if mp.ncgo > 0 && mp.curg != nil && mp.curg.syscallpc != 0 && mp.curg.syscallsp != 0 {
5020 // Check cgoCallersUse to make sure that we are not
5021 // interrupting other code that is fiddling with
5022 // cgoCallers. We are running in a signal handler
5023 // with all signals blocked, so we don't have to worry
5024 // about any other code interrupting us.
5025 if mp.cgoCallersUse.Load() == 0 && mp.cgoCallers != nil && mp.cgoCallers[0] != 0 {
5026 for cgoOff < len(mp.cgoCallers) && mp.cgoCallers[cgoOff] != 0 {
5029 n += copy(stk[:], mp.cgoCallers[:cgoOff])
5030 mp.cgoCallers[0] = 0
5033 // Collect Go stack that leads to the cgo call.
5034 u.initAt(mp.curg.syscallpc, mp.curg.syscallsp, 0, mp.curg, unwindSilentErrors)
5035 } else if usesLibcall() && mp.libcallg != 0 && mp.libcallpc != 0 && mp.libcallsp != 0 {
5036 // Libcall, i.e. runtime syscall on windows.
5037 // Collect Go stack that leads to the call.
5038 u.initAt(mp.libcallpc, mp.libcallsp, 0, mp.libcallg.ptr(), unwindSilentErrors)
5039 } else if mp != nil && mp.vdsoSP != 0 {
5040 // VDSO call, e.g. nanotime1 on Linux.
5041 // Collect Go stack that leads to the call.
5042 u.initAt(mp.vdsoPC, mp.vdsoSP, 0, gp, unwindSilentErrors|unwindJumpStack)
5044 u.initAt(pc, sp, lr, gp, unwindSilentErrors|unwindTrap|unwindJumpStack)
5046 n += tracebackPCs(&u, 0, stk[n:])
5049 // Normal traceback is impossible or has failed.
5050 // Account it against abstract "System" or "GC".
5053 pc = abi.FuncPCABIInternal(_VDSO) + sys.PCQuantum
5054 } else if pc > firstmoduledata.etext {
5055 // "ExternalCode" is better than "etext".
5056 pc = abi.FuncPCABIInternal(_ExternalCode) + sys.PCQuantum
5059 if mp.preemptoff != "" {
5060 stk[1] = abi.FuncPCABIInternal(_GC) + sys.PCQuantum
5062 stk[1] = abi.FuncPCABIInternal(_System) + sys.PCQuantum
5066 if prof.hz.Load() != 0 {
5067 // Note: it can happen on Windows that we interrupted a system thread
5068 // with no g, so gp could nil. The other nil checks are done out of
5069 // caution, but not expected to be nil in practice.
5070 var tagPtr *unsafe.Pointer
5071 if gp != nil && gp.m != nil && gp.m.curg != nil {
5072 tagPtr = &gp.m.curg.labels
5074 cpuprof.add(tagPtr, stk[:n])
5078 if gp != nil && gp.m != nil {
5079 if gp.m.curg != nil {
5084 traceCPUSample(gprof, pp, stk[:n])
5086 getg().m.mallocing--
5089 // setcpuprofilerate sets the CPU profiling rate to hz times per second.
5090 // If hz <= 0, setcpuprofilerate turns off CPU profiling.
5091 func setcpuprofilerate(hz int32) {
5092 // Force sane arguments.
5097 // Disable preemption, otherwise we can be rescheduled to another thread
5098 // that has profiling enabled.
5102 // Stop profiler on this thread so that it is safe to lock prof.
5103 // if a profiling signal came in while we had prof locked,
5104 // it would deadlock.
5105 setThreadCPUProfiler(0)
5107 for !prof.signalLock.CompareAndSwap(0, 1) {
5110 if prof.hz.Load() != hz {
5111 setProcessCPUProfiler(hz)
5114 prof.signalLock.Store(0)
5117 sched.profilehz = hz
5121 setThreadCPUProfiler(hz)
5127 // init initializes pp, which may be a freshly allocated p or a
5128 // previously destroyed p, and transitions it to status _Pgcstop.
5129 func (pp *p) init(id int32) {
5131 pp.status = _Pgcstop
5132 pp.sudogcache = pp.sudogbuf[:0]
5133 pp.deferpool = pp.deferpoolbuf[:0]
5135 if pp.mcache == nil {
5138 throw("missing mcache?")
5140 // Use the bootstrap mcache0. Only one P will get
5141 // mcache0: the one with ID 0.
5144 pp.mcache = allocmcache()
5147 if raceenabled && pp.raceprocctx == 0 {
5149 pp.raceprocctx = raceprocctx0
5150 raceprocctx0 = 0 // bootstrap
5152 pp.raceprocctx = raceproccreate()
5155 lockInit(&pp.timersLock, lockRankTimers)
5157 // This P may get timers when it starts running. Set the mask here
5158 // since the P may not go through pidleget (notably P 0 on startup).
5160 // Similarly, we may not go through pidleget before this P starts
5161 // running if it is P 0 on startup.
5165 // destroy releases all of the resources associated with pp and
5166 // transitions it to status _Pdead.
5168 // sched.lock must be held and the world must be stopped.
5169 func (pp *p) destroy() {
5170 assertLockHeld(&sched.lock)
5171 assertWorldStopped()
5173 // Move all runnable goroutines to the global queue
5174 for pp.runqhead != pp.runqtail {
5175 // Pop from tail of local queue
5177 gp := pp.runq[pp.runqtail%uint32(len(pp.runq))].ptr()
5178 // Push onto head of global queue
5181 if pp.runnext != 0 {
5182 globrunqputhead(pp.runnext.ptr())
5185 if len(pp.timers) > 0 {
5186 plocal := getg().m.p.ptr()
5187 // The world is stopped, but we acquire timersLock to
5188 // protect against sysmon calling timeSleepUntil.
5189 // This is the only case where we hold the timersLock of
5190 // more than one P, so there are no deadlock concerns.
5191 lock(&plocal.timersLock)
5192 lock(&pp.timersLock)
5193 moveTimers(plocal, pp.timers)
5195 pp.numTimers.Store(0)
5196 pp.deletedTimers.Store(0)
5197 pp.timer0When.Store(0)
5198 unlock(&pp.timersLock)
5199 unlock(&plocal.timersLock)
5201 // Flush p's write barrier buffer.
5202 if gcphase != _GCoff {
5206 for i := range pp.sudogbuf {
5207 pp.sudogbuf[i] = nil
5209 pp.sudogcache = pp.sudogbuf[:0]
5210 pp.pinnerCache = nil
5211 for j := range pp.deferpoolbuf {
5212 pp.deferpoolbuf[j] = nil
5214 pp.deferpool = pp.deferpoolbuf[:0]
5215 systemstack(func() {
5216 for i := 0; i < pp.mspancache.len; i++ {
5217 // Safe to call since the world is stopped.
5218 mheap_.spanalloc.free(unsafe.Pointer(pp.mspancache.buf[i]))
5220 pp.mspancache.len = 0
5222 pp.pcache.flush(&mheap_.pages)
5223 unlock(&mheap_.lock)
5225 freemcache(pp.mcache)
5230 if pp.timerRaceCtx != 0 {
5231 // The race detector code uses a callback to fetch
5232 // the proc context, so arrange for that callback
5233 // to see the right thing.
5234 // This hack only works because we are the only
5240 racectxend(pp.timerRaceCtx)
5245 raceprocdestroy(pp.raceprocctx)
5252 // Change number of processors.
5254 // sched.lock must be held, and the world must be stopped.
5256 // gcworkbufs must not be being modified by either the GC or the write barrier
5257 // code, so the GC must not be running if the number of Ps actually changes.
5259 // Returns list of Ps with local work, they need to be scheduled by the caller.
5260 func procresize(nprocs int32) *p {
5261 assertLockHeld(&sched.lock)
5262 assertWorldStopped()
5265 if old < 0 || nprocs <= 0 {
5266 throw("procresize: invalid arg")
5269 traceGomaxprocs(nprocs)
5272 // update statistics
5274 if sched.procresizetime != 0 {
5275 sched.totaltime += int64(old) * (now - sched.procresizetime)
5277 sched.procresizetime = now
5279 maskWords := (nprocs + 31) / 32
5281 // Grow allp if necessary.
5282 if nprocs > int32(len(allp)) {
5283 // Synchronize with retake, which could be running
5284 // concurrently since it doesn't run on a P.
5286 if nprocs <= int32(cap(allp)) {
5287 allp = allp[:nprocs]
5289 nallp := make([]*p, nprocs)
5290 // Copy everything up to allp's cap so we
5291 // never lose old allocated Ps.
5292 copy(nallp, allp[:cap(allp)])
5296 if maskWords <= int32(cap(idlepMask)) {
5297 idlepMask = idlepMask[:maskWords]
5298 timerpMask = timerpMask[:maskWords]
5300 nidlepMask := make([]uint32, maskWords)
5301 // No need to copy beyond len, old Ps are irrelevant.
5302 copy(nidlepMask, idlepMask)
5303 idlepMask = nidlepMask
5305 ntimerpMask := make([]uint32, maskWords)
5306 copy(ntimerpMask, timerpMask)
5307 timerpMask = ntimerpMask
5312 // initialize new P's
5313 for i := old; i < nprocs; i++ {
5319 atomicstorep(unsafe.Pointer(&allp[i]), unsafe.Pointer(pp))
5323 if gp.m.p != 0 && gp.m.p.ptr().id < nprocs {
5324 // continue to use the current P
5325 gp.m.p.ptr().status = _Prunning
5326 gp.m.p.ptr().mcache.prepareForSweep()
5328 // release the current P and acquire allp[0].
5330 // We must do this before destroying our current P
5331 // because p.destroy itself has write barriers, so we
5332 // need to do that from a valid P.
5335 // Pretend that we were descheduled
5336 // and then scheduled again to keep
5339 traceProcStop(gp.m.p.ptr())
5353 // g.m.p is now set, so we no longer need mcache0 for bootstrapping.
5356 // release resources from unused P's
5357 for i := nprocs; i < old; i++ {
5360 // can't free P itself because it can be referenced by an M in syscall
5364 if int32(len(allp)) != nprocs {
5366 allp = allp[:nprocs]
5367 idlepMask = idlepMask[:maskWords]
5368 timerpMask = timerpMask[:maskWords]
5373 for i := nprocs - 1; i >= 0; i-- {
5375 if gp.m.p.ptr() == pp {
5383 pp.link.set(runnablePs)
5387 stealOrder.reset(uint32(nprocs))
5388 var int32p *int32 = &gomaxprocs // make compiler check that gomaxprocs is an int32
5389 atomic.Store((*uint32)(unsafe.Pointer(int32p)), uint32(nprocs))
5391 // Notify the limiter that the amount of procs has changed.
5392 gcCPULimiter.resetCapacity(now, nprocs)
5397 // Associate p and the current m.
5399 // This function is allowed to have write barriers even if the caller
5400 // isn't because it immediately acquires pp.
5402 //go:yeswritebarrierrec
5403 func acquirep(pp *p) {
5404 // Do the part that isn't allowed to have write barriers.
5407 // Have p; write barriers now allowed.
5409 // Perform deferred mcache flush before this P can allocate
5410 // from a potentially stale mcache.
5411 pp.mcache.prepareForSweep()
5418 // wirep is the first step of acquirep, which actually associates the
5419 // current M to pp. This is broken out so we can disallow write
5420 // barriers for this part, since we don't yet have a P.
5422 //go:nowritebarrierrec
5428 throw("wirep: already in go")
5430 if pp.m != 0 || pp.status != _Pidle {
5435 print("wirep: p->m=", pp.m, "(", id, ") p->status=", pp.status, "\n")
5436 throw("wirep: invalid p state")
5440 pp.status = _Prunning
5443 // Disassociate p and the current m.
5444 func releasep() *p {
5448 throw("releasep: invalid arg")
5451 if pp.m.ptr() != gp.m || pp.status != _Prunning {
5452 print("releasep: m=", gp.m, " m->p=", gp.m.p.ptr(), " p->m=", hex(pp.m), " p->status=", pp.status, "\n")
5453 throw("releasep: invalid p state")
5456 traceProcStop(gp.m.p.ptr())
5464 func incidlelocked(v int32) {
5466 sched.nmidlelocked += v
5473 // Check for deadlock situation.
5474 // The check is based on number of running M's, if 0 -> deadlock.
5475 // sched.lock must be held.
5477 assertLockHeld(&sched.lock)
5479 // For -buildmode=c-shared or -buildmode=c-archive it's OK if
5480 // there are no running goroutines. The calling program is
5481 // assumed to be running.
5482 if islibrary || isarchive {
5486 // If we are dying because of a signal caught on an already idle thread,
5487 // freezetheworld will cause all running threads to block.
5488 // And runtime will essentially enter into deadlock state,
5489 // except that there is a thread that will call exit soon.
5490 if panicking.Load() > 0 {
5494 // If we are not running under cgo, but we have an extra M then account
5495 // for it. (It is possible to have an extra M on Windows without cgo to
5496 // accommodate callbacks created by syscall.NewCallback. See issue #6751
5499 if !iscgo && cgoHasExtraM && extraMLength.Load() > 0 {
5503 run := mcount() - sched.nmidle - sched.nmidlelocked - sched.nmsys
5508 print("runtime: checkdead: nmidle=", sched.nmidle, " nmidlelocked=", sched.nmidlelocked, " mcount=", mcount(), " nmsys=", sched.nmsys, "\n")
5510 throw("checkdead: inconsistent counts")
5514 forEachG(func(gp *g) {
5515 if isSystemGoroutine(gp, false) {
5518 s := readgstatus(gp)
5519 switch s &^ _Gscan {
5526 print("runtime: checkdead: find g ", gp.goid, " in status ", s, "\n")
5528 throw("checkdead: runnable g")
5531 if grunning == 0 { // possible if main goroutine calls runtime·Goexit()
5532 unlock(&sched.lock) // unlock so that GODEBUG=scheddetail=1 doesn't hang
5533 fatal("no goroutines (main called runtime.Goexit) - deadlock!")
5536 // Maybe jump time forward for playground.
5538 if when := timeSleepUntil(); when < maxWhen {
5541 // Start an M to steal the timer.
5542 pp, _ := pidleget(faketime)
5544 // There should always be a free P since
5545 // nothing is running.
5547 throw("checkdead: no p for timer")
5551 // There should always be a free M since
5552 // nothing is running.
5554 throw("checkdead: no m for timer")
5556 // M must be spinning to steal. We set this to be
5557 // explicit, but since this is the only M it would
5558 // become spinning on its own anyways.
5559 sched.nmspinning.Add(1)
5562 notewakeup(&mp.park)
5567 // There are no goroutines running, so we can look at the P's.
5568 for _, pp := range allp {
5569 if len(pp.timers) > 0 {
5574 unlock(&sched.lock) // unlock so that GODEBUG=scheddetail=1 doesn't hang
5575 fatal("all goroutines are asleep - deadlock!")
5578 // forcegcperiod is the maximum time in nanoseconds between garbage
5579 // collections. If we go this long without a garbage collection, one
5580 // is forced to run.
5582 // This is a variable for testing purposes. It normally doesn't change.
5583 var forcegcperiod int64 = 2 * 60 * 1e9
5585 // needSysmonWorkaround is true if the workaround for
5586 // golang.org/issue/42515 is needed on NetBSD.
5587 var needSysmonWorkaround bool = false
5589 // Always runs without a P, so write barriers are not allowed.
5591 //go:nowritebarrierrec
5598 lasttrace := int64(0)
5599 idle := 0 // how many cycles in succession we had not wokeup somebody
5603 if idle == 0 { // start with 20us sleep...
5605 } else if idle > 50 { // start doubling the sleep after 1ms...
5608 if delay > 10*1000 { // up to 10ms
5613 // sysmon should not enter deep sleep if schedtrace is enabled so that
5614 // it can print that information at the right time.
5616 // It should also not enter deep sleep if there are any active P's so
5617 // that it can retake P's from syscalls, preempt long running G's, and
5618 // poll the network if all P's are busy for long stretches.
5620 // It should wakeup from deep sleep if any P's become active either due
5621 // to exiting a syscall or waking up due to a timer expiring so that it
5622 // can resume performing those duties. If it wakes from a syscall it
5623 // resets idle and delay as a bet that since it had retaken a P from a
5624 // syscall before, it may need to do it again shortly after the
5625 // application starts work again. It does not reset idle when waking
5626 // from a timer to avoid adding system load to applications that spend
5627 // most of their time sleeping.
5629 if debug.schedtrace <= 0 && (sched.gcwaiting.Load() || sched.npidle.Load() == gomaxprocs) {
5631 if sched.gcwaiting.Load() || sched.npidle.Load() == gomaxprocs {
5632 syscallWake := false
5633 next := timeSleepUntil()
5635 sched.sysmonwait.Store(true)
5637 // Make wake-up period small enough
5638 // for the sampling to be correct.
5639 sleep := forcegcperiod / 2
5640 if next-now < sleep {
5643 shouldRelax := sleep >= osRelaxMinNS
5647 syscallWake = notetsleep(&sched.sysmonnote, sleep)
5652 sched.sysmonwait.Store(false)
5653 noteclear(&sched.sysmonnote)
5663 lock(&sched.sysmonlock)
5664 // Update now in case we blocked on sysmonnote or spent a long time
5665 // blocked on schedlock or sysmonlock above.
5668 // trigger libc interceptors if needed
5669 if *cgo_yield != nil {
5670 asmcgocall(*cgo_yield, nil)
5672 // poll network if not polled for more than 10ms
5673 lastpoll := sched.lastpoll.Load()
5674 if netpollinited() && lastpoll != 0 && lastpoll+10*1000*1000 < now {
5675 sched.lastpoll.CompareAndSwap(lastpoll, now)
5676 list, delta := netpoll(0) // non-blocking - returns list of goroutines
5678 // Need to decrement number of idle locked M's
5679 // (pretending that one more is running) before injectglist.
5680 // Otherwise it can lead to the following situation:
5681 // injectglist grabs all P's but before it starts M's to run the P's,
5682 // another M returns from syscall, finishes running its G,
5683 // observes that there is no work to do and no other running M's
5684 // and reports deadlock.
5688 netpollAdjustWaiters(delta)
5691 if GOOS == "netbsd" && needSysmonWorkaround {
5692 // netpoll is responsible for waiting for timer
5693 // expiration, so we typically don't have to worry
5694 // about starting an M to service timers. (Note that
5695 // sleep for timeSleepUntil above simply ensures sysmon
5696 // starts running again when that timer expiration may
5697 // cause Go code to run again).
5699 // However, netbsd has a kernel bug that sometimes
5700 // misses netpollBreak wake-ups, which can lead to
5701 // unbounded delays servicing timers. If we detect this
5702 // overrun, then startm to get something to handle the
5705 // See issue 42515 and
5706 // https://gnats.netbsd.org/cgi-bin/query-pr-single.pl?number=50094.
5707 if next := timeSleepUntil(); next < now {
5708 startm(nil, false, false)
5711 if scavenger.sysmonWake.Load() != 0 {
5712 // Kick the scavenger awake if someone requested it.
5715 // retake P's blocked in syscalls
5716 // and preempt long running G's
5717 if retake(now) != 0 {
5722 // check if we need to force a GC
5723 if t := (gcTrigger{kind: gcTriggerTime, now: now}); t.test() && forcegc.idle.Load() {
5725 forcegc.idle.Store(false)
5727 list.push(forcegc.g)
5729 unlock(&forcegc.lock)
5731 if debug.schedtrace > 0 && lasttrace+int64(debug.schedtrace)*1000000 <= now {
5733 schedtrace(debug.scheddetail > 0)
5735 unlock(&sched.sysmonlock)
5739 type sysmontick struct {
5746 // forcePreemptNS is the time slice given to a G before it is
5748 const forcePreemptNS = 10 * 1000 * 1000 // 10ms
5750 func retake(now int64) uint32 {
5752 // Prevent allp slice changes. This lock will be completely
5753 // uncontended unless we're already stopping the world.
5755 // We can't use a range loop over allp because we may
5756 // temporarily drop the allpLock. Hence, we need to re-fetch
5757 // allp each time around the loop.
5758 for i := 0; i < len(allp); i++ {
5761 // This can happen if procresize has grown
5762 // allp but not yet created new Ps.
5765 pd := &pp.sysmontick
5768 if s == _Prunning || s == _Psyscall {
5769 // Preempt G if it's running for too long.
5770 t := int64(pp.schedtick)
5771 if int64(pd.schedtick) != t {
5772 pd.schedtick = uint32(t)
5774 } else if pd.schedwhen+forcePreemptNS <= now {
5776 // In case of syscall, preemptone() doesn't
5777 // work, because there is no M wired to P.
5782 // Retake P from syscall if it's there for more than 1 sysmon tick (at least 20us).
5783 t := int64(pp.syscalltick)
5784 if !sysretake && int64(pd.syscalltick) != t {
5785 pd.syscalltick = uint32(t)
5786 pd.syscallwhen = now
5789 // On the one hand we don't want to retake Ps if there is no other work to do,
5790 // but on the other hand we want to retake them eventually
5791 // because they can prevent the sysmon thread from deep sleep.
5792 if runqempty(pp) && sched.nmspinning.Load()+sched.npidle.Load() > 0 && pd.syscallwhen+10*1000*1000 > now {
5795 // Drop allpLock so we can take sched.lock.
5797 // Need to decrement number of idle locked M's
5798 // (pretending that one more is running) before the CAS.
5799 // Otherwise the M from which we retake can exit the syscall,
5800 // increment nmidle and report deadlock.
5802 if atomic.Cas(&pp.status, s, _Pidle) {
5819 // Tell all goroutines that they have been preempted and they should stop.
5820 // This function is purely best-effort. It can fail to inform a goroutine if a
5821 // processor just started running it.
5822 // No locks need to be held.
5823 // Returns true if preemption request was issued to at least one goroutine.
5824 func preemptall() bool {
5826 for _, pp := range allp {
5827 if pp.status != _Prunning {
5837 // Tell the goroutine running on processor P to stop.
5838 // This function is purely best-effort. It can incorrectly fail to inform the
5839 // goroutine. It can inform the wrong goroutine. Even if it informs the
5840 // correct goroutine, that goroutine might ignore the request if it is
5841 // simultaneously executing newstack.
5842 // No lock needs to be held.
5843 // Returns true if preemption request was issued.
5844 // The actual preemption will happen at some point in the future
5845 // and will be indicated by the gp->status no longer being
5847 func preemptone(pp *p) bool {
5849 if mp == nil || mp == getg().m {
5853 if gp == nil || gp == mp.g0 {
5859 // Every call in a goroutine checks for stack overflow by
5860 // comparing the current stack pointer to gp->stackguard0.
5861 // Setting gp->stackguard0 to StackPreempt folds
5862 // preemption into the normal stack overflow check.
5863 gp.stackguard0 = stackPreempt
5865 // Request an async preemption of this P.
5866 if preemptMSupported && debug.asyncpreemptoff == 0 {
5876 func schedtrace(detailed bool) {
5883 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)
5885 print(" gcwaiting=", sched.gcwaiting.Load(), " nmidlelocked=", sched.nmidlelocked, " stopwait=", sched.stopwait, " sysmonwait=", sched.sysmonwait.Load(), "\n")
5887 // We must be careful while reading data from P's, M's and G's.
5888 // Even if we hold schedlock, most data can be changed concurrently.
5889 // E.g. (p->m ? p->m->id : -1) can crash if p->m changes from non-nil to nil.
5890 for i, pp := range allp {
5892 h := atomic.Load(&pp.runqhead)
5893 t := atomic.Load(&pp.runqtail)
5895 print(" P", i, ": status=", pp.status, " schedtick=", pp.schedtick, " syscalltick=", pp.syscalltick, " m=")
5901 print(" runqsize=", t-h, " gfreecnt=", pp.gFree.n, " timerslen=", len(pp.timers), "\n")
5903 // In non-detailed mode format lengths of per-P run queues as:
5904 // [len1 len2 len3 len4]
5910 if i == len(allp)-1 {
5921 for mp := allm; mp != nil; mp = mp.alllink {
5923 print(" M", mp.id, ": p=")
5935 print(" mallocing=", mp.mallocing, " throwing=", mp.throwing, " preemptoff=", mp.preemptoff, " locks=", mp.locks, " dying=", mp.dying, " spinning=", mp.spinning, " blocked=", mp.blocked, " lockedg=")
5936 if lockedg := mp.lockedg.ptr(); lockedg != nil {
5944 forEachG(func(gp *g) {
5945 print(" G", gp.goid, ": status=", readgstatus(gp), "(", gp.waitreason.String(), ") m=")
5952 if lockedm := gp.lockedm.ptr(); lockedm != nil {
5962 // schedEnableUser enables or disables the scheduling of user
5965 // This does not stop already running user goroutines, so the caller
5966 // should first stop the world when disabling user goroutines.
5967 func schedEnableUser(enable bool) {
5969 if sched.disable.user == !enable {
5973 sched.disable.user = !enable
5975 n := sched.disable.n
5977 globrunqputbatch(&sched.disable.runnable, n)
5979 for ; n != 0 && sched.npidle.Load() != 0; n-- {
5980 startm(nil, false, false)
5987 // schedEnabled reports whether gp should be scheduled. It returns
5988 // false is scheduling of gp is disabled.
5990 // sched.lock must be held.
5991 func schedEnabled(gp *g) bool {
5992 assertLockHeld(&sched.lock)
5994 if sched.disable.user {
5995 return isSystemGoroutine(gp, true)
6000 // Put mp on midle list.
6001 // sched.lock must be held.
6002 // May run during STW, so write barriers are not allowed.
6004 //go:nowritebarrierrec
6006 assertLockHeld(&sched.lock)
6008 mp.schedlink = sched.midle
6014 // Try to get an m from midle list.
6015 // sched.lock must be held.
6016 // May run during STW, so write barriers are not allowed.
6018 //go:nowritebarrierrec
6020 assertLockHeld(&sched.lock)
6022 mp := sched.midle.ptr()
6024 sched.midle = mp.schedlink
6030 // Put gp on the global runnable queue.
6031 // sched.lock must be held.
6032 // May run during STW, so write barriers are not allowed.
6034 //go:nowritebarrierrec
6035 func globrunqput(gp *g) {
6036 assertLockHeld(&sched.lock)
6038 sched.runq.pushBack(gp)
6042 // Put gp at the head of the global runnable queue.
6043 // sched.lock must be held.
6044 // May run during STW, so write barriers are not allowed.
6046 //go:nowritebarrierrec
6047 func globrunqputhead(gp *g) {
6048 assertLockHeld(&sched.lock)
6054 // Put a batch of runnable goroutines on the global runnable queue.
6055 // This clears *batch.
6056 // sched.lock must be held.
6057 // May run during STW, so write barriers are not allowed.
6059 //go:nowritebarrierrec
6060 func globrunqputbatch(batch *gQueue, n int32) {
6061 assertLockHeld(&sched.lock)
6063 sched.runq.pushBackAll(*batch)
6068 // Try get a batch of G's from the global runnable queue.
6069 // sched.lock must be held.
6070 func globrunqget(pp *p, max int32) *g {
6071 assertLockHeld(&sched.lock)
6073 if sched.runqsize == 0 {
6077 n := sched.runqsize/gomaxprocs + 1
6078 if n > sched.runqsize {
6081 if max > 0 && n > max {
6084 if n > int32(len(pp.runq))/2 {
6085 n = int32(len(pp.runq)) / 2
6090 gp := sched.runq.pop()
6093 gp1 := sched.runq.pop()
6094 runqput(pp, gp1, false)
6099 // pMask is an atomic bitstring with one bit per P.
6102 // read returns true if P id's bit is set.
6103 func (p pMask) read(id uint32) bool {
6105 mask := uint32(1) << (id % 32)
6106 return (atomic.Load(&p[word]) & mask) != 0
6109 // set sets P id's bit.
6110 func (p pMask) set(id int32) {
6112 mask := uint32(1) << (id % 32)
6113 atomic.Or(&p[word], mask)
6116 // clear clears P id's bit.
6117 func (p pMask) clear(id int32) {
6119 mask := uint32(1) << (id % 32)
6120 atomic.And(&p[word], ^mask)
6123 // updateTimerPMask clears pp's timer mask if it has no timers on its heap.
6125 // Ideally, the timer mask would be kept immediately consistent on any timer
6126 // operations. Unfortunately, updating a shared global data structure in the
6127 // timer hot path adds too much overhead in applications frequently switching
6128 // between no timers and some timers.
6130 // As a compromise, the timer mask is updated only on pidleget / pidleput. A
6131 // running P (returned by pidleget) may add a timer at any time, so its mask
6132 // must be set. An idle P (passed to pidleput) cannot add new timers while
6133 // idle, so if it has no timers at that time, its mask may be cleared.
6135 // Thus, we get the following effects on timer-stealing in findrunnable:
6137 // - Idle Ps with no timers when they go idle are never checked in findrunnable
6138 // (for work- or timer-stealing; this is the ideal case).
6139 // - Running Ps must always be checked.
6140 // - Idle Ps whose timers are stolen must continue to be checked until they run
6141 // again, even after timer expiration.
6143 // When the P starts running again, the mask should be set, as a timer may be
6144 // added at any time.
6146 // TODO(prattmic): Additional targeted updates may improve the above cases.
6147 // e.g., updating the mask when stealing a timer.
6148 func updateTimerPMask(pp *p) {
6149 if pp.numTimers.Load() > 0 {
6153 // Looks like there are no timers, however another P may transiently
6154 // decrement numTimers when handling a timerModified timer in
6155 // checkTimers. We must take timersLock to serialize with these changes.
6156 lock(&pp.timersLock)
6157 if pp.numTimers.Load() == 0 {
6158 timerpMask.clear(pp.id)
6160 unlock(&pp.timersLock)
6163 // pidleput puts p on the _Pidle list. now must be a relatively recent call
6164 // to nanotime or zero. Returns now or the current time if now was zero.
6166 // This releases ownership of p. Once sched.lock is released it is no longer
6169 // sched.lock must be held.
6171 // May run during STW, so write barriers are not allowed.
6173 //go:nowritebarrierrec
6174 func pidleput(pp *p, now int64) int64 {
6175 assertLockHeld(&sched.lock)
6178 throw("pidleput: P has non-empty run queue")
6183 updateTimerPMask(pp) // clear if there are no timers.
6184 idlepMask.set(pp.id)
6185 pp.link = sched.pidle
6188 if !pp.limiterEvent.start(limiterEventIdle, now) {
6189 throw("must be able to track idle limiter event")
6194 // pidleget tries to get a p from the _Pidle list, acquiring ownership.
6196 // sched.lock must be held.
6198 // May run during STW, so write barriers are not allowed.
6200 //go:nowritebarrierrec
6201 func pidleget(now int64) (*p, int64) {
6202 assertLockHeld(&sched.lock)
6204 pp := sched.pidle.ptr()
6206 // Timer may get added at any time now.
6210 timerpMask.set(pp.id)
6211 idlepMask.clear(pp.id)
6212 sched.pidle = pp.link
6213 sched.npidle.Add(-1)
6214 pp.limiterEvent.stop(limiterEventIdle, now)
6219 // pidlegetSpinning tries to get a p from the _Pidle list, acquiring ownership.
6220 // This is called by spinning Ms (or callers than need a spinning M) that have
6221 // found work. If no P is available, this must synchronized with non-spinning
6222 // Ms that may be preparing to drop their P without discovering this work.
6224 // sched.lock must be held.
6226 // May run during STW, so write barriers are not allowed.
6228 //go:nowritebarrierrec
6229 func pidlegetSpinning(now int64) (*p, int64) {
6230 assertLockHeld(&sched.lock)
6232 pp, now := pidleget(now)
6234 // See "Delicate dance" comment in findrunnable. We found work
6235 // that we cannot take, we must synchronize with non-spinning
6236 // Ms that may be preparing to drop their P.
6237 sched.needspinning.Store(1)
6244 // runqempty reports whether pp has no Gs on its local run queue.
6245 // It never returns true spuriously.
6246 func runqempty(pp *p) bool {
6247 // Defend against a race where 1) pp has G1 in runqnext but runqhead == runqtail,
6248 // 2) runqput on pp kicks G1 to the runq, 3) runqget on pp empties runqnext.
6249 // Simply observing that runqhead == runqtail and then observing that runqnext == nil
6250 // does not mean the queue is empty.
6252 head := atomic.Load(&pp.runqhead)
6253 tail := atomic.Load(&pp.runqtail)
6254 runnext := atomic.Loaduintptr((*uintptr)(unsafe.Pointer(&pp.runnext)))
6255 if tail == atomic.Load(&pp.runqtail) {
6256 return head == tail && runnext == 0
6261 // To shake out latent assumptions about scheduling order,
6262 // we introduce some randomness into scheduling decisions
6263 // when running with the race detector.
6264 // The need for this was made obvious by changing the
6265 // (deterministic) scheduling order in Go 1.5 and breaking
6266 // many poorly-written tests.
6267 // With the randomness here, as long as the tests pass
6268 // consistently with -race, they shouldn't have latent scheduling
6270 const randomizeScheduler = raceenabled
6272 // runqput tries to put g on the local runnable queue.
6273 // If next is false, runqput adds g to the tail of the runnable queue.
6274 // If next is true, runqput puts g in the pp.runnext slot.
6275 // If the run queue is full, runnext puts g on the global queue.
6276 // Executed only by the owner P.
6277 func runqput(pp *p, gp *g, next bool) {
6278 if randomizeScheduler && next && fastrandn(2) == 0 {
6284 oldnext := pp.runnext
6285 if !pp.runnext.cas(oldnext, guintptr(unsafe.Pointer(gp))) {
6291 // Kick the old runnext out to the regular run queue.
6296 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with consumers
6298 if t-h < uint32(len(pp.runq)) {
6299 pp.runq[t%uint32(len(pp.runq))].set(gp)
6300 atomic.StoreRel(&pp.runqtail, t+1) // store-release, makes the item available for consumption
6303 if runqputslow(pp, gp, h, t) {
6306 // the queue is not full, now the put above must succeed
6310 // Put g and a batch of work from local runnable queue on global queue.
6311 // Executed only by the owner P.
6312 func runqputslow(pp *p, gp *g, h, t uint32) bool {
6313 var batch [len(pp.runq)/2 + 1]*g
6315 // First, grab a batch from local queue.
6318 if n != uint32(len(pp.runq)/2) {
6319 throw("runqputslow: queue is not full")
6321 for i := uint32(0); i < n; i++ {
6322 batch[i] = pp.runq[(h+i)%uint32(len(pp.runq))].ptr()
6324 if !atomic.CasRel(&pp.runqhead, h, h+n) { // cas-release, commits consume
6329 if randomizeScheduler {
6330 for i := uint32(1); i <= n; i++ {
6331 j := fastrandn(i + 1)
6332 batch[i], batch[j] = batch[j], batch[i]
6336 // Link the goroutines.
6337 for i := uint32(0); i < n; i++ {
6338 batch[i].schedlink.set(batch[i+1])
6341 q.head.set(batch[0])
6342 q.tail.set(batch[n])
6344 // Now put the batch on global queue.
6346 globrunqputbatch(&q, int32(n+1))
6351 // runqputbatch tries to put all the G's on q on the local runnable queue.
6352 // If the queue is full, they are put on the global queue; in that case
6353 // this will temporarily acquire the scheduler lock.
6354 // Executed only by the owner P.
6355 func runqputbatch(pp *p, q *gQueue, qsize int) {
6356 h := atomic.LoadAcq(&pp.runqhead)
6359 for !q.empty() && t-h < uint32(len(pp.runq)) {
6361 pp.runq[t%uint32(len(pp.runq))].set(gp)
6367 if randomizeScheduler {
6368 off := func(o uint32) uint32 {
6369 return (pp.runqtail + o) % uint32(len(pp.runq))
6371 for i := uint32(1); i < n; i++ {
6372 j := fastrandn(i + 1)
6373 pp.runq[off(i)], pp.runq[off(j)] = pp.runq[off(j)], pp.runq[off(i)]
6377 atomic.StoreRel(&pp.runqtail, t)
6380 globrunqputbatch(q, int32(qsize))
6385 // Get g from local runnable queue.
6386 // If inheritTime is true, gp should inherit the remaining time in the
6387 // current time slice. Otherwise, it should start a new time slice.
6388 // Executed only by the owner P.
6389 func runqget(pp *p) (gp *g, inheritTime bool) {
6390 // If there's a runnext, it's the next G to run.
6392 // If the runnext is non-0 and the CAS fails, it could only have been stolen by another P,
6393 // because other Ps can race to set runnext to 0, but only the current P can set it to non-0.
6394 // Hence, there's no need to retry this CAS if it fails.
6395 if next != 0 && pp.runnext.cas(next, 0) {
6396 return next.ptr(), true
6400 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with other consumers
6405 gp := pp.runq[h%uint32(len(pp.runq))].ptr()
6406 if atomic.CasRel(&pp.runqhead, h, h+1) { // cas-release, commits consume
6412 // runqdrain drains the local runnable queue of pp and returns all goroutines in it.
6413 // Executed only by the owner P.
6414 func runqdrain(pp *p) (drainQ gQueue, n uint32) {
6415 oldNext := pp.runnext
6416 if oldNext != 0 && pp.runnext.cas(oldNext, 0) {
6417 drainQ.pushBack(oldNext.ptr())
6422 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with other consumers
6428 if qn > uint32(len(pp.runq)) { // read inconsistent h and t
6432 if !atomic.CasRel(&pp.runqhead, h, h+qn) { // cas-release, commits consume
6436 // We've inverted the order in which it gets G's from the local P's runnable queue
6437 // and then advances the head pointer because we don't want to mess up the statuses of G's
6438 // while runqdrain() and runqsteal() are running in parallel.
6439 // Thus we should advance the head pointer before draining the local P into a gQueue,
6440 // so that we can update any gp.schedlink only after we take the full ownership of G,
6441 // meanwhile, other P's can't access to all G's in local P's runnable queue and steal them.
6442 // See https://groups.google.com/g/golang-dev/c/0pTKxEKhHSc/m/6Q85QjdVBQAJ for more details.
6443 for i := uint32(0); i < qn; i++ {
6444 gp := pp.runq[(h+i)%uint32(len(pp.runq))].ptr()
6451 // Grabs a batch of goroutines from pp's runnable queue into batch.
6452 // Batch is a ring buffer starting at batchHead.
6453 // Returns number of grabbed goroutines.
6454 // Can be executed by any P.
6455 func runqgrab(pp *p, batch *[256]guintptr, batchHead uint32, stealRunNextG bool) uint32 {
6457 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with other consumers
6458 t := atomic.LoadAcq(&pp.runqtail) // load-acquire, synchronize with the producer
6463 // Try to steal from pp.runnext.
6464 if next := pp.runnext; next != 0 {
6465 if pp.status == _Prunning {
6466 // Sleep to ensure that pp isn't about to run the g
6467 // we are about to steal.
6468 // The important use case here is when the g running
6469 // on pp ready()s another g and then almost
6470 // immediately blocks. Instead of stealing runnext
6471 // in this window, back off to give pp a chance to
6472 // schedule runnext. This will avoid thrashing gs
6473 // between different Ps.
6474 // A sync chan send/recv takes ~50ns as of time of
6475 // writing, so 3us gives ~50x overshoot.
6476 if GOOS != "windows" && GOOS != "openbsd" && GOOS != "netbsd" {
6479 // On some platforms system timer granularity is
6480 // 1-15ms, which is way too much for this
6481 // optimization. So just yield.
6485 if !pp.runnext.cas(next, 0) {
6488 batch[batchHead%uint32(len(batch))] = next
6494 if n > uint32(len(pp.runq)/2) { // read inconsistent h and t
6497 for i := uint32(0); i < n; i++ {
6498 g := pp.runq[(h+i)%uint32(len(pp.runq))]
6499 batch[(batchHead+i)%uint32(len(batch))] = g
6501 if atomic.CasRel(&pp.runqhead, h, h+n) { // cas-release, commits consume
6507 // Steal half of elements from local runnable queue of p2
6508 // and put onto local runnable queue of p.
6509 // Returns one of the stolen elements (or nil if failed).
6510 func runqsteal(pp, p2 *p, stealRunNextG bool) *g {
6512 n := runqgrab(p2, &pp.runq, t, stealRunNextG)
6517 gp := pp.runq[(t+n)%uint32(len(pp.runq))].ptr()
6521 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with consumers
6522 if t-h+n >= uint32(len(pp.runq)) {
6523 throw("runqsteal: runq overflow")
6525 atomic.StoreRel(&pp.runqtail, t+n) // store-release, makes the item available for consumption
6529 // A gQueue is a dequeue of Gs linked through g.schedlink. A G can only
6530 // be on one gQueue or gList at a time.
6531 type gQueue struct {
6536 // empty reports whether q is empty.
6537 func (q *gQueue) empty() bool {
6541 // push adds gp to the head of q.
6542 func (q *gQueue) push(gp *g) {
6543 gp.schedlink = q.head
6550 // pushBack adds gp to the tail of q.
6551 func (q *gQueue) pushBack(gp *g) {
6554 q.tail.ptr().schedlink.set(gp)
6561 // pushBackAll adds all Gs in q2 to the tail of q. After this q2 must
6563 func (q *gQueue) pushBackAll(q2 gQueue) {
6567 q2.tail.ptr().schedlink = 0
6569 q.tail.ptr().schedlink = q2.head
6576 // pop removes and returns the head of queue q. It returns nil if
6578 func (q *gQueue) pop() *g {
6581 q.head = gp.schedlink
6589 // popList takes all Gs in q and returns them as a gList.
6590 func (q *gQueue) popList() gList {
6591 stack := gList{q.head}
6596 // A gList is a list of Gs linked through g.schedlink. A G can only be
6597 // on one gQueue or gList at a time.
6602 // empty reports whether l is empty.
6603 func (l *gList) empty() bool {
6607 // push adds gp to the head of l.
6608 func (l *gList) push(gp *g) {
6609 gp.schedlink = l.head
6613 // pushAll prepends all Gs in q to l.
6614 func (l *gList) pushAll(q gQueue) {
6616 q.tail.ptr().schedlink = l.head
6621 // pop removes and returns the head of l. If l is empty, it returns nil.
6622 func (l *gList) pop() *g {
6625 l.head = gp.schedlink
6630 //go:linkname setMaxThreads runtime/debug.setMaxThreads
6631 func setMaxThreads(in int) (out int) {
6633 out = int(sched.maxmcount)
6634 if in > 0x7fffffff { // MaxInt32
6635 sched.maxmcount = 0x7fffffff
6637 sched.maxmcount = int32(in)
6645 func procPin() int {
6650 return int(mp.p.ptr().id)
6659 //go:linkname sync_runtime_procPin sync.runtime_procPin
6661 func sync_runtime_procPin() int {
6665 //go:linkname sync_runtime_procUnpin sync.runtime_procUnpin
6667 func sync_runtime_procUnpin() {
6671 //go:linkname sync_atomic_runtime_procPin sync/atomic.runtime_procPin
6673 func sync_atomic_runtime_procPin() int {
6677 //go:linkname sync_atomic_runtime_procUnpin sync/atomic.runtime_procUnpin
6679 func sync_atomic_runtime_procUnpin() {
6683 // Active spinning for sync.Mutex.
6685 //go:linkname sync_runtime_canSpin sync.runtime_canSpin
6687 func sync_runtime_canSpin(i int) bool {
6688 // sync.Mutex is cooperative, so we are conservative with spinning.
6689 // Spin only few times and only if running on a multicore machine and
6690 // GOMAXPROCS>1 and there is at least one other running P and local runq is empty.
6691 // As opposed to runtime mutex we don't do passive spinning here,
6692 // because there can be work on global runq or on other Ps.
6693 if i >= active_spin || ncpu <= 1 || gomaxprocs <= sched.npidle.Load()+sched.nmspinning.Load()+1 {
6696 if p := getg().m.p.ptr(); !runqempty(p) {
6702 //go:linkname sync_runtime_doSpin sync.runtime_doSpin
6704 func sync_runtime_doSpin() {
6705 procyield(active_spin_cnt)
6708 var stealOrder randomOrder
6710 // randomOrder/randomEnum are helper types for randomized work stealing.
6711 // They allow to enumerate all Ps in different pseudo-random orders without repetitions.
6712 // The algorithm is based on the fact that if we have X such that X and GOMAXPROCS
6713 // are coprime, then a sequences of (i + X) % GOMAXPROCS gives the required enumeration.
6714 type randomOrder struct {
6719 type randomEnum struct {
6726 func (ord *randomOrder) reset(count uint32) {
6728 ord.coprimes = ord.coprimes[:0]
6729 for i := uint32(1); i <= count; i++ {
6730 if gcd(i, count) == 1 {
6731 ord.coprimes = append(ord.coprimes, i)
6736 func (ord *randomOrder) start(i uint32) randomEnum {
6740 inc: ord.coprimes[i/ord.count%uint32(len(ord.coprimes))],
6744 func (enum *randomEnum) done() bool {
6745 return enum.i == enum.count
6748 func (enum *randomEnum) next() {
6750 enum.pos = (enum.pos + enum.inc) % enum.count
6753 func (enum *randomEnum) position() uint32 {
6757 func gcd(a, b uint32) uint32 {
6764 // An initTask represents the set of initializations that need to be done for a package.
6765 // Keep in sync with ../../test/noinit.go:initTask
6766 type initTask struct {
6767 state uint32 // 0 = uninitialized, 1 = in progress, 2 = done
6769 // followed by nfns pcs, uintptr sized, one per init function to run
6772 // inittrace stores statistics for init functions which are
6773 // updated by malloc and newproc when active is true.
6774 var inittrace tracestat
6776 type tracestat struct {
6777 active bool // init tracing activation status
6778 id uint64 // init goroutine id
6779 allocs uint64 // heap allocations
6780 bytes uint64 // heap allocated bytes
6783 func doInit(ts []*initTask) {
6784 for _, t := range ts {
6789 func doInit1(t *initTask) {
6791 case 2: // fully initialized
6793 case 1: // initialization in progress
6794 throw("recursive call during initialization - linker skew")
6795 default: // not initialized yet
6796 t.state = 1 // initialization in progress
6803 if inittrace.active {
6805 // Load stats non-atomically since tracinit is updated only by this init goroutine.
6810 // We should have pruned all of these in the linker.
6811 throw("inittask with no functions")
6814 firstFunc := add(unsafe.Pointer(t), 8)
6815 for i := uint32(0); i < t.nfns; i++ {
6816 p := add(firstFunc, uintptr(i)*goarch.PtrSize)
6817 f := *(*func())(unsafe.Pointer(&p))
6821 if inittrace.active {
6823 // Load stats non-atomically since tracinit is updated only by this init goroutine.
6826 f := *(*func())(unsafe.Pointer(&firstFunc))
6827 pkg := funcpkgpath(findfunc(abi.FuncPCABIInternal(f)))
6830 print("init ", pkg, " @")
6831 print(string(fmtNSAsMS(sbuf[:], uint64(start-runtimeInitTime))), " ms, ")
6832 print(string(fmtNSAsMS(sbuf[:], uint64(end-start))), " ms clock, ")
6833 print(string(itoa(sbuf[:], after.bytes-before.bytes)), " bytes, ")
6834 print(string(itoa(sbuf[:], after.allocs-before.allocs)), " allocs")
6838 t.state = 2 // initialization done