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).
248 for _, m := range activeModules() {
252 // Disable init tracing after main init done to avoid overhead
253 // of collecting statistics in malloc and newproc
254 inittrace.active = false
256 close(main_init_done)
261 if isarchive || islibrary {
262 // A program compiled with -buildmode=c-archive or c-shared
263 // has a main, but it is not executed.
266 fn := main_main // make an indirect call, as the linker doesn't know the address of the main package when laying down the runtime
269 runExitHooks(0) // run hooks now, since racefini does not return
273 // Make racy client program work: if panicking on
274 // another goroutine at the same time as main returns,
275 // let the other goroutine finish printing the panic trace.
276 // Once it does, it will exit. See issues 3934 and 20018.
277 if runningPanicDefers.Load() != 0 {
278 // Running deferred functions should not take long.
279 for c := 0; c < 1000; c++ {
280 if runningPanicDefers.Load() == 0 {
286 if panicking.Load() != 0 {
287 gopark(nil, nil, waitReasonPanicWait, traceBlockForever, 1)
298 // os_beforeExit is called from os.Exit(0).
300 //go:linkname os_beforeExit os.runtime_beforeExit
301 func os_beforeExit(exitCode int) {
302 runExitHooks(exitCode)
303 if exitCode == 0 && raceenabled {
308 // start forcegc helper goroutine
313 func forcegchelper() {
315 lockInit(&forcegc.lock, lockRankForcegc)
318 if forcegc.idle.Load() {
319 throw("forcegc: phase error")
321 forcegc.idle.Store(true)
322 goparkunlock(&forcegc.lock, waitReasonForceGCIdle, traceBlockSystemGoroutine, 1)
323 // this goroutine is explicitly resumed by sysmon
324 if debug.gctrace > 0 {
327 // Time-triggered, fully concurrent.
328 gcStart(gcTrigger{kind: gcTriggerTime, now: nanotime()})
332 // Gosched yields the processor, allowing other goroutines to run. It does not
333 // suspend the current goroutine, so execution resumes automatically.
341 // goschedguarded yields the processor like gosched, but also checks
342 // for forbidden states and opts out of the yield in those cases.
345 func goschedguarded() {
346 mcall(goschedguarded_m)
349 // goschedIfBusy yields the processor like gosched, but only does so if
350 // there are no idle Ps or if we're on the only P and there's nothing in
351 // the run queue. In both cases, there is freely available idle time.
354 func goschedIfBusy() {
356 // Call gosched if gp.preempt is set; we may be in a tight loop that
357 // doesn't otherwise yield.
358 if !gp.preempt && sched.npidle.Load() > 0 {
364 // Puts the current goroutine into a waiting state and calls unlockf on the
367 // If unlockf returns false, the goroutine is resumed.
369 // unlockf must not access this G's stack, as it may be moved between
370 // the call to gopark and the call to unlockf.
372 // Note that because unlockf is called after putting the G into a waiting
373 // state, the G may have already been readied by the time unlockf is called
374 // unless there is external synchronization preventing the G from being
375 // readied. If unlockf returns false, it must guarantee that the G cannot be
376 // externally readied.
378 // Reason explains why the goroutine has been parked. It is displayed in stack
379 // traces and heap dumps. Reasons should be unique and descriptive. Do not
380 // re-use reasons, add new ones.
381 func gopark(unlockf func(*g, unsafe.Pointer) bool, lock unsafe.Pointer, reason waitReason, traceReason traceBlockReason, traceskip int) {
382 if reason != waitReasonSleep {
383 checkTimeouts() // timeouts may expire while two goroutines keep the scheduler busy
387 status := readgstatus(gp)
388 if status != _Grunning && status != _Gscanrunning {
389 throw("gopark: bad g status")
392 mp.waitunlockf = unlockf
393 gp.waitreason = reason
394 mp.waitTraceBlockReason = traceReason
395 mp.waitTraceSkip = traceskip
397 // can't do anything that might move the G between Ms here.
401 // Puts the current goroutine into a waiting state and unlocks the lock.
402 // The goroutine can be made runnable again by calling goready(gp).
403 func goparkunlock(lock *mutex, reason waitReason, traceReason traceBlockReason, traceskip int) {
404 gopark(parkunlock_c, unsafe.Pointer(lock), reason, traceReason, traceskip)
407 func goready(gp *g, traceskip int) {
409 ready(gp, traceskip, true)
414 func acquireSudog() *sudog {
415 // Delicate dance: the semaphore implementation calls
416 // acquireSudog, acquireSudog calls new(sudog),
417 // new calls malloc, malloc can call the garbage collector,
418 // and the garbage collector calls the semaphore implementation
420 // Break the cycle by doing acquirem/releasem around new(sudog).
421 // The acquirem/releasem increments m.locks during new(sudog),
422 // which keeps the garbage collector from being invoked.
425 if len(pp.sudogcache) == 0 {
426 lock(&sched.sudoglock)
427 // First, try to grab a batch from central cache.
428 for len(pp.sudogcache) < cap(pp.sudogcache)/2 && sched.sudogcache != nil {
429 s := sched.sudogcache
430 sched.sudogcache = s.next
432 pp.sudogcache = append(pp.sudogcache, s)
434 unlock(&sched.sudoglock)
435 // If the central cache is empty, allocate a new one.
436 if len(pp.sudogcache) == 0 {
437 pp.sudogcache = append(pp.sudogcache, new(sudog))
440 n := len(pp.sudogcache)
441 s := pp.sudogcache[n-1]
442 pp.sudogcache[n-1] = nil
443 pp.sudogcache = pp.sudogcache[:n-1]
445 throw("acquireSudog: found s.elem != nil in cache")
452 func releaseSudog(s *sudog) {
454 throw("runtime: sudog with non-nil elem")
457 throw("runtime: sudog with non-false isSelect")
460 throw("runtime: sudog with non-nil next")
463 throw("runtime: sudog with non-nil prev")
465 if s.waitlink != nil {
466 throw("runtime: sudog with non-nil waitlink")
469 throw("runtime: sudog with non-nil c")
473 throw("runtime: releaseSudog with non-nil gp.param")
475 mp := acquirem() // avoid rescheduling to another P
477 if len(pp.sudogcache) == cap(pp.sudogcache) {
478 // Transfer half of local cache to the central cache.
479 var first, last *sudog
480 for len(pp.sudogcache) > cap(pp.sudogcache)/2 {
481 n := len(pp.sudogcache)
482 p := pp.sudogcache[n-1]
483 pp.sudogcache[n-1] = nil
484 pp.sudogcache = pp.sudogcache[:n-1]
492 lock(&sched.sudoglock)
493 last.next = sched.sudogcache
494 sched.sudogcache = first
495 unlock(&sched.sudoglock)
497 pp.sudogcache = append(pp.sudogcache, s)
501 // called from assembly.
502 func badmcall(fn func(*g)) {
503 throw("runtime: mcall called on m->g0 stack")
506 func badmcall2(fn func(*g)) {
507 throw("runtime: mcall function returned")
510 func badreflectcall() {
511 panic(plainError("arg size to reflect.call more than 1GB"))
515 //go:nowritebarrierrec
516 func badmorestackg0() {
517 writeErrStr("fatal: morestack on g0\n")
521 //go:nowritebarrierrec
522 func badmorestackgsignal() {
523 writeErrStr("fatal: morestack on gsignal\n")
531 func lockedOSThread() bool {
533 return gp.lockedm != 0 && gp.m.lockedg != 0
537 // allgs contains all Gs ever created (including dead Gs), and thus
540 // Access via the slice is protected by allglock or stop-the-world.
541 // Readers that cannot take the lock may (carefully!) use the atomic
546 // allglen and allgptr are atomic variables that contain len(allgs) and
547 // &allgs[0] respectively. Proper ordering depends on totally-ordered
548 // loads and stores. Writes are protected by allglock.
550 // allgptr is updated before allglen. Readers should read allglen
551 // before allgptr to ensure that allglen is always <= len(allgptr). New
552 // Gs appended during the race can be missed. For a consistent view of
553 // all Gs, allglock must be held.
555 // allgptr copies should always be stored as a concrete type or
556 // unsafe.Pointer, not uintptr, to ensure that GC can still reach it
557 // even if it points to a stale array.
562 func allgadd(gp *g) {
563 if readgstatus(gp) == _Gidle {
564 throw("allgadd: bad status Gidle")
568 allgs = append(allgs, gp)
569 if &allgs[0] != allgptr {
570 atomicstorep(unsafe.Pointer(&allgptr), unsafe.Pointer(&allgs[0]))
572 atomic.Storeuintptr(&allglen, uintptr(len(allgs)))
576 // allGsSnapshot returns a snapshot of the slice of all Gs.
578 // The world must be stopped or allglock must be held.
579 func allGsSnapshot() []*g {
580 assertWorldStoppedOrLockHeld(&allglock)
582 // Because the world is stopped or allglock is held, allgadd
583 // cannot happen concurrently with this. allgs grows
584 // monotonically and existing entries never change, so we can
585 // simply return a copy of the slice header. For added safety,
586 // we trim everything past len because that can still change.
587 return allgs[:len(allgs):len(allgs)]
590 // atomicAllG returns &allgs[0] and len(allgs) for use with atomicAllGIndex.
591 func atomicAllG() (**g, uintptr) {
592 length := atomic.Loaduintptr(&allglen)
593 ptr := (**g)(atomic.Loadp(unsafe.Pointer(&allgptr)))
597 // atomicAllGIndex returns ptr[i] with the allgptr returned from atomicAllG.
598 func atomicAllGIndex(ptr **g, i uintptr) *g {
599 return *(**g)(add(unsafe.Pointer(ptr), i*goarch.PtrSize))
602 // forEachG calls fn on every G from allgs.
604 // forEachG takes a lock to exclude concurrent addition of new Gs.
605 func forEachG(fn func(gp *g)) {
607 for _, gp := range allgs {
613 // forEachGRace calls fn on every G from allgs.
615 // forEachGRace avoids locking, but does not exclude addition of new Gs during
616 // execution, which may be missed.
617 func forEachGRace(fn func(gp *g)) {
618 ptr, length := atomicAllG()
619 for i := uintptr(0); i < length; i++ {
620 gp := atomicAllGIndex(ptr, i)
627 // Number of goroutine ids to grab from sched.goidgen to local per-P cache at once.
628 // 16 seems to provide enough amortization, but other than that it's mostly arbitrary number.
632 // cpuinit sets up CPU feature flags and calls internal/cpu.Initialize. env should be the complete
633 // value of the GODEBUG environment variable.
634 func cpuinit(env string) {
636 case "aix", "darwin", "ios", "dragonfly", "freebsd", "netbsd", "openbsd", "illumos", "solaris", "linux":
637 cpu.DebugOptions = true
641 // Support cpu feature variables are used in code generated by the compiler
642 // to guard execution of instructions that can not be assumed to be always supported.
645 x86HasPOPCNT = cpu.X86.HasPOPCNT
646 x86HasSSE41 = cpu.X86.HasSSE41
647 x86HasFMA = cpu.X86.HasFMA
650 armHasVFPv4 = cpu.ARM.HasVFPv4
653 arm64HasATOMICS = cpu.ARM64.HasATOMICS
657 // getGodebugEarly extracts the environment variable GODEBUG from the environment on
658 // Unix-like operating systems and returns it. This function exists to extract GODEBUG
659 // early before much of the runtime is initialized.
660 func getGodebugEarly() string {
661 const prefix = "GODEBUG="
664 case "aix", "darwin", "ios", "dragonfly", "freebsd", "netbsd", "openbsd", "illumos", "solaris", "linux":
665 // Similar to goenv_unix but extracts the environment value for
667 // TODO(moehrmann): remove when general goenvs() can be called before cpuinit()
669 for argv_index(argv, argc+1+n) != nil {
673 for i := int32(0); i < n; i++ {
674 p := argv_index(argv, argc+1+i)
675 s := unsafe.String(p, findnull(p))
677 if hasPrefix(s, prefix) {
678 env = gostring(p)[len(prefix):]
686 // The bootstrap sequence is:
690 // make & queue new G
691 // call runtime·mstart
693 // The new G calls runtime·main.
695 lockInit(&sched.lock, lockRankSched)
696 lockInit(&sched.sysmonlock, lockRankSysmon)
697 lockInit(&sched.deferlock, lockRankDefer)
698 lockInit(&sched.sudoglock, lockRankSudog)
699 lockInit(&deadlock, lockRankDeadlock)
700 lockInit(&paniclk, lockRankPanic)
701 lockInit(&allglock, lockRankAllg)
702 lockInit(&allpLock, lockRankAllp)
703 lockInit(&reflectOffs.lock, lockRankReflectOffs)
704 lockInit(&finlock, lockRankFin)
705 lockInit(&cpuprof.lock, lockRankCpuprof)
707 // Enforce that this lock is always a leaf lock.
708 // All of this lock's critical sections should be
710 lockInit(&memstats.heapStats.noPLock, lockRankLeafRank)
712 // raceinit must be the first call to race detector.
713 // In particular, it must be done before mallocinit below calls racemapshadow.
716 gp.racectx, raceprocctx0 = raceinit()
719 sched.maxmcount = 10000
721 // The world starts stopped.
727 godebug := getGodebugEarly()
728 initPageTrace(godebug) // must run after mallocinit but before anything allocates
729 cpuinit(godebug) // must run before alginit
730 alginit() // maps, hash, fastrand must not be used before this call
731 fastrandinit() // must run before mcommoninit
732 mcommoninit(gp.m, -1)
733 modulesinit() // provides activeModules
734 typelinksinit() // uses maps, activeModules
735 itabsinit() // uses activeModules
736 stkobjinit() // must run before GC starts
738 sigsave(&gp.m.sigmask)
739 initSigmask = gp.m.sigmask
748 // if disableMemoryProfiling is set, update MemProfileRate to 0 to turn off memprofile.
749 // Note: parsedebugvars may update MemProfileRate, but when disableMemoryProfiling is
750 // set to true by the linker, it means that nothing is consuming the profile, it is
751 // safe to set MemProfileRate to 0.
752 if disableMemoryProfiling {
757 sched.lastpoll.Store(nanotime())
759 if n, ok := atoi32(gogetenv("GOMAXPROCS")); ok && n > 0 {
762 if procresize(procs) != nil {
763 throw("unknown runnable goroutine during bootstrap")
767 // World is effectively started now, as P's can run.
770 if buildVersion == "" {
771 // Condition should never trigger. This code just serves
772 // to ensure runtime·buildVersion is kept in the resulting binary.
773 buildVersion = "unknown"
775 if len(modinfo) == 1 {
776 // Condition should never trigger. This code just serves
777 // to ensure runtime·modinfo is kept in the resulting binary.
782 func dumpgstatus(gp *g) {
784 print("runtime: gp: gp=", gp, ", goid=", gp.goid, ", gp->atomicstatus=", readgstatus(gp), "\n")
785 print("runtime: getg: g=", thisg, ", goid=", thisg.goid, ", g->atomicstatus=", readgstatus(thisg), "\n")
788 // sched.lock must be held.
790 assertLockHeld(&sched.lock)
792 // Exclude extra M's, which are used for cgocallback from threads
795 // The purpose of the SetMaxThreads limit is to avoid accidental fork
796 // bomb from something like millions of goroutines blocking on system
797 // calls, causing the runtime to create millions of threads. By
798 // definition, this isn't a problem for threads created in C, so we
799 // exclude them from the limit. See https://go.dev/issue/60004.
800 count := mcount() - int32(extraMInUse.Load()) - int32(extraMLength.Load())
801 if count > sched.maxmcount {
802 print("runtime: program exceeds ", sched.maxmcount, "-thread limit\n")
803 throw("thread exhaustion")
807 // mReserveID returns the next ID to use for a new m. This new m is immediately
808 // considered 'running' by checkdead.
810 // sched.lock must be held.
811 func mReserveID() int64 {
812 assertLockHeld(&sched.lock)
814 if sched.mnext+1 < sched.mnext {
815 throw("runtime: thread ID overflow")
823 // Pre-allocated ID may be passed as 'id', or omitted by passing -1.
824 func mcommoninit(mp *m, id int64) {
827 // g0 stack won't make sense for user (and is not necessary unwindable).
829 callers(1, mp.createstack[:])
840 lo := uint32(int64Hash(uint64(mp.id), fastrandseed))
841 hi := uint32(int64Hash(uint64(cputicks()), ^fastrandseed))
845 // Same behavior as for 1.17.
846 // TODO: Simplify this.
847 if goarch.BigEndian {
848 mp.fastrand = uint64(lo)<<32 | uint64(hi)
850 mp.fastrand = uint64(hi)<<32 | uint64(lo)
854 if mp.gsignal != nil {
855 mp.gsignal.stackguard1 = mp.gsignal.stack.lo + stackGuard
858 // Add to allm so garbage collector doesn't free g->m
859 // when it is just in a register or thread-local storage.
862 // NumCgoCall() iterates over allm w/o schedlock,
863 // so we need to publish it safely.
864 atomicstorep(unsafe.Pointer(&allm), unsafe.Pointer(mp))
867 // Allocate memory to hold a cgo traceback if the cgo call crashes.
868 if iscgo || GOOS == "solaris" || GOOS == "illumos" || GOOS == "windows" {
869 mp.cgoCallers = new(cgoCallers)
873 func (mp *m) becomeSpinning() {
875 sched.nmspinning.Add(1)
876 sched.needspinning.Store(0)
879 func (mp *m) hasCgoOnStack() bool {
880 return mp.ncgo > 0 || mp.isextra
883 var fastrandseed uintptr
885 func fastrandinit() {
886 s := (*[unsafe.Sizeof(fastrandseed)]byte)(unsafe.Pointer(&fastrandseed))[:]
890 // Mark gp ready to run.
891 func ready(gp *g, traceskip int, next bool) {
893 traceGoUnpark(gp, traceskip)
896 status := readgstatus(gp)
899 mp := acquirem() // disable preemption because it can be holding p in a local var
900 if status&^_Gscan != _Gwaiting {
902 throw("bad g->status in ready")
905 // status is Gwaiting or Gscanwaiting, make Grunnable and put on runq
906 casgstatus(gp, _Gwaiting, _Grunnable)
907 runqput(mp.p.ptr(), gp, next)
912 // freezeStopWait is a large value that freezetheworld sets
913 // sched.stopwait to in order to request that all Gs permanently stop.
914 const freezeStopWait = 0x7fffffff
916 // freezing is set to non-zero if the runtime is trying to freeze the
918 var freezing atomic.Bool
920 // Similar to stopTheWorld but best-effort and can be called several times.
921 // There is no reverse operation, used during crashing.
922 // This function must not lock any mutexes.
923 func freezetheworld() {
925 if debug.dontfreezetheworld > 0 {
926 // Don't prempt Ps to stop goroutines. That will perturb
927 // scheduler state, making debugging more difficult. Instead,
928 // allow goroutines to continue execution.
930 // fatalpanic will tracebackothers to trace all goroutines. It
931 // is unsafe to trace a running goroutine, so tracebackothers
932 // will skip running goroutines. That is OK and expected, we
933 // expect users of dontfreezetheworld to use core files anyway.
935 // However, allowing the scheduler to continue running free
936 // introduces a race: a goroutine may be stopped when
937 // tracebackothers checks its status, and then start running
938 // later when we are in the middle of traceback, potentially
941 // To mitigate this, when an M naturally enters the scheduler,
942 // schedule checks if freezing is set and if so stops
943 // execution. This guarantees that while Gs can transition from
944 // running to stopped, they can never transition from stopped
947 // The sleep here allows racing Ms that missed freezing and are
948 // about to run a G to complete the transition to running
949 // before we start traceback.
954 // stopwait and preemption requests can be lost
955 // due to races with concurrently executing threads,
956 // so try several times
957 for i := 0; i < 5; i++ {
958 // this should tell the scheduler to not start any new goroutines
959 sched.stopwait = freezeStopWait
960 sched.gcwaiting.Store(true)
961 // this should stop running goroutines
963 break // no running goroutines
973 // All reads and writes of g's status go through readgstatus, casgstatus
974 // castogscanstatus, casfrom_Gscanstatus.
977 func readgstatus(gp *g) uint32 {
978 return gp.atomicstatus.Load()
981 // The Gscanstatuses are acting like locks and this releases them.
982 // If it proves to be a performance hit we should be able to make these
983 // simple atomic stores but for now we are going to throw if
984 // we see an inconsistent state.
985 func casfrom_Gscanstatus(gp *g, oldval, newval uint32) {
988 // Check that transition is valid.
991 print("runtime: casfrom_Gscanstatus bad oldval gp=", gp, ", oldval=", hex(oldval), ", newval=", hex(newval), "\n")
993 throw("casfrom_Gscanstatus:top gp->status is not in scan state")
999 if newval == oldval&^_Gscan {
1000 success = gp.atomicstatus.CompareAndSwap(oldval, newval)
1004 print("runtime: casfrom_Gscanstatus failed gp=", gp, ", oldval=", hex(oldval), ", newval=", hex(newval), "\n")
1006 throw("casfrom_Gscanstatus: gp->status is not in scan state")
1008 releaseLockRank(lockRankGscan)
1011 // This will return false if the gp is not in the expected status and the cas fails.
1012 // This acts like a lock acquire while the casfromgstatus acts like a lock release.
1013 func castogscanstatus(gp *g, oldval, newval uint32) bool {
1019 if newval == oldval|_Gscan {
1020 r := gp.atomicstatus.CompareAndSwap(oldval, newval)
1022 acquireLockRank(lockRankGscan)
1028 print("runtime: castogscanstatus oldval=", hex(oldval), " newval=", hex(newval), "\n")
1029 throw("castogscanstatus")
1030 panic("not reached")
1033 // casgstatusAlwaysTrack is a debug flag that causes casgstatus to always track
1034 // various latencies on every transition instead of sampling them.
1035 var casgstatusAlwaysTrack = false
1037 // If asked to move to or from a Gscanstatus this will throw. Use the castogscanstatus
1038 // and casfrom_Gscanstatus instead.
1039 // casgstatus will loop if the g->atomicstatus is in a Gscan status until the routine that
1040 // put it in the Gscan state is finished.
1043 func casgstatus(gp *g, oldval, newval uint32) {
1044 if (oldval&_Gscan != 0) || (newval&_Gscan != 0) || oldval == newval {
1045 systemstack(func() {
1046 print("runtime: casgstatus: oldval=", hex(oldval), " newval=", hex(newval), "\n")
1047 throw("casgstatus: bad incoming values")
1051 acquireLockRank(lockRankGscan)
1052 releaseLockRank(lockRankGscan)
1054 // See https://golang.org/cl/21503 for justification of the yield delay.
1055 const yieldDelay = 5 * 1000
1058 // loop if gp->atomicstatus is in a scan state giving
1059 // GC time to finish and change the state to oldval.
1060 for i := 0; !gp.atomicstatus.CompareAndSwap(oldval, newval); i++ {
1061 if oldval == _Gwaiting && gp.atomicstatus.Load() == _Grunnable {
1062 throw("casgstatus: waiting for Gwaiting but is Grunnable")
1065 nextYield = nanotime() + yieldDelay
1067 if nanotime() < nextYield {
1068 for x := 0; x < 10 && gp.atomicstatus.Load() != oldval; x++ {
1073 nextYield = nanotime() + yieldDelay/2
1077 if oldval == _Grunning {
1078 // Track every gTrackingPeriod time a goroutine transitions out of running.
1079 if casgstatusAlwaysTrack || gp.trackingSeq%gTrackingPeriod == 0 {
1088 // Handle various kinds of tracking.
1091 // - Time spent in runnable.
1092 // - Time spent blocked on a sync.Mutex or sync.RWMutex.
1095 // We transitioned out of runnable, so measure how much
1096 // time we spent in this state and add it to
1099 gp.runnableTime += now - gp.trackingStamp
1100 gp.trackingStamp = 0
1102 if !gp.waitreason.isMutexWait() {
1103 // Not blocking on a lock.
1106 // Blocking on a lock, measure it. Note that because we're
1107 // sampling, we have to multiply by our sampling period to get
1108 // a more representative estimate of the absolute value.
1109 // gTrackingPeriod also represents an accurate sampling period
1110 // because we can only enter this state from _Grunning.
1112 sched.totalMutexWaitTime.Add((now - gp.trackingStamp) * gTrackingPeriod)
1113 gp.trackingStamp = 0
1117 if !gp.waitreason.isMutexWait() {
1118 // Not blocking on a lock.
1121 // Blocking on a lock. Write down the timestamp.
1123 gp.trackingStamp = now
1125 // We just transitioned into runnable, so record what
1126 // time that happened.
1128 gp.trackingStamp = now
1130 // We're transitioning into running, so turn off
1131 // tracking and record how much time we spent in
1134 sched.timeToRun.record(gp.runnableTime)
1139 // casGToWaiting transitions gp from old to _Gwaiting, and sets the wait reason.
1141 // Use this over casgstatus when possible to ensure that a waitreason is set.
1142 func casGToWaiting(gp *g, old uint32, reason waitReason) {
1143 // Set the wait reason before calling casgstatus, because casgstatus will use it.
1144 gp.waitreason = reason
1145 casgstatus(gp, old, _Gwaiting)
1148 // casgstatus(gp, oldstatus, Gcopystack), assuming oldstatus is Gwaiting or Grunnable.
1149 // Returns old status. Cannot call casgstatus directly, because we are racing with an
1150 // async wakeup that might come in from netpoll. If we see Gwaiting from the readgstatus,
1151 // it might have become Grunnable by the time we get to the cas. If we called casgstatus,
1152 // it would loop waiting for the status to go back to Gwaiting, which it never will.
1155 func casgcopystack(gp *g) uint32 {
1157 oldstatus := readgstatus(gp) &^ _Gscan
1158 if oldstatus != _Gwaiting && oldstatus != _Grunnable {
1159 throw("copystack: bad status, not Gwaiting or Grunnable")
1161 if gp.atomicstatus.CompareAndSwap(oldstatus, _Gcopystack) {
1167 // casGToPreemptScan transitions gp from _Grunning to _Gscan|_Gpreempted.
1169 // TODO(austin): This is the only status operation that both changes
1170 // the status and locks the _Gscan bit. Rethink this.
1171 func casGToPreemptScan(gp *g, old, new uint32) {
1172 if old != _Grunning || new != _Gscan|_Gpreempted {
1173 throw("bad g transition")
1175 acquireLockRank(lockRankGscan)
1176 for !gp.atomicstatus.CompareAndSwap(_Grunning, _Gscan|_Gpreempted) {
1180 // casGFromPreempted attempts to transition gp from _Gpreempted to
1181 // _Gwaiting. If successful, the caller is responsible for
1182 // re-scheduling gp.
1183 func casGFromPreempted(gp *g, old, new uint32) bool {
1184 if old != _Gpreempted || new != _Gwaiting {
1185 throw("bad g transition")
1187 gp.waitreason = waitReasonPreempted
1188 return gp.atomicstatus.CompareAndSwap(_Gpreempted, _Gwaiting)
1191 // stwReason is an enumeration of reasons the world is stopping.
1192 type stwReason uint8
1194 // Reasons to stop-the-world.
1196 // Avoid reusing reasons and add new ones instead.
1198 stwUnknown stwReason = iota // "unknown"
1199 stwGCMarkTerm // "GC mark termination"
1200 stwGCSweepTerm // "GC sweep termination"
1201 stwWriteHeapDump // "write heap dump"
1202 stwGoroutineProfile // "goroutine profile"
1203 stwGoroutineProfileCleanup // "goroutine profile cleanup"
1204 stwAllGoroutinesStack // "all goroutines stack trace"
1205 stwReadMemStats // "read mem stats"
1206 stwAllThreadsSyscall // "AllThreadsSyscall"
1207 stwGOMAXPROCS // "GOMAXPROCS"
1208 stwStartTrace // "start trace"
1209 stwStopTrace // "stop trace"
1210 stwForTestCountPagesInUse // "CountPagesInUse (test)"
1211 stwForTestReadMetricsSlow // "ReadMetricsSlow (test)"
1212 stwForTestReadMemStatsSlow // "ReadMemStatsSlow (test)"
1213 stwForTestPageCachePagesLeaked // "PageCachePagesLeaked (test)"
1214 stwForTestResetDebugLog // "ResetDebugLog (test)"
1217 func (r stwReason) String() string {
1218 return stwReasonStrings[r]
1221 // If you add to this list, also add it to src/internal/trace/parser.go.
1222 // If you change the values of any of the stw* constants, bump the trace
1223 // version number and make a copy of this.
1224 var stwReasonStrings = [...]string{
1225 stwUnknown: "unknown",
1226 stwGCMarkTerm: "GC mark termination",
1227 stwGCSweepTerm: "GC sweep termination",
1228 stwWriteHeapDump: "write heap dump",
1229 stwGoroutineProfile: "goroutine profile",
1230 stwGoroutineProfileCleanup: "goroutine profile cleanup",
1231 stwAllGoroutinesStack: "all goroutines stack trace",
1232 stwReadMemStats: "read mem stats",
1233 stwAllThreadsSyscall: "AllThreadsSyscall",
1234 stwGOMAXPROCS: "GOMAXPROCS",
1235 stwStartTrace: "start trace",
1236 stwStopTrace: "stop trace",
1237 stwForTestCountPagesInUse: "CountPagesInUse (test)",
1238 stwForTestReadMetricsSlow: "ReadMetricsSlow (test)",
1239 stwForTestReadMemStatsSlow: "ReadMemStatsSlow (test)",
1240 stwForTestPageCachePagesLeaked: "PageCachePagesLeaked (test)",
1241 stwForTestResetDebugLog: "ResetDebugLog (test)",
1244 // stopTheWorld stops all P's from executing goroutines, interrupting
1245 // all goroutines at GC safe points and records reason as the reason
1246 // for the stop. On return, only the current goroutine's P is running.
1247 // stopTheWorld must not be called from a system stack and the caller
1248 // must not hold worldsema. The caller must call startTheWorld when
1249 // other P's should resume execution.
1251 // stopTheWorld is safe for multiple goroutines to call at the
1252 // same time. Each will execute its own stop, and the stops will
1255 // This is also used by routines that do stack dumps. If the system is
1256 // in panic or being exited, this may not reliably stop all
1258 func stopTheWorld(reason stwReason) {
1259 semacquire(&worldsema)
1261 gp.m.preemptoff = reason.String()
1262 systemstack(func() {
1263 // Mark the goroutine which called stopTheWorld preemptible so its
1264 // stack may be scanned.
1265 // This lets a mark worker scan us while we try to stop the world
1266 // since otherwise we could get in a mutual preemption deadlock.
1267 // We must not modify anything on the G stack because a stack shrink
1268 // may occur. A stack shrink is otherwise OK though because in order
1269 // to return from this function (and to leave the system stack) we
1270 // must have preempted all goroutines, including any attempting
1271 // to scan our stack, in which case, any stack shrinking will
1272 // have already completed by the time we exit.
1273 // Don't provide a wait reason because we're still executing.
1274 casGToWaiting(gp, _Grunning, waitReasonStoppingTheWorld)
1275 stopTheWorldWithSema(reason)
1276 casgstatus(gp, _Gwaiting, _Grunning)
1280 // startTheWorld undoes the effects of stopTheWorld.
1281 func startTheWorld() {
1282 systemstack(func() { startTheWorldWithSema() })
1284 // worldsema must be held over startTheWorldWithSema to ensure
1285 // gomaxprocs cannot change while worldsema is held.
1287 // Release worldsema with direct handoff to the next waiter, but
1288 // acquirem so that semrelease1 doesn't try to yield our time.
1290 // Otherwise if e.g. ReadMemStats is being called in a loop,
1291 // it might stomp on other attempts to stop the world, such as
1292 // for starting or ending GC. The operation this blocks is
1293 // so heavy-weight that we should just try to be as fair as
1296 // We don't want to just allow us to get preempted between now
1297 // and releasing the semaphore because then we keep everyone
1298 // (including, for example, GCs) waiting longer.
1301 semrelease1(&worldsema, true, 0)
1305 // stopTheWorldGC has the same effect as stopTheWorld, but blocks
1306 // until the GC is not running. It also blocks a GC from starting
1307 // until startTheWorldGC is called.
1308 func stopTheWorldGC(reason stwReason) {
1310 stopTheWorld(reason)
1313 // startTheWorldGC undoes the effects of stopTheWorldGC.
1314 func startTheWorldGC() {
1319 // Holding worldsema grants an M the right to try to stop the world.
1320 var worldsema uint32 = 1
1322 // Holding gcsema grants the M the right to block a GC, and blocks
1323 // until the current GC is done. In particular, it prevents gomaxprocs
1324 // from changing concurrently.
1326 // TODO(mknyszek): Once gomaxprocs and the execution tracer can handle
1327 // being changed/enabled during a GC, remove this.
1328 var gcsema uint32 = 1
1330 // stopTheWorldWithSema is the core implementation of stopTheWorld.
1331 // The caller is responsible for acquiring worldsema and disabling
1332 // preemption first and then should stopTheWorldWithSema on the system
1335 // semacquire(&worldsema, 0)
1336 // m.preemptoff = "reason"
1337 // systemstack(stopTheWorldWithSema)
1339 // When finished, the caller must either call startTheWorld or undo
1340 // these three operations separately:
1342 // m.preemptoff = ""
1343 // systemstack(startTheWorldWithSema)
1344 // semrelease(&worldsema)
1346 // It is allowed to acquire worldsema once and then execute multiple
1347 // startTheWorldWithSema/stopTheWorldWithSema pairs.
1348 // Other P's are able to execute between successive calls to
1349 // startTheWorldWithSema and stopTheWorldWithSema.
1350 // Holding worldsema causes any other goroutines invoking
1351 // stopTheWorld to block.
1352 func stopTheWorldWithSema(reason stwReason) {
1354 traceSTWStart(reason)
1358 // If we hold a lock, then we won't be able to stop another M
1359 // that is blocked trying to acquire the lock.
1361 throw("stopTheWorld: holding locks")
1365 sched.stopwait = gomaxprocs
1366 sched.gcwaiting.Store(true)
1369 gp.m.p.ptr().status = _Pgcstop // Pgcstop is only diagnostic.
1371 // try to retake all P's in Psyscall status
1372 for _, pp := range allp {
1374 if s == _Psyscall && atomic.Cas(&pp.status, s, _Pgcstop) {
1386 pp, _ := pidleget(now)
1390 pp.status = _Pgcstop
1393 wait := sched.stopwait > 0
1396 // wait for remaining P's to stop voluntarily
1399 // wait for 100us, then try to re-preempt in case of any races
1400 if notetsleep(&sched.stopnote, 100*1000) {
1401 noteclear(&sched.stopnote)
1410 if sched.stopwait != 0 {
1411 bad = "stopTheWorld: not stopped (stopwait != 0)"
1413 for _, pp := range allp {
1414 if pp.status != _Pgcstop {
1415 bad = "stopTheWorld: not stopped (status != _Pgcstop)"
1419 if freezing.Load() {
1420 // Some other thread is panicking. This can cause the
1421 // sanity checks above to fail if the panic happens in
1422 // the signal handler on a stopped thread. Either way,
1423 // we should halt this thread.
1434 func startTheWorldWithSema() int64 {
1435 assertWorldStopped()
1437 mp := acquirem() // disable preemption because it can be holding p in a local var
1438 if netpollinited() {
1439 list, delta := netpoll(0) // non-blocking
1441 netpollAdjustWaiters(delta)
1450 p1 := procresize(procs)
1451 sched.gcwaiting.Store(false)
1452 if sched.sysmonwait.Load() {
1453 sched.sysmonwait.Store(false)
1454 notewakeup(&sched.sysmonnote)
1467 throw("startTheWorld: inconsistent mp->nextp")
1470 notewakeup(&mp.park)
1472 // Start M to run P. Do not start another M below.
1477 // Capture start-the-world time before doing clean-up tasks.
1478 startTime := nanotime()
1483 // Wakeup an additional proc in case we have excessive runnable goroutines
1484 // in local queues or in the global queue. If we don't, the proc will park itself.
1485 // If we have lots of excessive work, resetspinning will unpark additional procs as necessary.
1493 // usesLibcall indicates whether this runtime performs system calls
1495 func usesLibcall() bool {
1497 case "aix", "darwin", "illumos", "ios", "solaris", "windows":
1500 return GOARCH != "mips64"
1505 // mStackIsSystemAllocated indicates whether this runtime starts on a
1506 // system-allocated stack.
1507 func mStackIsSystemAllocated() bool {
1509 case "aix", "darwin", "plan9", "illumos", "ios", "solaris", "windows":
1512 return GOARCH != "mips64"
1517 // mstart is the entry-point for new Ms.
1518 // It is written in assembly, uses ABI0, is marked TOPFRAME, and calls mstart0.
1521 // mstart0 is the Go entry-point for new Ms.
1522 // This must not split the stack because we may not even have stack
1523 // bounds set up yet.
1525 // May run during STW (because it doesn't have a P yet), so write
1526 // barriers are not allowed.
1529 //go:nowritebarrierrec
1533 osStack := gp.stack.lo == 0
1535 // Initialize stack bounds from system stack.
1536 // Cgo may have left stack size in stack.hi.
1537 // minit may update the stack bounds.
1539 // Note: these bounds may not be very accurate.
1540 // We set hi to &size, but there are things above
1541 // it. The 1024 is supposed to compensate this,
1542 // but is somewhat arbitrary.
1545 size = 16384 * sys.StackGuardMultiplier
1547 gp.stack.hi = uintptr(noescape(unsafe.Pointer(&size)))
1548 gp.stack.lo = gp.stack.hi - size + 1024
1550 // Initialize stack guard so that we can start calling regular
1552 gp.stackguard0 = gp.stack.lo + stackGuard
1553 // This is the g0, so we can also call go:systemstack
1554 // functions, which check stackguard1.
1555 gp.stackguard1 = gp.stackguard0
1558 // Exit this thread.
1559 if mStackIsSystemAllocated() {
1560 // Windows, Solaris, illumos, Darwin, AIX and Plan 9 always system-allocate
1561 // the stack, but put it in gp.stack before mstart,
1562 // so the logic above hasn't set osStack yet.
1568 // The go:noinline is to guarantee the getcallerpc/getcallersp below are safe,
1569 // so that we can set up g0.sched to return to the call of mstart1 above.
1576 throw("bad runtime·mstart")
1579 // Set up m.g0.sched as a label returning to just
1580 // after the mstart1 call in mstart0 above, for use by goexit0 and mcall.
1581 // We're never coming back to mstart1 after we call schedule,
1582 // so other calls can reuse the current frame.
1583 // And goexit0 does a gogo that needs to return from mstart1
1584 // and let mstart0 exit the thread.
1585 gp.sched.g = guintptr(unsafe.Pointer(gp))
1586 gp.sched.pc = getcallerpc()
1587 gp.sched.sp = getcallersp()
1592 // Install signal handlers; after minit so that minit can
1593 // prepare the thread to be able to handle the signals.
1598 if fn := gp.m.mstartfn; fn != nil {
1603 acquirep(gp.m.nextp.ptr())
1609 // mstartm0 implements part of mstart1 that only runs on the m0.
1611 // Write barriers are allowed here because we know the GC can't be
1612 // running yet, so they'll be no-ops.
1614 //go:yeswritebarrierrec
1616 // Create an extra M for callbacks on threads not created by Go.
1617 // An extra M is also needed on Windows for callbacks created by
1618 // syscall.NewCallback. See issue #6751 for details.
1619 if (iscgo || GOOS == "windows") && !cgoHasExtraM {
1626 // mPark causes a thread to park itself, returning once woken.
1631 notesleep(&gp.m.park)
1632 noteclear(&gp.m.park)
1635 // mexit tears down and exits the current thread.
1637 // Don't call this directly to exit the thread, since it must run at
1638 // the top of the thread stack. Instead, use gogo(&gp.m.g0.sched) to
1639 // unwind the stack to the point that exits the thread.
1641 // It is entered with m.p != nil, so write barriers are allowed. It
1642 // will release the P before exiting.
1644 //go:yeswritebarrierrec
1645 func mexit(osStack bool) {
1649 // This is the main thread. Just wedge it.
1651 // On Linux, exiting the main thread puts the process
1652 // into a non-waitable zombie state. On Plan 9,
1653 // exiting the main thread unblocks wait even though
1654 // other threads are still running. On Solaris we can
1655 // neither exitThread nor return from mstart. Other
1656 // bad things probably happen on other platforms.
1658 // We could try to clean up this M more before wedging
1659 // it, but that complicates signal handling.
1660 handoffp(releasep())
1666 throw("locked m0 woke up")
1672 // Free the gsignal stack.
1673 if mp.gsignal != nil {
1674 stackfree(mp.gsignal.stack)
1675 // On some platforms, when calling into VDSO (e.g. nanotime)
1676 // we store our g on the gsignal stack, if there is one.
1677 // Now the stack is freed, unlink it from the m, so we
1678 // won't write to it when calling VDSO code.
1682 // Remove m from allm.
1684 for pprev := &allm; *pprev != nil; pprev = &(*pprev).alllink {
1690 throw("m not found in allm")
1692 // Delay reaping m until it's done with the stack.
1694 // Put mp on the free list, though it will not be reaped while freeWait
1695 // is freeMWait. mp is no longer reachable via allm, so even if it is
1696 // on an OS stack, we must keep a reference to mp alive so that the GC
1697 // doesn't free mp while we are still using it.
1699 // Note that the free list must not be linked through alllink because
1700 // some functions walk allm without locking, so may be using alllink.
1701 mp.freeWait.Store(freeMWait)
1702 mp.freelink = sched.freem
1706 atomic.Xadd64(&ncgocall, int64(mp.ncgocall))
1709 handoffp(releasep())
1710 // After this point we must not have write barriers.
1712 // Invoke the deadlock detector. This must happen after
1713 // handoffp because it may have started a new M to take our
1720 if GOOS == "darwin" || GOOS == "ios" {
1721 // Make sure pendingPreemptSignals is correct when an M exits.
1723 if mp.signalPending.Load() != 0 {
1724 pendingPreemptSignals.Add(-1)
1728 // Destroy all allocated resources. After this is called, we may no
1729 // longer take any locks.
1733 // No more uses of mp, so it is safe to drop the reference.
1734 mp.freeWait.Store(freeMRef)
1736 // Return from mstart and let the system thread
1737 // library free the g0 stack and terminate the thread.
1741 // mstart is the thread's entry point, so there's nothing to
1742 // return to. Exit the thread directly. exitThread will clear
1743 // m.freeWait when it's done with the stack and the m can be
1745 exitThread(&mp.freeWait)
1748 // forEachP calls fn(p) for every P p when p reaches a GC safe point.
1749 // If a P is currently executing code, this will bring the P to a GC
1750 // safe point and execute fn on that P. If the P is not executing code
1751 // (it is idle or in a syscall), this will call fn(p) directly while
1752 // preventing the P from exiting its state. This does not ensure that
1753 // fn will run on every CPU executing Go code, but it acts as a global
1754 // memory barrier. GC uses this as a "ragged barrier."
1756 // The caller must hold worldsema.
1759 func forEachP(fn func(*p)) {
1761 pp := getg().m.p.ptr()
1764 if sched.safePointWait != 0 {
1765 throw("forEachP: sched.safePointWait != 0")
1767 sched.safePointWait = gomaxprocs - 1
1768 sched.safePointFn = fn
1770 // Ask all Ps to run the safe point function.
1771 for _, p2 := range allp {
1773 atomic.Store(&p2.runSafePointFn, 1)
1778 // Any P entering _Pidle or _Psyscall from now on will observe
1779 // p.runSafePointFn == 1 and will call runSafePointFn when
1780 // changing its status to _Pidle/_Psyscall.
1782 // Run safe point function for all idle Ps. sched.pidle will
1783 // not change because we hold sched.lock.
1784 for p := sched.pidle.ptr(); p != nil; p = p.link.ptr() {
1785 if atomic.Cas(&p.runSafePointFn, 1, 0) {
1787 sched.safePointWait--
1791 wait := sched.safePointWait > 0
1794 // Run fn for the current P.
1797 // Force Ps currently in _Psyscall into _Pidle and hand them
1798 // off to induce safe point function execution.
1799 for _, p2 := range allp {
1801 if s == _Psyscall && p2.runSafePointFn == 1 && atomic.Cas(&p2.status, s, _Pidle) {
1811 // Wait for remaining Ps to run fn.
1814 // Wait for 100us, then try to re-preempt in
1815 // case of any races.
1817 // Requires system stack.
1818 if notetsleep(&sched.safePointNote, 100*1000) {
1819 noteclear(&sched.safePointNote)
1825 if sched.safePointWait != 0 {
1826 throw("forEachP: not done")
1828 for _, p2 := range allp {
1829 if p2.runSafePointFn != 0 {
1830 throw("forEachP: P did not run fn")
1835 sched.safePointFn = nil
1840 // runSafePointFn runs the safe point function, if any, for this P.
1841 // This should be called like
1843 // if getg().m.p.runSafePointFn != 0 {
1847 // runSafePointFn must be checked on any transition in to _Pidle or
1848 // _Psyscall to avoid a race where forEachP sees that the P is running
1849 // just before the P goes into _Pidle/_Psyscall and neither forEachP
1850 // nor the P run the safe-point function.
1851 func runSafePointFn() {
1852 p := getg().m.p.ptr()
1853 // Resolve the race between forEachP running the safe-point
1854 // function on this P's behalf and this P running the
1855 // safe-point function directly.
1856 if !atomic.Cas(&p.runSafePointFn, 1, 0) {
1859 sched.safePointFn(p)
1861 sched.safePointWait--
1862 if sched.safePointWait == 0 {
1863 notewakeup(&sched.safePointNote)
1868 // When running with cgo, we call _cgo_thread_start
1869 // to start threads for us so that we can play nicely with
1871 var cgoThreadStart unsafe.Pointer
1873 type cgothreadstart struct {
1879 // Allocate a new m unassociated with any thread.
1880 // Can use p for allocation context if needed.
1881 // fn is recorded as the new m's m.mstartfn.
1882 // id is optional pre-allocated m ID. Omit by passing -1.
1884 // This function is allowed to have write barriers even if the caller
1885 // isn't because it borrows pp.
1887 //go:yeswritebarrierrec
1888 func allocm(pp *p, fn func(), id int64) *m {
1891 // The caller owns pp, but we may borrow (i.e., acquirep) it. We must
1892 // disable preemption to ensure it is not stolen, which would make the
1893 // caller lose ownership.
1898 acquirep(pp) // temporarily borrow p for mallocs in this function
1901 // Release the free M list. We need to do this somewhere and
1902 // this may free up a stack we can use.
1903 if sched.freem != nil {
1906 for freem := sched.freem; freem != nil; {
1907 wait := freem.freeWait.Load()
1908 if wait == freeMWait {
1909 next := freem.freelink
1910 freem.freelink = newList
1915 // Free the stack if needed. For freeMRef, there is
1916 // nothing to do except drop freem from the sched.freem
1918 if wait == freeMStack {
1919 // stackfree must be on the system stack, but allocm is
1920 // reachable off the system stack transitively from
1922 systemstack(func() {
1923 stackfree(freem.g0.stack)
1926 freem = freem.freelink
1928 sched.freem = newList
1936 // In case of cgo or Solaris or illumos or Darwin, pthread_create will make us a stack.
1937 // Windows and Plan 9 will layout sched stack on OS stack.
1938 if iscgo || mStackIsSystemAllocated() {
1941 mp.g0 = malg(16384 * sys.StackGuardMultiplier)
1945 if pp == gp.m.p.ptr() {
1950 allocmLock.runlock()
1954 // needm is called when a cgo callback happens on a
1955 // thread without an m (a thread not created by Go).
1956 // In this case, needm is expected to find an m to use
1957 // and return with m, g initialized correctly.
1958 // Since m and g are not set now (likely nil, but see below)
1959 // needm is limited in what routines it can call. In particular
1960 // it can only call nosplit functions (textflag 7) and cannot
1961 // do any scheduling that requires an m.
1963 // In order to avoid needing heavy lifting here, we adopt
1964 // the following strategy: there is a stack of available m's
1965 // that can be stolen. Using compare-and-swap
1966 // to pop from the stack has ABA races, so we simulate
1967 // a lock by doing an exchange (via Casuintptr) to steal the stack
1968 // head and replace the top pointer with MLOCKED (1).
1969 // This serves as a simple spin lock that we can use even
1970 // without an m. The thread that locks the stack in this way
1971 // unlocks the stack by storing a valid stack head pointer.
1973 // In order to make sure that there is always an m structure
1974 // available to be stolen, we maintain the invariant that there
1975 // is always one more than needed. At the beginning of the
1976 // program (if cgo is in use) the list is seeded with a single m.
1977 // If needm finds that it has taken the last m off the list, its job
1978 // is - once it has installed its own m so that it can do things like
1979 // allocate memory - to create a spare m and put it on the list.
1981 // Each of these extra m's also has a g0 and a curg that are
1982 // pressed into service as the scheduling stack and current
1983 // goroutine for the duration of the cgo callback.
1985 // It calls dropm to put the m back on the list,
1986 // 1. when the callback is done with the m in non-pthread platforms,
1987 // 2. or when the C thread exiting on pthread platforms.
1989 // The signal argument indicates whether we're called from a signal
1993 func needm(signal bool) {
1994 if (iscgo || GOOS == "windows") && !cgoHasExtraM {
1995 // Can happen if C/C++ code calls Go from a global ctor.
1996 // Can also happen on Windows if a global ctor uses a
1997 // callback created by syscall.NewCallback. See issue #6751
2000 // Can not throw, because scheduler is not initialized yet.
2001 writeErrStr("fatal error: cgo callback before cgo call\n")
2005 // Save and block signals before getting an M.
2006 // The signal handler may call needm itself,
2007 // and we must avoid a deadlock. Also, once g is installed,
2008 // any incoming signals will try to execute,
2009 // but we won't have the sigaltstack settings and other data
2010 // set up appropriately until the end of minit, which will
2011 // unblock the signals. This is the same dance as when
2012 // starting a new m to run Go code via newosproc.
2017 // getExtraM is safe here because of the invariant above,
2018 // that the extra list always contains or will soon contain
2020 mp, last := getExtraM()
2022 // Set needextram when we've just emptied the list,
2023 // so that the eventual call into cgocallbackg will
2024 // allocate a new m for the extra list. We delay the
2025 // allocation until then so that it can be done
2026 // after exitsyscall makes sure it is okay to be
2027 // running at all (that is, there's no garbage collection
2028 // running right now).
2029 mp.needextram = last
2031 // Store the original signal mask for use by minit.
2032 mp.sigmask = sigmask
2034 // Install TLS on some platforms (previously setg
2035 // would do this if necessary).
2038 // Install g (= m->g0) and set the stack bounds
2039 // to match the current stack.
2042 callbackUpdateSystemStack(mp, sp, signal)
2044 // Should mark we are already in Go now.
2045 // Otherwise, we may call needm again when we get a signal, before cgocallbackg1,
2046 // which means the extram list may be empty, that will cause a deadlock.
2047 mp.isExtraInC = false
2049 // Initialize this thread to use the m.
2053 // mp.curg is now a real goroutine.
2054 casgstatus(mp.curg, _Gdead, _Gsyscall)
2058 // Acquire an extra m and bind it to the C thread when a pthread key has been created.
2061 func needAndBindM() {
2064 if _cgo_pthread_key_created != nil && *(*uintptr)(_cgo_pthread_key_created) != 0 {
2069 // newextram allocates m's and puts them on the extra list.
2070 // It is called with a working local m, so that it can do things
2071 // like call schedlock and allocate.
2073 c := extraMWaiters.Swap(0)
2075 for i := uint32(0); i < c; i++ {
2078 } else if extraMLength.Load() == 0 {
2079 // Make sure there is at least one extra M.
2084 // oneNewExtraM allocates an m and puts it on the extra list.
2085 func oneNewExtraM() {
2086 // Create extra goroutine locked to extra m.
2087 // The goroutine is the context in which the cgo callback will run.
2088 // The sched.pc will never be returned to, but setting it to
2089 // goexit makes clear to the traceback routines where
2090 // the goroutine stack ends.
2091 mp := allocm(nil, nil, -1)
2093 gp.sched.pc = abi.FuncPCABI0(goexit) + sys.PCQuantum
2094 gp.sched.sp = gp.stack.hi
2095 gp.sched.sp -= 4 * goarch.PtrSize // extra space in case of reads slightly beyond frame
2097 gp.sched.g = guintptr(unsafe.Pointer(gp))
2098 gp.syscallpc = gp.sched.pc
2099 gp.syscallsp = gp.sched.sp
2100 gp.stktopsp = gp.sched.sp
2101 // malg returns status as _Gidle. Change to _Gdead before
2102 // adding to allg where GC can see it. We use _Gdead to hide
2103 // this from tracebacks and stack scans since it isn't a
2104 // "real" goroutine until needm grabs it.
2105 casgstatus(gp, _Gidle, _Gdead)
2109 // mark we are in C by default.
2110 mp.isExtraInC = true
2114 gp.goid = sched.goidgen.Add(1)
2116 gp.racectx = racegostart(abi.FuncPCABIInternal(newextram) + sys.PCQuantum)
2119 traceOneNewExtraM(gp)
2121 // put on allg for garbage collector
2124 // gp is now on the allg list, but we don't want it to be
2125 // counted by gcount. It would be more "proper" to increment
2126 // sched.ngfree, but that requires locking. Incrementing ngsys
2127 // has the same effect.
2130 // Add m to the extra list.
2134 // dropm puts the current m back onto the extra list.
2136 // 1. On systems without pthreads, like Windows
2137 // dropm is called when a cgo callback has called needm but is now
2138 // done with the callback and returning back into the non-Go thread.
2140 // The main expense here is the call to signalstack to release the
2141 // m's signal stack, and then the call to needm on the next callback
2142 // from this thread. It is tempting to try to save the m for next time,
2143 // which would eliminate both these costs, but there might not be
2144 // a next time: the current thread (which Go does not control) might exit.
2145 // If we saved the m for that thread, there would be an m leak each time
2146 // such a thread exited. Instead, we acquire and release an m on each
2147 // call. These should typically not be scheduling operations, just a few
2148 // atomics, so the cost should be small.
2150 // 2. On systems with pthreads
2151 // dropm is called while a non-Go thread is exiting.
2152 // We allocate a pthread per-thread variable using pthread_key_create,
2153 // to register a thread-exit-time destructor.
2154 // And store the g into a thread-specific value associated with the pthread key,
2155 // when first return back to C.
2156 // So that the destructor would invoke dropm while the non-Go thread is exiting.
2157 // This is much faster since it avoids expensive signal-related syscalls.
2159 // This always runs without a P, so //go:nowritebarrierrec is required.
2161 // This may run with a different stack than was recorded in g0 (there is no
2162 // call to callbackUpdateSystemStack prior to dropm), so this must be
2163 // //go:nosplit to avoid the stack bounds check.
2165 //go:nowritebarrierrec
2168 // Clear m and g, and return m to the extra list.
2169 // After the call to setg we can only call nosplit functions
2170 // with no pointer manipulation.
2173 // Return mp.curg to dead state.
2174 casgstatus(mp.curg, _Gsyscall, _Gdead)
2175 mp.curg.preemptStop = false
2178 // Block signals before unminit.
2179 // Unminit unregisters the signal handling stack (but needs g on some systems).
2180 // Setg(nil) clears g, which is the signal handler's cue not to run Go handlers.
2181 // It's important not to try to handle a signal between those two steps.
2182 sigmask := mp.sigmask
2190 msigrestore(sigmask)
2193 // bindm store the g0 of the current m into a thread-specific value.
2195 // We allocate a pthread per-thread variable using pthread_key_create,
2196 // to register a thread-exit-time destructor.
2197 // We are here setting the thread-specific value of the pthread key, to enable the destructor.
2198 // So that the pthread_key_destructor would dropm while the C thread is exiting.
2200 // And the saved g will be used in pthread_key_destructor,
2201 // since the g stored in the TLS by Go might be cleared in some platforms,
2202 // before the destructor invoked, so, we restore g by the stored g, before dropm.
2204 // We store g0 instead of m, to make the assembly code simpler,
2205 // since we need to restore g0 in runtime.cgocallback.
2207 // On systems without pthreads, like Windows, bindm shouldn't be used.
2209 // NOTE: this always runs without a P, so, nowritebarrierrec required.
2212 //go:nowritebarrierrec
2214 if GOOS == "windows" || GOOS == "plan9" {
2215 fatal("bindm in unexpected GOOS")
2219 fatal("the current g is not g0")
2221 if _cgo_bindm != nil {
2222 asmcgocall(_cgo_bindm, unsafe.Pointer(g))
2226 // A helper function for EnsureDropM.
2227 func getm() uintptr {
2228 return uintptr(unsafe.Pointer(getg().m))
2232 // Locking linked list of extra M's, via mp.schedlink. Must be accessed
2233 // only via lockextra/unlockextra.
2235 // Can't be atomic.Pointer[m] because we use an invalid pointer as a
2236 // "locked" sentinel value. M's on this list remain visible to the GC
2237 // because their mp.curg is on allgs.
2238 extraM atomic.Uintptr
2239 // Number of M's in the extraM list.
2240 extraMLength atomic.Uint32
2241 // Number of waiters in lockextra.
2242 extraMWaiters atomic.Uint32
2244 // Number of extra M's in use by threads.
2245 extraMInUse atomic.Uint32
2248 // lockextra locks the extra list and returns the list head.
2249 // The caller must unlock the list by storing a new list head
2250 // to extram. If nilokay is true, then lockextra will
2251 // return a nil list head if that's what it finds. If nilokay is false,
2252 // lockextra will keep waiting until the list head is no longer nil.
2255 func lockextra(nilokay bool) *m {
2260 old := extraM.Load()
2265 if old == 0 && !nilokay {
2267 // Add 1 to the number of threads
2268 // waiting for an M.
2269 // This is cleared by newextram.
2270 extraMWaiters.Add(1)
2276 if extraM.CompareAndSwap(old, locked) {
2277 return (*m)(unsafe.Pointer(old))
2285 func unlockextra(mp *m, delta int32) {
2286 extraMLength.Add(delta)
2287 extraM.Store(uintptr(unsafe.Pointer(mp)))
2290 // Return an M from the extra M list. Returns last == true if the list becomes
2291 // empty because of this call.
2293 // Spins waiting for an extra M, so caller must ensure that the list always
2294 // contains or will soon contain at least one M.
2297 func getExtraM() (mp *m, last bool) {
2298 mp = lockextra(false)
2300 unlockextra(mp.schedlink.ptr(), -1)
2301 return mp, mp.schedlink.ptr() == nil
2304 // Returns an extra M back to the list. mp must be from getExtraM. Newly
2305 // allocated M's should use addExtraM.
2308 func putExtraM(mp *m) {
2313 // Adds a newly allocated M to the extra M list.
2316 func addExtraM(mp *m) {
2317 mnext := lockextra(true)
2318 mp.schedlink.set(mnext)
2323 // allocmLock is locked for read when creating new Ms in allocm and their
2324 // addition to allm. Thus acquiring this lock for write blocks the
2325 // creation of new Ms.
2328 // execLock serializes exec and clone to avoid bugs or unspecified
2329 // behaviour around exec'ing while creating/destroying threads. See
2334 // These errors are reported (via writeErrStr) by some OS-specific
2335 // versions of newosproc and newosproc0.
2337 failthreadcreate = "runtime: failed to create new OS thread\n"
2338 failallocatestack = "runtime: failed to allocate stack for the new OS thread\n"
2341 // newmHandoff contains a list of m structures that need new OS threads.
2342 // This is used by newm in situations where newm itself can't safely
2343 // start an OS thread.
2344 var newmHandoff struct {
2347 // newm points to a list of M structures that need new OS
2348 // threads. The list is linked through m.schedlink.
2351 // waiting indicates that wake needs to be notified when an m
2352 // is put on the list.
2356 // haveTemplateThread indicates that the templateThread has
2357 // been started. This is not protected by lock. Use cas to set
2359 haveTemplateThread uint32
2362 // Create a new m. It will start off with a call to fn, or else the scheduler.
2363 // fn needs to be static and not a heap allocated closure.
2364 // May run with m.p==nil, so write barriers are not allowed.
2366 // id is optional pre-allocated m ID. Omit by passing -1.
2368 //go:nowritebarrierrec
2369 func newm(fn func(), pp *p, id int64) {
2370 // allocm adds a new M to allm, but they do not start until created by
2371 // the OS in newm1 or the template thread.
2373 // doAllThreadsSyscall requires that every M in allm will eventually
2374 // start and be signal-able, even with a STW.
2376 // Disable preemption here until we start the thread to ensure that
2377 // newm is not preempted between allocm and starting the new thread,
2378 // ensuring that anything added to allm is guaranteed to eventually
2382 mp := allocm(pp, fn, id)
2384 mp.sigmask = initSigmask
2385 if gp := getg(); gp != nil && gp.m != nil && (gp.m.lockedExt != 0 || gp.m.incgo) && GOOS != "plan9" {
2386 // We're on a locked M or a thread that may have been
2387 // started by C. The kernel state of this thread may
2388 // be strange (the user may have locked it for that
2389 // purpose). We don't want to clone that into another
2390 // thread. Instead, ask a known-good thread to create
2391 // the thread for us.
2393 // This is disabled on Plan 9. See golang.org/issue/22227.
2395 // TODO: This may be unnecessary on Windows, which
2396 // doesn't model thread creation off fork.
2397 lock(&newmHandoff.lock)
2398 if newmHandoff.haveTemplateThread == 0 {
2399 throw("on a locked thread with no template thread")
2401 mp.schedlink = newmHandoff.newm
2402 newmHandoff.newm.set(mp)
2403 if newmHandoff.waiting {
2404 newmHandoff.waiting = false
2405 notewakeup(&newmHandoff.wake)
2407 unlock(&newmHandoff.lock)
2408 // The M has not started yet, but the template thread does not
2409 // participate in STW, so it will always process queued Ms and
2410 // it is safe to releasem.
2420 var ts cgothreadstart
2421 if _cgo_thread_start == nil {
2422 throw("_cgo_thread_start missing")
2425 ts.tls = (*uint64)(unsafe.Pointer(&mp.tls[0]))
2426 ts.fn = unsafe.Pointer(abi.FuncPCABI0(mstart))
2428 msanwrite(unsafe.Pointer(&ts), unsafe.Sizeof(ts))
2431 asanwrite(unsafe.Pointer(&ts), unsafe.Sizeof(ts))
2433 execLock.rlock() // Prevent process clone.
2434 asmcgocall(_cgo_thread_start, unsafe.Pointer(&ts))
2438 execLock.rlock() // Prevent process clone.
2443 // startTemplateThread starts the template thread if it is not already
2446 // The calling thread must itself be in a known-good state.
2447 func startTemplateThread() {
2448 if GOARCH == "wasm" { // no threads on wasm yet
2452 // Disable preemption to guarantee that the template thread will be
2453 // created before a park once haveTemplateThread is set.
2455 if !atomic.Cas(&newmHandoff.haveTemplateThread, 0, 1) {
2459 newm(templateThread, nil, -1)
2463 // templateThread is a thread in a known-good state that exists solely
2464 // to start new threads in known-good states when the calling thread
2465 // may not be in a good state.
2467 // Many programs never need this, so templateThread is started lazily
2468 // when we first enter a state that might lead to running on a thread
2469 // in an unknown state.
2471 // templateThread runs on an M without a P, so it must not have write
2474 //go:nowritebarrierrec
2475 func templateThread() {
2482 lock(&newmHandoff.lock)
2483 for newmHandoff.newm != 0 {
2484 newm := newmHandoff.newm.ptr()
2485 newmHandoff.newm = 0
2486 unlock(&newmHandoff.lock)
2488 next := newm.schedlink.ptr()
2493 lock(&newmHandoff.lock)
2495 newmHandoff.waiting = true
2496 noteclear(&newmHandoff.wake)
2497 unlock(&newmHandoff.lock)
2498 notesleep(&newmHandoff.wake)
2502 // Stops execution of the current m until new work is available.
2503 // Returns with acquired P.
2507 if gp.m.locks != 0 {
2508 throw("stopm holding locks")
2511 throw("stopm holding p")
2514 throw("stopm spinning")
2521 acquirep(gp.m.nextp.ptr())
2526 // startm's caller incremented nmspinning. Set the new M's spinning.
2527 getg().m.spinning = true
2530 // Schedules some M to run the p (creates an M if necessary).
2531 // If p==nil, tries to get an idle P, if no idle P's does nothing.
2532 // May run with m.p==nil, so write barriers are not allowed.
2533 // If spinning is set, the caller has incremented nmspinning and must provide a
2534 // P. startm will set m.spinning in the newly started M.
2536 // Callers passing a non-nil P must call from a non-preemptible context. See
2537 // comment on acquirem below.
2539 // Argument lockheld indicates whether the caller already acquired the
2540 // scheduler lock. Callers holding the lock when making the call must pass
2541 // true. The lock might be temporarily dropped, but will be reacquired before
2544 // Must not have write barriers because this may be called without a P.
2546 //go:nowritebarrierrec
2547 func startm(pp *p, spinning, lockheld bool) {
2548 // Disable preemption.
2550 // Every owned P must have an owner that will eventually stop it in the
2551 // event of a GC stop request. startm takes transient ownership of a P
2552 // (either from argument or pidleget below) and transfers ownership to
2553 // a started M, which will be responsible for performing the stop.
2555 // Preemption must be disabled during this transient ownership,
2556 // otherwise the P this is running on may enter GC stop while still
2557 // holding the transient P, leaving that P in limbo and deadlocking the
2560 // Callers passing a non-nil P must already be in non-preemptible
2561 // context, otherwise such preemption could occur on function entry to
2562 // startm. Callers passing a nil P may be preemptible, so we must
2563 // disable preemption before acquiring a P from pidleget below.
2570 // TODO(prattmic): All remaining calls to this function
2571 // with _p_ == nil could be cleaned up to find a P
2572 // before calling startm.
2573 throw("startm: P required for spinning=true")
2586 // No M is available, we must drop sched.lock and call newm.
2587 // However, we already own a P to assign to the M.
2589 // Once sched.lock is released, another G (e.g., in a syscall),
2590 // could find no idle P while checkdead finds a runnable G but
2591 // no running M's because this new M hasn't started yet, thus
2592 // throwing in an apparent deadlock.
2593 // This apparent deadlock is possible when startm is called
2594 // from sysmon, which doesn't count as a running M.
2596 // Avoid this situation by pre-allocating the ID for the new M,
2597 // thus marking it as 'running' before we drop sched.lock. This
2598 // new M will eventually run the scheduler to execute any
2605 // The caller incremented nmspinning, so set m.spinning in the new M.
2613 // Ownership transfer of pp committed by start in newm.
2614 // Preemption is now safe.
2622 throw("startm: m is spinning")
2625 throw("startm: m has p")
2627 if spinning && !runqempty(pp) {
2628 throw("startm: p has runnable gs")
2630 // The caller incremented nmspinning, so set m.spinning in the new M.
2631 nmp.spinning = spinning
2633 notewakeup(&nmp.park)
2634 // Ownership transfer of pp committed by wakeup. Preemption is now
2639 // Hands off P from syscall or locked M.
2640 // Always runs without a P, so write barriers are not allowed.
2642 //go:nowritebarrierrec
2643 func handoffp(pp *p) {
2644 // handoffp must start an M in any situation where
2645 // findrunnable would return a G to run on pp.
2647 // if it has local work, start it straight away
2648 if !runqempty(pp) || sched.runqsize != 0 {
2649 startm(pp, false, false)
2652 // if there's trace work to do, start it straight away
2653 if (traceEnabled() || traceShuttingDown()) && traceReaderAvailable() != nil {
2654 startm(pp, false, false)
2657 // if it has GC work, start it straight away
2658 if gcBlackenEnabled != 0 && gcMarkWorkAvailable(pp) {
2659 startm(pp, false, false)
2662 // no local work, check that there are no spinning/idle M's,
2663 // otherwise our help is not required
2664 if sched.nmspinning.Load()+sched.npidle.Load() == 0 && sched.nmspinning.CompareAndSwap(0, 1) { // TODO: fast atomic
2665 sched.needspinning.Store(0)
2666 startm(pp, true, false)
2670 if sched.gcwaiting.Load() {
2671 pp.status = _Pgcstop
2673 if sched.stopwait == 0 {
2674 notewakeup(&sched.stopnote)
2679 if pp.runSafePointFn != 0 && atomic.Cas(&pp.runSafePointFn, 1, 0) {
2680 sched.safePointFn(pp)
2681 sched.safePointWait--
2682 if sched.safePointWait == 0 {
2683 notewakeup(&sched.safePointNote)
2686 if sched.runqsize != 0 {
2688 startm(pp, false, false)
2691 // If this is the last running P and nobody is polling network,
2692 // need to wakeup another M to poll network.
2693 if sched.npidle.Load() == gomaxprocs-1 && sched.lastpoll.Load() != 0 {
2695 startm(pp, false, false)
2699 // The scheduler lock cannot be held when calling wakeNetPoller below
2700 // because wakeNetPoller may call wakep which may call startm.
2701 when := nobarrierWakeTime(pp)
2710 // Tries to add one more P to execute G's.
2711 // Called when a G is made runnable (newproc, ready).
2712 // Must be called with a P.
2714 // Be conservative about spinning threads, only start one if none exist
2716 if sched.nmspinning.Load() != 0 || !sched.nmspinning.CompareAndSwap(0, 1) {
2720 // Disable preemption until ownership of pp transfers to the next M in
2721 // startm. Otherwise preemption here would leave pp stuck waiting to
2724 // See preemption comment on acquirem in startm for more details.
2729 pp, _ = pidlegetSpinning(0)
2731 if sched.nmspinning.Add(-1) < 0 {
2732 throw("wakep: negative nmspinning")
2738 // Since we always have a P, the race in the "No M is available"
2739 // comment in startm doesn't apply during the small window between the
2740 // unlock here and lock in startm. A checkdead in between will always
2741 // see at least one running M (ours).
2744 startm(pp, true, false)
2749 // Stops execution of the current m that is locked to a g until the g is runnable again.
2750 // Returns with acquired P.
2751 func stoplockedm() {
2754 if gp.m.lockedg == 0 || gp.m.lockedg.ptr().lockedm.ptr() != gp.m {
2755 throw("stoplockedm: inconsistent locking")
2758 // Schedule another M to run this p.
2763 // Wait until another thread schedules lockedg again.
2765 status := readgstatus(gp.m.lockedg.ptr())
2766 if status&^_Gscan != _Grunnable {
2767 print("runtime:stoplockedm: lockedg (atomicstatus=", status, ") is not Grunnable or Gscanrunnable\n")
2768 dumpgstatus(gp.m.lockedg.ptr())
2769 throw("stoplockedm: not runnable")
2771 acquirep(gp.m.nextp.ptr())
2775 // Schedules the locked m to run the locked gp.
2776 // May run during STW, so write barriers are not allowed.
2778 //go:nowritebarrierrec
2779 func startlockedm(gp *g) {
2780 mp := gp.lockedm.ptr()
2782 throw("startlockedm: locked to me")
2785 throw("startlockedm: m has p")
2787 // directly handoff current P to the locked m
2791 notewakeup(&mp.park)
2795 // Stops the current m for stopTheWorld.
2796 // Returns when the world is restarted.
2800 if !sched.gcwaiting.Load() {
2801 throw("gcstopm: not waiting for gc")
2804 gp.m.spinning = false
2805 // OK to just drop nmspinning here,
2806 // startTheWorld will unpark threads as necessary.
2807 if sched.nmspinning.Add(-1) < 0 {
2808 throw("gcstopm: negative nmspinning")
2813 pp.status = _Pgcstop
2815 if sched.stopwait == 0 {
2816 notewakeup(&sched.stopnote)
2822 // Schedules gp to run on the current M.
2823 // If inheritTime is true, gp inherits the remaining time in the
2824 // current time slice. Otherwise, it starts a new time slice.
2827 // Write barriers are allowed because this is called immediately after
2828 // acquiring a P in several places.
2830 //go:yeswritebarrierrec
2831 func execute(gp *g, inheritTime bool) {
2834 if goroutineProfile.active {
2835 // Make sure that gp has had its stack written out to the goroutine
2836 // profile, exactly as it was when the goroutine profiler first stopped
2838 tryRecordGoroutineProfile(gp, osyield)
2841 // Assign gp.m before entering _Grunning so running Gs have an
2845 casgstatus(gp, _Grunnable, _Grunning)
2848 gp.stackguard0 = gp.stack.lo + stackGuard
2850 mp.p.ptr().schedtick++
2853 // Check whether the profiler needs to be turned on or off.
2854 hz := sched.profilehz
2855 if mp.profilehz != hz {
2856 setThreadCPUProfiler(hz)
2860 // GoSysExit has to happen when we have a P, but before GoStart.
2861 // So we emit it here.
2862 if gp.syscallsp != 0 {
2871 // Finds a runnable goroutine to execute.
2872 // Tries to steal from other P's, get g from local or global queue, poll network.
2873 // tryWakeP indicates that the returned goroutine is not normal (GC worker, trace
2874 // reader) so the caller should try to wake a P.
2875 func findRunnable() (gp *g, inheritTime, tryWakeP bool) {
2878 // The conditions here and in handoffp must agree: if
2879 // findrunnable would return a G to run, handoffp must start
2884 if sched.gcwaiting.Load() {
2888 if pp.runSafePointFn != 0 {
2892 // now and pollUntil are saved for work stealing later,
2893 // which may steal timers. It's important that between now
2894 // and then, nothing blocks, so these numbers remain mostly
2896 now, pollUntil, _ := checkTimers(pp, 0)
2898 // Try to schedule the trace reader.
2899 if traceEnabled() || traceShuttingDown() {
2902 casgstatus(gp, _Gwaiting, _Grunnable)
2903 traceGoUnpark(gp, 0)
2904 return gp, false, true
2908 // Try to schedule a GC worker.
2909 if gcBlackenEnabled != 0 {
2910 gp, tnow := gcController.findRunnableGCWorker(pp, now)
2912 return gp, false, true
2917 // Check the global runnable queue once in a while to ensure fairness.
2918 // Otherwise two goroutines can completely occupy the local runqueue
2919 // by constantly respawning each other.
2920 if pp.schedtick%61 == 0 && sched.runqsize > 0 {
2922 gp := globrunqget(pp, 1)
2925 return gp, false, false
2929 // Wake up the finalizer G.
2930 if fingStatus.Load()&(fingWait|fingWake) == fingWait|fingWake {
2931 if gp := wakefing(); gp != nil {
2935 if *cgo_yield != nil {
2936 asmcgocall(*cgo_yield, nil)
2940 if gp, inheritTime := runqget(pp); gp != nil {
2941 return gp, inheritTime, false
2945 if sched.runqsize != 0 {
2947 gp := globrunqget(pp, 0)
2950 return gp, false, false
2955 // This netpoll is only an optimization before we resort to stealing.
2956 // We can safely skip it if there are no waiters or a thread is blocked
2957 // in netpoll already. If there is any kind of logical race with that
2958 // blocked thread (e.g. it has already returned from netpoll, but does
2959 // not set lastpoll yet), this thread will do blocking netpoll below
2961 if netpollinited() && netpollAnyWaiters() && sched.lastpoll.Load() != 0 {
2962 if list, delta := netpoll(0); !list.empty() { // non-blocking
2965 netpollAdjustWaiters(delta)
2966 casgstatus(gp, _Gwaiting, _Grunnable)
2968 traceGoUnpark(gp, 0)
2970 return gp, false, false
2974 // Spinning Ms: steal work from other Ps.
2976 // Limit the number of spinning Ms to half the number of busy Ps.
2977 // This is necessary to prevent excessive CPU consumption when
2978 // GOMAXPROCS>>1 but the program parallelism is low.
2979 if mp.spinning || 2*sched.nmspinning.Load() < gomaxprocs-sched.npidle.Load() {
2984 gp, inheritTime, tnow, w, newWork := stealWork(now)
2986 // Successfully stole.
2987 return gp, inheritTime, false
2990 // There may be new timer or GC work; restart to
2996 if w != 0 && (pollUntil == 0 || w < pollUntil) {
2997 // Earlier timer to wait for.
3002 // We have nothing to do.
3004 // If we're in the GC mark phase, can safely scan and blacken objects,
3005 // and have work to do, run idle-time marking rather than give up the P.
3006 if gcBlackenEnabled != 0 && gcMarkWorkAvailable(pp) && gcController.addIdleMarkWorker() {
3007 node := (*gcBgMarkWorkerNode)(gcBgMarkWorkerPool.pop())
3009 pp.gcMarkWorkerMode = gcMarkWorkerIdleMode
3011 casgstatus(gp, _Gwaiting, _Grunnable)
3013 traceGoUnpark(gp, 0)
3015 return gp, false, false
3017 gcController.removeIdleMarkWorker()
3021 // If a callback returned and no other goroutine is awake,
3022 // then wake event handler goroutine which pauses execution
3023 // until a callback was triggered.
3024 gp, otherReady := beforeIdle(now, pollUntil)
3026 casgstatus(gp, _Gwaiting, _Grunnable)
3028 traceGoUnpark(gp, 0)
3030 return gp, false, false
3036 // Before we drop our P, make a snapshot of the allp slice,
3037 // which can change underfoot once we no longer block
3038 // safe-points. We don't need to snapshot the contents because
3039 // everything up to cap(allp) is immutable.
3040 allpSnapshot := allp
3041 // Also snapshot masks. Value changes are OK, but we can't allow
3042 // len to change out from under us.
3043 idlepMaskSnapshot := idlepMask
3044 timerpMaskSnapshot := timerpMask
3046 // return P and block
3048 if sched.gcwaiting.Load() || pp.runSafePointFn != 0 {
3052 if sched.runqsize != 0 {
3053 gp := globrunqget(pp, 0)
3055 return gp, false, false
3057 if !mp.spinning && sched.needspinning.Load() == 1 {
3058 // See "Delicate dance" comment below.
3063 if releasep() != pp {
3064 throw("findrunnable: wrong p")
3066 now = pidleput(pp, now)
3069 // Delicate dance: thread transitions from spinning to non-spinning
3070 // state, potentially concurrently with submission of new work. We must
3071 // drop nmspinning first and then check all sources again (with
3072 // #StoreLoad memory barrier in between). If we do it the other way
3073 // around, another thread can submit work after we've checked all
3074 // sources but before we drop nmspinning; as a result nobody will
3075 // unpark a thread to run the work.
3077 // This applies to the following sources of work:
3079 // * Goroutines added to the global or a per-P run queue.
3080 // * New/modified-earlier timers on a per-P timer heap.
3081 // * Idle-priority GC work (barring golang.org/issue/19112).
3083 // If we discover new work below, we need to restore m.spinning as a
3084 // signal for resetspinning to unpark a new worker thread (because
3085 // there can be more than one starving goroutine).
3087 // However, if after discovering new work we also observe no idle Ps
3088 // (either here or in resetspinning), we have a problem. We may be
3089 // racing with a non-spinning M in the block above, having found no
3090 // work and preparing to release its P and park. Allowing that P to go
3091 // idle will result in loss of work conservation (idle P while there is
3092 // runnable work). This could result in complete deadlock in the
3093 // unlikely event that we discover new work (from netpoll) right as we
3094 // are racing with _all_ other Ps going idle.
3096 // We use sched.needspinning to synchronize with non-spinning Ms going
3097 // idle. If needspinning is set when they are about to drop their P,
3098 // they abort the drop and instead become a new spinning M on our
3099 // behalf. If we are not racing and the system is truly fully loaded
3100 // then no spinning threads are required, and the next thread to
3101 // naturally become spinning will clear the flag.
3103 // Also see "Worker thread parking/unparking" comment at the top of the
3105 wasSpinning := mp.spinning
3108 if sched.nmspinning.Add(-1) < 0 {
3109 throw("findrunnable: negative nmspinning")
3112 // Note the for correctness, only the last M transitioning from
3113 // spinning to non-spinning must perform these rechecks to
3114 // ensure no missed work. However, the runtime has some cases
3115 // of transient increments of nmspinning that are decremented
3116 // without going through this path, so we must be conservative
3117 // and perform the check on all spinning Ms.
3119 // See https://go.dev/issue/43997.
3121 // Check global and P runqueues again.
3124 if sched.runqsize != 0 {
3125 pp, _ := pidlegetSpinning(0)
3127 gp := globrunqget(pp, 0)
3129 throw("global runq empty with non-zero runqsize")
3134 return gp, false, false
3139 pp := checkRunqsNoP(allpSnapshot, idlepMaskSnapshot)
3146 // Check for idle-priority GC work again.
3147 pp, gp := checkIdleGCNoP()
3152 // Run the idle worker.
3153 pp.gcMarkWorkerMode = gcMarkWorkerIdleMode
3154 casgstatus(gp, _Gwaiting, _Grunnable)
3156 traceGoUnpark(gp, 0)
3158 return gp, false, false
3161 // Finally, check for timer creation or expiry concurrently with
3162 // transitioning from spinning to non-spinning.
3164 // Note that we cannot use checkTimers here because it calls
3165 // adjusttimers which may need to allocate memory, and that isn't
3166 // allowed when we don't have an active P.
3167 pollUntil = checkTimersNoP(allpSnapshot, timerpMaskSnapshot, pollUntil)
3170 // Poll network until next timer.
3171 if netpollinited() && (netpollAnyWaiters() || pollUntil != 0) && sched.lastpoll.Swap(0) != 0 {
3172 sched.pollUntil.Store(pollUntil)
3174 throw("findrunnable: netpoll with p")
3177 throw("findrunnable: netpoll with spinning")
3184 delay = pollUntil - now
3190 // When using fake time, just poll.
3193 list, delta := netpoll(delay) // block until new work is available
3194 // Refresh now again, after potentially blocking.
3196 sched.pollUntil.Store(0)
3197 sched.lastpoll.Store(now)
3198 if faketime != 0 && list.empty() {
3199 // Using fake time and nothing is ready; stop M.
3200 // When all M's stop, checkdead will call timejump.
3205 pp, _ := pidleget(now)
3209 netpollAdjustWaiters(delta)
3215 netpollAdjustWaiters(delta)
3216 casgstatus(gp, _Gwaiting, _Grunnable)
3218 traceGoUnpark(gp, 0)
3220 return gp, false, false
3227 } else if pollUntil != 0 && netpollinited() {
3228 pollerPollUntil := sched.pollUntil.Load()
3229 if pollerPollUntil == 0 || pollerPollUntil > pollUntil {
3237 // pollWork reports whether there is non-background work this P could
3238 // be doing. This is a fairly lightweight check to be used for
3239 // background work loops, like idle GC. It checks a subset of the
3240 // conditions checked by the actual scheduler.
3241 func pollWork() bool {
3242 if sched.runqsize != 0 {
3245 p := getg().m.p.ptr()
3249 if netpollinited() && netpollAnyWaiters() && sched.lastpoll.Load() != 0 {
3250 if list, delta := netpoll(0); !list.empty() {
3252 netpollAdjustWaiters(delta)
3259 // stealWork attempts to steal a runnable goroutine or timer from any P.
3261 // If newWork is true, new work may have been readied.
3263 // If now is not 0 it is the current time. stealWork returns the passed time or
3264 // the current time if now was passed as 0.
3265 func stealWork(now int64) (gp *g, inheritTime bool, rnow, pollUntil int64, newWork bool) {
3266 pp := getg().m.p.ptr()
3270 const stealTries = 4
3271 for i := 0; i < stealTries; i++ {
3272 stealTimersOrRunNextG := i == stealTries-1
3274 for enum := stealOrder.start(fastrand()); !enum.done(); enum.next() {
3275 if sched.gcwaiting.Load() {
3276 // GC work may be available.
3277 return nil, false, now, pollUntil, true
3279 p2 := allp[enum.position()]
3284 // Steal timers from p2. This call to checkTimers is the only place
3285 // where we might hold a lock on a different P's timers. We do this
3286 // once on the last pass before checking runnext because stealing
3287 // from the other P's runnext should be the last resort, so if there
3288 // are timers to steal do that first.
3290 // We only check timers on one of the stealing iterations because
3291 // the time stored in now doesn't change in this loop and checking
3292 // the timers for each P more than once with the same value of now
3293 // is probably a waste of time.
3295 // timerpMask tells us whether the P may have timers at all. If it
3296 // can't, no need to check at all.
3297 if stealTimersOrRunNextG && timerpMask.read(enum.position()) {
3298 tnow, w, ran := checkTimers(p2, now)
3300 if w != 0 && (pollUntil == 0 || w < pollUntil) {
3304 // Running the timers may have
3305 // made an arbitrary number of G's
3306 // ready and added them to this P's
3307 // local run queue. That invalidates
3308 // the assumption of runqsteal
3309 // that it always has room to add
3310 // stolen G's. So check now if there
3311 // is a local G to run.
3312 if gp, inheritTime := runqget(pp); gp != nil {
3313 return gp, inheritTime, now, pollUntil, ranTimer
3319 // Don't bother to attempt to steal if p2 is idle.
3320 if !idlepMask.read(enum.position()) {
3321 if gp := runqsteal(pp, p2, stealTimersOrRunNextG); gp != nil {
3322 return gp, false, now, pollUntil, ranTimer
3328 // No goroutines found to steal. Regardless, running a timer may have
3329 // made some goroutine ready that we missed. Indicate the next timer to
3331 return nil, false, now, pollUntil, ranTimer
3334 // Check all Ps for a runnable G to steal.
3336 // On entry we have no P. If a G is available to steal and a P is available,
3337 // the P is returned which the caller should acquire and attempt to steal the
3339 func checkRunqsNoP(allpSnapshot []*p, idlepMaskSnapshot pMask) *p {
3340 for id, p2 := range allpSnapshot {
3341 if !idlepMaskSnapshot.read(uint32(id)) && !runqempty(p2) {
3343 pp, _ := pidlegetSpinning(0)
3345 // Can't get a P, don't bother checking remaining Ps.
3354 // No work available.
3358 // Check all Ps for a timer expiring sooner than pollUntil.
3360 // Returns updated pollUntil value.
3361 func checkTimersNoP(allpSnapshot []*p, timerpMaskSnapshot pMask, pollUntil int64) int64 {
3362 for id, p2 := range allpSnapshot {
3363 if timerpMaskSnapshot.read(uint32(id)) {
3364 w := nobarrierWakeTime(p2)
3365 if w != 0 && (pollUntil == 0 || w < pollUntil) {
3374 // Check for idle-priority GC, without a P on entry.
3376 // If some GC work, a P, and a worker G are all available, the P and G will be
3377 // returned. The returned P has not been wired yet.
3378 func checkIdleGCNoP() (*p, *g) {
3379 // N.B. Since we have no P, gcBlackenEnabled may change at any time; we
3380 // must check again after acquiring a P. As an optimization, we also check
3381 // if an idle mark worker is needed at all. This is OK here, because if we
3382 // observe that one isn't needed, at least one is currently running. Even if
3383 // it stops running, its own journey into the scheduler should schedule it
3384 // again, if need be (at which point, this check will pass, if relevant).
3385 if atomic.Load(&gcBlackenEnabled) == 0 || !gcController.needIdleMarkWorker() {
3388 if !gcMarkWorkAvailable(nil) {
3392 // Work is available; we can start an idle GC worker only if there is
3393 // an available P and available worker G.
3395 // We can attempt to acquire these in either order, though both have
3396 // synchronization concerns (see below). Workers are almost always
3397 // available (see comment in findRunnableGCWorker for the one case
3398 // there may be none). Since we're slightly less likely to find a P,
3399 // check for that first.
3401 // Synchronization: note that we must hold sched.lock until we are
3402 // committed to keeping it. Otherwise we cannot put the unnecessary P
3403 // back in sched.pidle without performing the full set of idle
3404 // transition checks.
3406 // If we were to check gcBgMarkWorkerPool first, we must somehow handle
3407 // the assumption in gcControllerState.findRunnableGCWorker that an
3408 // empty gcBgMarkWorkerPool is only possible if gcMarkDone is running.
3410 pp, now := pidlegetSpinning(0)
3416 // Now that we own a P, gcBlackenEnabled can't change (as it requires STW).
3417 if gcBlackenEnabled == 0 || !gcController.addIdleMarkWorker() {
3423 node := (*gcBgMarkWorkerNode)(gcBgMarkWorkerPool.pop())
3427 gcController.removeIdleMarkWorker()
3433 return pp, node.gp.ptr()
3436 // wakeNetPoller wakes up the thread sleeping in the network poller if it isn't
3437 // going to wake up before the when argument; or it wakes an idle P to service
3438 // timers and the network poller if there isn't one already.
3439 func wakeNetPoller(when int64) {
3440 if sched.lastpoll.Load() == 0 {
3441 // In findrunnable we ensure that when polling the pollUntil
3442 // field is either zero or the time to which the current
3443 // poll is expected to run. This can have a spurious wakeup
3444 // but should never miss a wakeup.
3445 pollerPollUntil := sched.pollUntil.Load()
3446 if pollerPollUntil == 0 || pollerPollUntil > when {
3450 // There are no threads in the network poller, try to get
3451 // one there so it can handle new timers.
3452 if GOOS != "plan9" { // Temporary workaround - see issue #42303.
3458 func resetspinning() {
3461 throw("resetspinning: not a spinning m")
3463 gp.m.spinning = false
3464 nmspinning := sched.nmspinning.Add(-1)
3466 throw("findrunnable: negative nmspinning")
3468 // M wakeup policy is deliberately somewhat conservative, so check if we
3469 // need to wakeup another P here. See "Worker thread parking/unparking"
3470 // comment at the top of the file for details.
3474 // injectglist adds each runnable G on the list to some run queue,
3475 // and clears glist. If there is no current P, they are added to the
3476 // global queue, and up to npidle M's are started to run them.
3477 // Otherwise, for each idle P, this adds a G to the global queue
3478 // and starts an M. Any remaining G's are added to the current P's
3480 // This may temporarily acquire sched.lock.
3481 // Can run concurrently with GC.
3482 func injectglist(glist *gList) {
3487 for gp := glist.head.ptr(); gp != nil; gp = gp.schedlink.ptr() {
3488 traceGoUnpark(gp, 0)
3492 // Mark all the goroutines as runnable before we put them
3493 // on the run queues.
3494 head := glist.head.ptr()
3497 for gp := head; gp != nil; gp = gp.schedlink.ptr() {
3500 casgstatus(gp, _Gwaiting, _Grunnable)
3503 // Turn the gList into a gQueue.
3509 startIdle := func(n int) {
3510 for i := 0; i < n; i++ {
3511 mp := acquirem() // See comment in startm.
3514 pp, _ := pidlegetSpinning(0)
3521 startm(pp, false, true)
3527 pp := getg().m.p.ptr()
3530 globrunqputbatch(&q, int32(qsize))
3536 npidle := int(sched.npidle.Load())
3539 for n = 0; n < npidle && !q.empty(); n++ {
3545 globrunqputbatch(&globq, int32(n))
3552 runqputbatch(pp, &q, qsize)
3556 // One round of scheduler: find a runnable goroutine and execute it.
3562 throw("schedule: holding locks")
3565 if mp.lockedg != 0 {
3567 execute(mp.lockedg.ptr(), false) // Never returns.
3570 // We should not schedule away from a g that is executing a cgo call,
3571 // since the cgo call is using the m's g0 stack.
3573 throw("schedule: in cgo")
3580 // Safety check: if we are spinning, the run queue should be empty.
3581 // Check this before calling checkTimers, as that might call
3582 // goready to put a ready goroutine on the local run queue.
3583 if mp.spinning && (pp.runnext != 0 || pp.runqhead != pp.runqtail) {
3584 throw("schedule: spinning with local work")
3587 gp, inheritTime, tryWakeP := findRunnable() // blocks until work is available
3589 if debug.dontfreezetheworld > 0 && freezing.Load() {
3590 // See comment in freezetheworld. We don't want to perturb
3591 // scheduler state, so we didn't gcstopm in findRunnable, but
3592 // also don't want to allow new goroutines to run.
3594 // Deadlock here rather than in the findRunnable loop so if
3595 // findRunnable is stuck in a loop we don't perturb that
3601 // This thread is going to run a goroutine and is not spinning anymore,
3602 // so if it was marked as spinning we need to reset it now and potentially
3603 // start a new spinning M.
3608 if sched.disable.user && !schedEnabled(gp) {
3609 // Scheduling of this goroutine is disabled. Put it on
3610 // the list of pending runnable goroutines for when we
3611 // re-enable user scheduling and look again.
3613 if schedEnabled(gp) {
3614 // Something re-enabled scheduling while we
3615 // were acquiring the lock.
3618 sched.disable.runnable.pushBack(gp)
3625 // If about to schedule a not-normal goroutine (a GCworker or tracereader),
3626 // wake a P if there is one.
3630 if gp.lockedm != 0 {
3631 // Hands off own p to the locked m,
3632 // then blocks waiting for a new p.
3637 execute(gp, inheritTime)
3640 // dropg removes the association between m and the current goroutine m->curg (gp for short).
3641 // Typically a caller sets gp's status away from Grunning and then
3642 // immediately calls dropg to finish the job. The caller is also responsible
3643 // for arranging that gp will be restarted using ready at an
3644 // appropriate time. After calling dropg and arranging for gp to be
3645 // readied later, the caller can do other work but eventually should
3646 // call schedule to restart the scheduling of goroutines on this m.
3650 setMNoWB(&gp.m.curg.m, nil)
3651 setGNoWB(&gp.m.curg, nil)
3654 // checkTimers runs any timers for the P that are ready.
3655 // If now is not 0 it is the current time.
3656 // It returns the passed time or the current time if now was passed as 0.
3657 // and the time when the next timer should run or 0 if there is no next timer,
3658 // and reports whether it ran any timers.
3659 // If the time when the next timer should run is not 0,
3660 // it is always larger than the returned time.
3661 // We pass now in and out to avoid extra calls of nanotime.
3663 //go:yeswritebarrierrec
3664 func checkTimers(pp *p, now int64) (rnow, pollUntil int64, ran bool) {
3665 // If it's not yet time for the first timer, or the first adjusted
3666 // timer, then there is nothing to do.
3667 next := pp.timer0When.Load()
3668 nextAdj := pp.timerModifiedEarliest.Load()
3669 if next == 0 || (nextAdj != 0 && nextAdj < next) {
3674 // No timers to run or adjust.
3675 return now, 0, false
3682 // Next timer is not ready to run, but keep going
3683 // if we would clear deleted timers.
3684 // This corresponds to the condition below where
3685 // we decide whether to call clearDeletedTimers.
3686 if pp != getg().m.p.ptr() || int(pp.deletedTimers.Load()) <= int(pp.numTimers.Load()/4) {
3687 return now, next, false
3691 lock(&pp.timersLock)
3693 if len(pp.timers) > 0 {
3694 adjusttimers(pp, now)
3695 for len(pp.timers) > 0 {
3696 // Note that runtimer may temporarily unlock
3698 if tw := runtimer(pp, now); tw != 0 {
3708 // If this is the local P, and there are a lot of deleted timers,
3709 // clear them out. We only do this for the local P to reduce
3710 // lock contention on timersLock.
3711 if pp == getg().m.p.ptr() && int(pp.deletedTimers.Load()) > len(pp.timers)/4 {
3712 clearDeletedTimers(pp)
3715 unlock(&pp.timersLock)
3717 return now, pollUntil, ran
3720 func parkunlock_c(gp *g, lock unsafe.Pointer) bool {
3721 unlock((*mutex)(lock))
3725 // park continuation on g0.
3726 func park_m(gp *g) {
3730 traceGoPark(mp.waitTraceBlockReason, mp.waitTraceSkip)
3733 // N.B. Not using casGToWaiting here because the waitreason is
3734 // set by park_m's caller.
3735 casgstatus(gp, _Grunning, _Gwaiting)
3738 if fn := mp.waitunlockf; fn != nil {
3739 ok := fn(gp, mp.waitlock)
3740 mp.waitunlockf = nil
3744 traceGoUnpark(gp, 2)
3746 casgstatus(gp, _Gwaiting, _Grunnable)
3747 execute(gp, true) // Schedule it back, never returns.
3753 func goschedImpl(gp *g) {
3754 status := readgstatus(gp)
3755 if status&^_Gscan != _Grunning {
3757 throw("bad g status")
3759 casgstatus(gp, _Grunning, _Grunnable)
3772 // Gosched continuation on g0.
3773 func gosched_m(gp *g) {
3780 // goschedguarded is a forbidden-states-avoided version of gosched_m.
3781 func goschedguarded_m(gp *g) {
3783 if !canPreemptM(gp.m) {
3784 gogo(&gp.sched) // never return
3793 func gopreempt_m(gp *g) {
3800 // preemptPark parks gp and puts it in _Gpreempted.
3803 func preemptPark(gp *g) {
3805 traceGoPark(traceBlockPreempted, 0)
3807 status := readgstatus(gp)
3808 if status&^_Gscan != _Grunning {
3810 throw("bad g status")
3813 if gp.asyncSafePoint {
3814 // Double-check that async preemption does not
3815 // happen in SPWRITE assembly functions.
3816 // isAsyncSafePoint must exclude this case.
3817 f := findfunc(gp.sched.pc)
3819 throw("preempt at unknown pc")
3821 if f.flag&abi.FuncFlagSPWrite != 0 {
3822 println("runtime: unexpected SPWRITE function", funcname(f), "in async preempt")
3823 throw("preempt SPWRITE")
3827 // Transition from _Grunning to _Gscan|_Gpreempted. We can't
3828 // be in _Grunning when we dropg because then we'd be running
3829 // without an M, but the moment we're in _Gpreempted,
3830 // something could claim this G before we've fully cleaned it
3831 // up. Hence, we set the scan bit to lock down further
3832 // transitions until we can dropg.
3833 casGToPreemptScan(gp, _Grunning, _Gscan|_Gpreempted)
3835 casfrom_Gscanstatus(gp, _Gscan|_Gpreempted, _Gpreempted)
3839 // goyield is like Gosched, but it:
3840 // - emits a GoPreempt trace event instead of a GoSched trace event
3841 // - puts the current G on the runq of the current P instead of the globrunq
3847 func goyield_m(gp *g) {
3852 casgstatus(gp, _Grunning, _Grunnable)
3854 runqput(pp, gp, false)
3858 // Finishes execution of the current goroutine.
3869 // goexit continuation on g0.
3870 func goexit0(gp *g) {
3874 casgstatus(gp, _Grunning, _Gdead)
3875 gcController.addScannableStack(pp, -int64(gp.stack.hi-gp.stack.lo))
3876 if isSystemGoroutine(gp, false) {
3880 locked := gp.lockedm != 0
3883 gp.preemptStop = false
3884 gp.paniconfault = false
3885 gp._defer = nil // should be true already but just in case.
3886 gp._panic = nil // non-nil for Goexit during panic. points at stack-allocated data.
3888 gp.waitreason = waitReasonZero
3893 if gcBlackenEnabled != 0 && gp.gcAssistBytes > 0 {
3894 // Flush assist credit to the global pool. This gives
3895 // better information to pacing if the application is
3896 // rapidly creating an exiting goroutines.
3897 assistWorkPerByte := gcController.assistWorkPerByte.Load()
3898 scanCredit := int64(assistWorkPerByte * float64(gp.gcAssistBytes))
3899 gcController.bgScanCredit.Add(scanCredit)
3900 gp.gcAssistBytes = 0
3905 if GOARCH == "wasm" { // no threads yet on wasm
3907 schedule() // never returns
3910 if mp.lockedInt != 0 {
3911 print("invalid m->lockedInt = ", mp.lockedInt, "\n")
3912 throw("internal lockOSThread error")
3916 // The goroutine may have locked this thread because
3917 // it put it in an unusual kernel state. Kill it
3918 // rather than returning it to the thread pool.
3920 // Return to mstart, which will release the P and exit
3922 if GOOS != "plan9" { // See golang.org/issue/22227.
3925 // Clear lockedExt on plan9 since we may end up re-using
3933 // save updates getg().sched to refer to pc and sp so that a following
3934 // gogo will restore pc and sp.
3936 // save must not have write barriers because invoking a write barrier
3937 // can clobber getg().sched.
3940 //go:nowritebarrierrec
3941 func save(pc, sp uintptr) {
3944 if gp == gp.m.g0 || gp == gp.m.gsignal {
3945 // m.g0.sched is special and must describe the context
3946 // for exiting the thread. mstart1 writes to it directly.
3947 // m.gsignal.sched should not be used at all.
3948 // This check makes sure save calls do not accidentally
3949 // run in contexts where they'd write to system g's.
3950 throw("save on system g not allowed")
3957 // We need to ensure ctxt is zero, but can't have a write
3958 // barrier here. However, it should always already be zero.
3960 if gp.sched.ctxt != nil {
3965 // The goroutine g is about to enter a system call.
3966 // Record that it's not using the cpu anymore.
3967 // This is called only from the go syscall library and cgocall,
3968 // not from the low-level system calls used by the runtime.
3970 // Entersyscall cannot split the stack: the save must
3971 // make g->sched refer to the caller's stack segment, because
3972 // entersyscall is going to return immediately after.
3974 // Nothing entersyscall calls can split the stack either.
3975 // We cannot safely move the stack during an active call to syscall,
3976 // because we do not know which of the uintptr arguments are
3977 // really pointers (back into the stack).
3978 // In practice, this means that we make the fast path run through
3979 // entersyscall doing no-split things, and the slow path has to use systemstack
3980 // to run bigger things on the system stack.
3982 // reentersyscall is the entry point used by cgo callbacks, where explicitly
3983 // saved SP and PC are restored. This is needed when exitsyscall will be called
3984 // from a function further up in the call stack than the parent, as g->syscallsp
3985 // must always point to a valid stack frame. entersyscall below is the normal
3986 // entry point for syscalls, which obtains the SP and PC from the caller.
3989 // At the start of a syscall we emit traceGoSysCall to capture the stack trace.
3990 // If the syscall does not block, that is it, we do not emit any other events.
3991 // If the syscall blocks (that is, P is retaken), retaker emits traceGoSysBlock;
3992 // when syscall returns we emit traceGoSysExit and when the goroutine starts running
3993 // (potentially instantly, if exitsyscallfast returns true) we emit traceGoStart.
3994 // To ensure that traceGoSysExit is emitted strictly after traceGoSysBlock,
3995 // we remember current value of syscalltick in m (gp.m.syscalltick = gp.m.p.ptr().syscalltick),
3996 // whoever emits traceGoSysBlock increments p.syscalltick afterwards;
3997 // and we wait for the increment before emitting traceGoSysExit.
3998 // Note that the increment is done even if tracing is not enabled,
3999 // because tracing can be enabled in the middle of syscall. We don't want the wait to hang.
4002 func reentersyscall(pc, sp uintptr) {
4005 // Disable preemption because during this function g is in Gsyscall status,
4006 // but can have inconsistent g->sched, do not let GC observe it.
4009 // Entersyscall must not call any function that might split/grow the stack.
4010 // (See details in comment above.)
4011 // Catch calls that might, by replacing the stack guard with something that
4012 // will trip any stack check and leaving a flag to tell newstack to die.
4013 gp.stackguard0 = stackPreempt
4014 gp.throwsplit = true
4016 // Leave SP around for GC and traceback.
4020 casgstatus(gp, _Grunning, _Gsyscall)
4021 if staticLockRanking {
4022 // When doing static lock ranking casgstatus can call
4023 // systemstack which clobbers g.sched.
4026 if gp.syscallsp < gp.stack.lo || gp.stack.hi < gp.syscallsp {
4027 systemstack(func() {
4028 print("entersyscall inconsistent ", hex(gp.syscallsp), " [", hex(gp.stack.lo), ",", hex(gp.stack.hi), "]\n")
4029 throw("entersyscall")
4034 systemstack(traceGoSysCall)
4035 // systemstack itself clobbers g.sched.{pc,sp} and we might
4036 // need them later when the G is genuinely blocked in a
4041 if sched.sysmonwait.Load() {
4042 systemstack(entersyscall_sysmon)
4046 if gp.m.p.ptr().runSafePointFn != 0 {
4047 // runSafePointFn may stack split if run on this stack
4048 systemstack(runSafePointFn)
4052 gp.m.syscalltick = gp.m.p.ptr().syscalltick
4057 atomic.Store(&pp.status, _Psyscall)
4058 if sched.gcwaiting.Load() {
4059 systemstack(entersyscall_gcwait)
4066 // Standard syscall entry used by the go syscall library and normal cgo calls.
4068 // This is exported via linkname to assembly in the syscall package and x/sys.
4071 //go:linkname entersyscall
4072 func entersyscall() {
4073 reentersyscall(getcallerpc(), getcallersp())
4076 func entersyscall_sysmon() {
4078 if sched.sysmonwait.Load() {
4079 sched.sysmonwait.Store(false)
4080 notewakeup(&sched.sysmonnote)
4085 func entersyscall_gcwait() {
4087 pp := gp.m.oldp.ptr()
4090 if sched.stopwait > 0 && atomic.Cas(&pp.status, _Psyscall, _Pgcstop) {
4096 if sched.stopwait--; sched.stopwait == 0 {
4097 notewakeup(&sched.stopnote)
4103 // The same as entersyscall(), but with a hint that the syscall is blocking.
4106 func entersyscallblock() {
4109 gp.m.locks++ // see comment in entersyscall
4110 gp.throwsplit = true
4111 gp.stackguard0 = stackPreempt // see comment in entersyscall
4112 gp.m.syscalltick = gp.m.p.ptr().syscalltick
4113 gp.m.p.ptr().syscalltick++
4115 // Leave SP around for GC and traceback.
4119 gp.syscallsp = gp.sched.sp
4120 gp.syscallpc = gp.sched.pc
4121 if gp.syscallsp < gp.stack.lo || gp.stack.hi < gp.syscallsp {
4125 systemstack(func() {
4126 print("entersyscallblock inconsistent ", hex(sp1), " ", hex(sp2), " ", hex(sp3), " [", hex(gp.stack.lo), ",", hex(gp.stack.hi), "]\n")
4127 throw("entersyscallblock")
4130 casgstatus(gp, _Grunning, _Gsyscall)
4131 if gp.syscallsp < gp.stack.lo || gp.stack.hi < gp.syscallsp {
4132 systemstack(func() {
4133 print("entersyscallblock inconsistent ", hex(sp), " ", hex(gp.sched.sp), " ", hex(gp.syscallsp), " [", hex(gp.stack.lo), ",", hex(gp.stack.hi), "]\n")
4134 throw("entersyscallblock")
4138 systemstack(entersyscallblock_handoff)
4140 // Resave for traceback during blocked call.
4141 save(getcallerpc(), getcallersp())
4146 func entersyscallblock_handoff() {
4149 traceGoSysBlock(getg().m.p.ptr())
4151 handoffp(releasep())
4154 // The goroutine g exited its system call.
4155 // Arrange for it to run on a cpu again.
4156 // This is called only from the go syscall library, not
4157 // from the low-level system calls used by the runtime.
4159 // Write barriers are not allowed because our P may have been stolen.
4161 // This is exported via linkname to assembly in the syscall package.
4164 //go:nowritebarrierrec
4165 //go:linkname exitsyscall
4166 func exitsyscall() {
4169 gp.m.locks++ // see comment in entersyscall
4170 if getcallersp() > gp.syscallsp {
4171 throw("exitsyscall: syscall frame is no longer valid")
4175 oldp := gp.m.oldp.ptr()
4177 if exitsyscallfast(oldp) {
4178 // When exitsyscallfast returns success, we have a P so can now use
4180 if goroutineProfile.active {
4181 // Make sure that gp has had its stack written out to the goroutine
4182 // profile, exactly as it was when the goroutine profiler first
4183 // stopped the world.
4184 systemstack(func() {
4185 tryRecordGoroutineProfileWB(gp)
4189 if oldp != gp.m.p.ptr() || gp.m.syscalltick != gp.m.p.ptr().syscalltick {
4190 systemstack(traceGoStart)
4193 // There's a cpu for us, so we can run.
4194 gp.m.p.ptr().syscalltick++
4195 // We need to cas the status and scan before resuming...
4196 casgstatus(gp, _Gsyscall, _Grunning)
4198 // Garbage collector isn't running (since we are),
4199 // so okay to clear syscallsp.
4203 // restore the preemption request in case we've cleared it in newstack
4204 gp.stackguard0 = stackPreempt
4206 // otherwise restore the real stackGuard, we've spoiled it in entersyscall/entersyscallblock
4207 gp.stackguard0 = gp.stack.lo + stackGuard
4209 gp.throwsplit = false
4211 if sched.disable.user && !schedEnabled(gp) {
4212 // Scheduling of this goroutine is disabled.
4220 // Wait till traceGoSysBlock event is emitted.
4221 // This ensures consistency of the trace (the goroutine is started after it is blocked).
4222 for oldp != nil && oldp.syscalltick == gp.m.syscalltick {
4225 // We can't trace syscall exit right now because we don't have a P.
4226 // Tracing code can invoke write barriers that cannot run without a P.
4227 // So instead we remember the syscall exit time and emit the event
4228 // in execute when we have a P.
4229 gp.trace.sysExitTime = traceClockNow()
4234 // Call the scheduler.
4237 // Scheduler returned, so we're allowed to run now.
4238 // Delete the syscallsp information that we left for
4239 // the garbage collector during the system call.
4240 // Must wait until now because until gosched returns
4241 // we don't know for sure that the garbage collector
4244 gp.m.p.ptr().syscalltick++
4245 gp.throwsplit = false
4249 func exitsyscallfast(oldp *p) bool {
4252 // Freezetheworld sets stopwait but does not retake P's.
4253 if sched.stopwait == freezeStopWait {
4257 // Try to re-acquire the last P.
4258 if oldp != nil && oldp.status == _Psyscall && atomic.Cas(&oldp.status, _Psyscall, _Pidle) {
4259 // There's a cpu for us, so we can run.
4261 exitsyscallfast_reacquired()
4265 // Try to get any other idle P.
4266 if sched.pidle != 0 {
4268 systemstack(func() {
4269 ok = exitsyscallfast_pidle()
4270 if ok && traceEnabled() {
4272 // Wait till traceGoSysBlock event is emitted.
4273 // This ensures consistency of the trace (the goroutine is started after it is blocked).
4274 for oldp.syscalltick == gp.m.syscalltick {
4288 // exitsyscallfast_reacquired is the exitsyscall path on which this G
4289 // has successfully reacquired the P it was running on before the
4293 func exitsyscallfast_reacquired() {
4295 if gp.m.syscalltick != gp.m.p.ptr().syscalltick {
4297 // The p was retaken and then enter into syscall again (since gp.m.syscalltick has changed).
4298 // traceGoSysBlock for this syscall was already emitted,
4299 // but here we effectively retake the p from the new syscall running on the same p.
4300 systemstack(func() {
4301 // Denote blocking of the new syscall.
4302 traceGoSysBlock(gp.m.p.ptr())
4303 // Denote completion of the current syscall.
4307 gp.m.p.ptr().syscalltick++
4311 func exitsyscallfast_pidle() bool {
4313 pp, _ := pidleget(0)
4314 if pp != nil && sched.sysmonwait.Load() {
4315 sched.sysmonwait.Store(false)
4316 notewakeup(&sched.sysmonnote)
4326 // exitsyscall slow path on g0.
4327 // Failed to acquire P, enqueue gp as runnable.
4329 // Called via mcall, so gp is the calling g from this M.
4331 //go:nowritebarrierrec
4332 func exitsyscall0(gp *g) {
4333 casgstatus(gp, _Gsyscall, _Grunnable)
4337 if schedEnabled(gp) {
4344 // Below, we stoplockedm if gp is locked. globrunqput releases
4345 // ownership of gp, so we must check if gp is locked prior to
4346 // committing the release by unlocking sched.lock, otherwise we
4347 // could race with another M transitioning gp from unlocked to
4349 locked = gp.lockedm != 0
4350 } else if sched.sysmonwait.Load() {
4351 sched.sysmonwait.Store(false)
4352 notewakeup(&sched.sysmonnote)
4357 execute(gp, false) // Never returns.
4360 // Wait until another thread schedules gp and so m again.
4362 // N.B. lockedm must be this M, as this g was running on this M
4363 // before entersyscall.
4365 execute(gp, false) // Never returns.
4368 schedule() // Never returns.
4371 // Called from syscall package before fork.
4373 //go:linkname syscall_runtime_BeforeFork syscall.runtime_BeforeFork
4375 func syscall_runtime_BeforeFork() {
4378 // Block signals during a fork, so that the child does not run
4379 // a signal handler before exec if a signal is sent to the process
4380 // group. See issue #18600.
4382 sigsave(&gp.m.sigmask)
4385 // This function is called before fork in syscall package.
4386 // Code between fork and exec must not allocate memory nor even try to grow stack.
4387 // Here we spoil g.stackguard0 to reliably detect any attempts to grow stack.
4388 // runtime_AfterFork will undo this in parent process, but not in child.
4389 gp.stackguard0 = stackFork
4392 // Called from syscall package after fork in parent.
4394 //go:linkname syscall_runtime_AfterFork syscall.runtime_AfterFork
4396 func syscall_runtime_AfterFork() {
4399 // See the comments in beforefork.
4400 gp.stackguard0 = gp.stack.lo + stackGuard
4402 msigrestore(gp.m.sigmask)
4407 // inForkedChild is true while manipulating signals in the child process.
4408 // This is used to avoid calling libc functions in case we are using vfork.
4409 var inForkedChild bool
4411 // Called from syscall package after fork in child.
4412 // It resets non-sigignored signals to the default handler, and
4413 // restores the signal mask in preparation for the exec.
4415 // Because this might be called during a vfork, and therefore may be
4416 // temporarily sharing address space with the parent process, this must
4417 // not change any global variables or calling into C code that may do so.
4419 //go:linkname syscall_runtime_AfterForkInChild syscall.runtime_AfterForkInChild
4421 //go:nowritebarrierrec
4422 func syscall_runtime_AfterForkInChild() {
4423 // It's OK to change the global variable inForkedChild here
4424 // because we are going to change it back. There is no race here,
4425 // because if we are sharing address space with the parent process,
4426 // then the parent process can not be running concurrently.
4427 inForkedChild = true
4429 clearSignalHandlers()
4431 // When we are the child we are the only thread running,
4432 // so we know that nothing else has changed gp.m.sigmask.
4433 msigrestore(getg().m.sigmask)
4435 inForkedChild = false
4438 // pendingPreemptSignals is the number of preemption signals
4439 // that have been sent but not received. This is only used on Darwin.
4441 var pendingPreemptSignals atomic.Int32
4443 // Called from syscall package before Exec.
4445 //go:linkname syscall_runtime_BeforeExec syscall.runtime_BeforeExec
4446 func syscall_runtime_BeforeExec() {
4447 // Prevent thread creation during exec.
4450 // On Darwin, wait for all pending preemption signals to
4451 // be received. See issue #41702.
4452 if GOOS == "darwin" || GOOS == "ios" {
4453 for pendingPreemptSignals.Load() > 0 {
4459 // Called from syscall package after Exec.
4461 //go:linkname syscall_runtime_AfterExec syscall.runtime_AfterExec
4462 func syscall_runtime_AfterExec() {
4466 // Allocate a new g, with a stack big enough for stacksize bytes.
4467 func malg(stacksize int32) *g {
4470 stacksize = round2(stackSystem + stacksize)
4471 systemstack(func() {
4472 newg.stack = stackalloc(uint32(stacksize))
4474 newg.stackguard0 = newg.stack.lo + stackGuard
4475 newg.stackguard1 = ^uintptr(0)
4476 // Clear the bottom word of the stack. We record g
4477 // there on gsignal stack during VDSO on ARM and ARM64.
4478 *(*uintptr)(unsafe.Pointer(newg.stack.lo)) = 0
4483 // Create a new g running fn.
4484 // Put it on the queue of g's waiting to run.
4485 // The compiler turns a go statement into a call to this.
4486 func newproc(fn *funcval) {
4489 systemstack(func() {
4490 newg := newproc1(fn, gp, pc)
4492 pp := getg().m.p.ptr()
4493 runqput(pp, newg, true)
4501 // Create a new g in state _Grunnable, starting at fn. callerpc is the
4502 // address of the go statement that created this. The caller is responsible
4503 // for adding the new g to the scheduler.
4504 func newproc1(fn *funcval, callergp *g, callerpc uintptr) *g {
4506 fatal("go of nil func value")
4509 mp := acquirem() // disable preemption because we hold M and P in local vars.
4513 newg = malg(stackMin)
4514 casgstatus(newg, _Gidle, _Gdead)
4515 allgadd(newg) // publishes with a g->status of Gdead so GC scanner doesn't look at uninitialized stack.
4517 if newg.stack.hi == 0 {
4518 throw("newproc1: newg missing stack")
4521 if readgstatus(newg) != _Gdead {
4522 throw("newproc1: new g is not Gdead")
4525 totalSize := uintptr(4*goarch.PtrSize + sys.MinFrameSize) // extra space in case of reads slightly beyond frame
4526 totalSize = alignUp(totalSize, sys.StackAlign)
4527 sp := newg.stack.hi - totalSize
4530 *(*uintptr)(unsafe.Pointer(sp)) = 0
4533 if GOARCH == "arm64" {
4535 *(*uintptr)(unsafe.Pointer(sp - goarch.PtrSize)) = 0
4538 memclrNoHeapPointers(unsafe.Pointer(&newg.sched), unsafe.Sizeof(newg.sched))
4541 newg.sched.pc = abi.FuncPCABI0(goexit) + sys.PCQuantum // +PCQuantum so that previous instruction is in same function
4542 newg.sched.g = guintptr(unsafe.Pointer(newg))
4543 gostartcallfn(&newg.sched, fn)
4544 newg.parentGoid = callergp.goid
4545 newg.gopc = callerpc
4546 newg.ancestors = saveAncestors(callergp)
4547 newg.startpc = fn.fn
4548 if isSystemGoroutine(newg, false) {
4551 // Only user goroutines inherit pprof labels.
4553 newg.labels = mp.curg.labels
4555 if goroutineProfile.active {
4556 // A concurrent goroutine profile is running. It should include
4557 // exactly the set of goroutines that were alive when the goroutine
4558 // profiler first stopped the world. That does not include newg, so
4559 // mark it as not needing a profile before transitioning it from
4561 newg.goroutineProfiled.Store(goroutineProfileSatisfied)
4564 // Track initial transition?
4565 newg.trackingSeq = uint8(fastrand())
4566 if newg.trackingSeq%gTrackingPeriod == 0 {
4567 newg.tracking = true
4569 casgstatus(newg, _Gdead, _Grunnable)
4570 gcController.addScannableStack(pp, int64(newg.stack.hi-newg.stack.lo))
4572 if pp.goidcache == pp.goidcacheend {
4573 // Sched.goidgen is the last allocated id,
4574 // this batch must be [sched.goidgen+1, sched.goidgen+GoidCacheBatch].
4575 // At startup sched.goidgen=0, so main goroutine receives goid=1.
4576 pp.goidcache = sched.goidgen.Add(_GoidCacheBatch)
4577 pp.goidcache -= _GoidCacheBatch - 1
4578 pp.goidcacheend = pp.goidcache + _GoidCacheBatch
4580 newg.goid = pp.goidcache
4583 newg.racectx = racegostart(callerpc)
4585 if newg.labels != nil {
4586 // See note in proflabel.go on labelSync's role in synchronizing
4587 // with the reads in the signal handler.
4588 racereleasemergeg(newg, unsafe.Pointer(&labelSync))
4592 traceGoCreate(newg, newg.startpc)
4599 // saveAncestors copies previous ancestors of the given caller g and
4600 // includes info for the current caller into a new set of tracebacks for
4601 // a g being created.
4602 func saveAncestors(callergp *g) *[]ancestorInfo {
4603 // Copy all prior info, except for the root goroutine (goid 0).
4604 if debug.tracebackancestors <= 0 || callergp.goid == 0 {
4607 var callerAncestors []ancestorInfo
4608 if callergp.ancestors != nil {
4609 callerAncestors = *callergp.ancestors
4611 n := int32(len(callerAncestors)) + 1
4612 if n > debug.tracebackancestors {
4613 n = debug.tracebackancestors
4615 ancestors := make([]ancestorInfo, n)
4616 copy(ancestors[1:], callerAncestors)
4618 var pcs [tracebackInnerFrames]uintptr
4619 npcs := gcallers(callergp, 0, pcs[:])
4620 ipcs := make([]uintptr, npcs)
4622 ancestors[0] = ancestorInfo{
4624 goid: callergp.goid,
4625 gopc: callergp.gopc,
4628 ancestorsp := new([]ancestorInfo)
4629 *ancestorsp = ancestors
4633 // Put on gfree list.
4634 // If local list is too long, transfer a batch to the global list.
4635 func gfput(pp *p, gp *g) {
4636 if readgstatus(gp) != _Gdead {
4637 throw("gfput: bad status (not Gdead)")
4640 stksize := gp.stack.hi - gp.stack.lo
4642 if stksize != uintptr(startingStackSize) {
4643 // non-standard stack size - free it.
4652 if pp.gFree.n >= 64 {
4658 for pp.gFree.n >= 32 {
4659 gp := pp.gFree.pop()
4661 if gp.stack.lo == 0 {
4668 lock(&sched.gFree.lock)
4669 sched.gFree.noStack.pushAll(noStackQ)
4670 sched.gFree.stack.pushAll(stackQ)
4671 sched.gFree.n += inc
4672 unlock(&sched.gFree.lock)
4676 // Get from gfree list.
4677 // If local list is empty, grab a batch from global list.
4678 func gfget(pp *p) *g {
4680 if pp.gFree.empty() && (!sched.gFree.stack.empty() || !sched.gFree.noStack.empty()) {
4681 lock(&sched.gFree.lock)
4682 // Move a batch of free Gs to the P.
4683 for pp.gFree.n < 32 {
4684 // Prefer Gs with stacks.
4685 gp := sched.gFree.stack.pop()
4687 gp = sched.gFree.noStack.pop()
4696 unlock(&sched.gFree.lock)
4699 gp := pp.gFree.pop()
4704 if gp.stack.lo != 0 && gp.stack.hi-gp.stack.lo != uintptr(startingStackSize) {
4705 // Deallocate old stack. We kept it in gfput because it was the
4706 // right size when the goroutine was put on the free list, but
4707 // the right size has changed since then.
4708 systemstack(func() {
4715 if gp.stack.lo == 0 {
4716 // Stack was deallocated in gfput or just above. Allocate a new one.
4717 systemstack(func() {
4718 gp.stack = stackalloc(startingStackSize)
4720 gp.stackguard0 = gp.stack.lo + stackGuard
4723 racemalloc(unsafe.Pointer(gp.stack.lo), gp.stack.hi-gp.stack.lo)
4726 msanmalloc(unsafe.Pointer(gp.stack.lo), gp.stack.hi-gp.stack.lo)
4729 asanunpoison(unsafe.Pointer(gp.stack.lo), gp.stack.hi-gp.stack.lo)
4735 // Purge all cached G's from gfree list to the global list.
4736 func gfpurge(pp *p) {
4742 for !pp.gFree.empty() {
4743 gp := pp.gFree.pop()
4745 if gp.stack.lo == 0 {
4752 lock(&sched.gFree.lock)
4753 sched.gFree.noStack.pushAll(noStackQ)
4754 sched.gFree.stack.pushAll(stackQ)
4755 sched.gFree.n += inc
4756 unlock(&sched.gFree.lock)
4759 // Breakpoint executes a breakpoint trap.
4764 // dolockOSThread is called by LockOSThread and lockOSThread below
4765 // after they modify m.locked. Do not allow preemption during this call,
4766 // or else the m might be different in this function than in the caller.
4769 func dolockOSThread() {
4770 if GOARCH == "wasm" {
4771 return // no threads on wasm yet
4774 gp.m.lockedg.set(gp)
4775 gp.lockedm.set(gp.m)
4778 // LockOSThread wires the calling goroutine to its current operating system thread.
4779 // The calling goroutine will always execute in that thread,
4780 // and no other goroutine will execute in it,
4781 // until the calling goroutine has made as many calls to
4782 // UnlockOSThread as to LockOSThread.
4783 // If the calling goroutine exits without unlocking the thread,
4784 // the thread will be terminated.
4786 // All init functions are run on the startup thread. Calling LockOSThread
4787 // from an init function will cause the main function to be invoked on
4790 // A goroutine should call LockOSThread before calling OS services or
4791 // non-Go library functions that depend on per-thread state.
4794 func LockOSThread() {
4795 if atomic.Load(&newmHandoff.haveTemplateThread) == 0 && GOOS != "plan9" {
4796 // If we need to start a new thread from the locked
4797 // thread, we need the template thread. Start it now
4798 // while we're in a known-good state.
4799 startTemplateThread()
4803 if gp.m.lockedExt == 0 {
4805 panic("LockOSThread nesting overflow")
4811 func lockOSThread() {
4812 getg().m.lockedInt++
4816 // dounlockOSThread is called by UnlockOSThread and unlockOSThread below
4817 // after they update m->locked. Do not allow preemption during this call,
4818 // or else the m might be in different in this function than in the caller.
4821 func dounlockOSThread() {
4822 if GOARCH == "wasm" {
4823 return // no threads on wasm yet
4826 if gp.m.lockedInt != 0 || gp.m.lockedExt != 0 {
4833 // UnlockOSThread undoes an earlier call to LockOSThread.
4834 // If this drops the number of active LockOSThread calls on the
4835 // calling goroutine to zero, it unwires the calling goroutine from
4836 // its fixed operating system thread.
4837 // If there are no active LockOSThread calls, this is a no-op.
4839 // Before calling UnlockOSThread, the caller must ensure that the OS
4840 // thread is suitable for running other goroutines. If the caller made
4841 // any permanent changes to the state of the thread that would affect
4842 // other goroutines, it should not call this function and thus leave
4843 // the goroutine locked to the OS thread until the goroutine (and
4844 // hence the thread) exits.
4847 func UnlockOSThread() {
4849 if gp.m.lockedExt == 0 {
4857 func unlockOSThread() {
4859 if gp.m.lockedInt == 0 {
4860 systemstack(badunlockosthread)
4866 func badunlockosthread() {
4867 throw("runtime: internal error: misuse of lockOSThread/unlockOSThread")
4870 func gcount() int32 {
4871 n := int32(atomic.Loaduintptr(&allglen)) - sched.gFree.n - sched.ngsys.Load()
4872 for _, pp := range allp {
4876 // All these variables can be changed concurrently, so the result can be inconsistent.
4877 // But at least the current goroutine is running.
4884 func mcount() int32 {
4885 return int32(sched.mnext - sched.nmfreed)
4889 signalLock atomic.Uint32
4891 // Must hold signalLock to write. Reads may be lock-free, but
4892 // signalLock should be taken to synchronize with changes.
4896 func _System() { _System() }
4897 func _ExternalCode() { _ExternalCode() }
4898 func _LostExternalCode() { _LostExternalCode() }
4899 func _GC() { _GC() }
4900 func _LostSIGPROFDuringAtomic64() { _LostSIGPROFDuringAtomic64() }
4901 func _VDSO() { _VDSO() }
4903 // Called if we receive a SIGPROF signal.
4904 // Called by the signal handler, may run during STW.
4906 //go:nowritebarrierrec
4907 func sigprof(pc, sp, lr uintptr, gp *g, mp *m) {
4908 if prof.hz.Load() == 0 {
4912 // If mp.profilehz is 0, then profiling is not enabled for this thread.
4913 // We must check this to avoid a deadlock between setcpuprofilerate
4914 // and the call to cpuprof.add, below.
4915 if mp != nil && mp.profilehz == 0 {
4919 // On mips{,le}/arm, 64bit atomics are emulated with spinlocks, in
4920 // runtime/internal/atomic. If SIGPROF arrives while the program is inside
4921 // the critical section, it creates a deadlock (when writing the sample).
4922 // As a workaround, create a counter of SIGPROFs while in critical section
4923 // to store the count, and pass it to sigprof.add() later when SIGPROF is
4924 // received from somewhere else (with _LostSIGPROFDuringAtomic64 as pc).
4925 if GOARCH == "mips" || GOARCH == "mipsle" || GOARCH == "arm" {
4926 if f := findfunc(pc); f.valid() {
4927 if hasPrefix(funcname(f), "runtime/internal/atomic") {
4928 cpuprof.lostAtomic++
4932 if GOARCH == "arm" && goarm < 7 && GOOS == "linux" && pc&0xffff0000 == 0xffff0000 {
4933 // runtime/internal/atomic functions call into kernel
4934 // helpers on arm < 7. See
4935 // runtime/internal/atomic/sys_linux_arm.s.
4936 cpuprof.lostAtomic++
4941 // Profiling runs concurrently with GC, so it must not allocate.
4942 // Set a trap in case the code does allocate.
4943 // Note that on windows, one thread takes profiles of all the
4944 // other threads, so mp is usually not getg().m.
4945 // In fact mp may not even be stopped.
4946 // See golang.org/issue/17165.
4947 getg().m.mallocing++
4950 var stk [maxCPUProfStack]uintptr
4952 if mp.ncgo > 0 && mp.curg != nil && mp.curg.syscallpc != 0 && mp.curg.syscallsp != 0 {
4954 // Check cgoCallersUse to make sure that we are not
4955 // interrupting other code that is fiddling with
4956 // cgoCallers. We are running in a signal handler
4957 // with all signals blocked, so we don't have to worry
4958 // about any other code interrupting us.
4959 if mp.cgoCallersUse.Load() == 0 && mp.cgoCallers != nil && mp.cgoCallers[0] != 0 {
4960 for cgoOff < len(mp.cgoCallers) && mp.cgoCallers[cgoOff] != 0 {
4963 n += copy(stk[:], mp.cgoCallers[:cgoOff])
4964 mp.cgoCallers[0] = 0
4967 // Collect Go stack that leads to the cgo call.
4968 u.initAt(mp.curg.syscallpc, mp.curg.syscallsp, 0, mp.curg, unwindSilentErrors)
4969 } else if usesLibcall() && mp.libcallg != 0 && mp.libcallpc != 0 && mp.libcallsp != 0 {
4970 // Libcall, i.e. runtime syscall on windows.
4971 // Collect Go stack that leads to the call.
4972 u.initAt(mp.libcallpc, mp.libcallsp, 0, mp.libcallg.ptr(), unwindSilentErrors)
4973 } else if mp != nil && mp.vdsoSP != 0 {
4974 // VDSO call, e.g. nanotime1 on Linux.
4975 // Collect Go stack that leads to the call.
4976 u.initAt(mp.vdsoPC, mp.vdsoSP, 0, gp, unwindSilentErrors|unwindJumpStack)
4978 u.initAt(pc, sp, lr, gp, unwindSilentErrors|unwindTrap|unwindJumpStack)
4980 n += tracebackPCs(&u, 0, stk[n:])
4983 // Normal traceback is impossible or has failed.
4984 // Account it against abstract "System" or "GC".
4987 pc = abi.FuncPCABIInternal(_VDSO) + sys.PCQuantum
4988 } else if pc > firstmoduledata.etext {
4989 // "ExternalCode" is better than "etext".
4990 pc = abi.FuncPCABIInternal(_ExternalCode) + sys.PCQuantum
4993 if mp.preemptoff != "" {
4994 stk[1] = abi.FuncPCABIInternal(_GC) + sys.PCQuantum
4996 stk[1] = abi.FuncPCABIInternal(_System) + sys.PCQuantum
5000 if prof.hz.Load() != 0 {
5001 // Note: it can happen on Windows that we interrupted a system thread
5002 // with no g, so gp could nil. The other nil checks are done out of
5003 // caution, but not expected to be nil in practice.
5004 var tagPtr *unsafe.Pointer
5005 if gp != nil && gp.m != nil && gp.m.curg != nil {
5006 tagPtr = &gp.m.curg.labels
5008 cpuprof.add(tagPtr, stk[:n])
5012 if gp != nil && gp.m != nil {
5013 if gp.m.curg != nil {
5018 traceCPUSample(gprof, pp, stk[:n])
5020 getg().m.mallocing--
5023 // setcpuprofilerate sets the CPU profiling rate to hz times per second.
5024 // If hz <= 0, setcpuprofilerate turns off CPU profiling.
5025 func setcpuprofilerate(hz int32) {
5026 // Force sane arguments.
5031 // Disable preemption, otherwise we can be rescheduled to another thread
5032 // that has profiling enabled.
5036 // Stop profiler on this thread so that it is safe to lock prof.
5037 // if a profiling signal came in while we had prof locked,
5038 // it would deadlock.
5039 setThreadCPUProfiler(0)
5041 for !prof.signalLock.CompareAndSwap(0, 1) {
5044 if prof.hz.Load() != hz {
5045 setProcessCPUProfiler(hz)
5048 prof.signalLock.Store(0)
5051 sched.profilehz = hz
5055 setThreadCPUProfiler(hz)
5061 // init initializes pp, which may be a freshly allocated p or a
5062 // previously destroyed p, and transitions it to status _Pgcstop.
5063 func (pp *p) init(id int32) {
5065 pp.status = _Pgcstop
5066 pp.sudogcache = pp.sudogbuf[:0]
5067 pp.deferpool = pp.deferpoolbuf[:0]
5069 if pp.mcache == nil {
5072 throw("missing mcache?")
5074 // Use the bootstrap mcache0. Only one P will get
5075 // mcache0: the one with ID 0.
5078 pp.mcache = allocmcache()
5081 if raceenabled && pp.raceprocctx == 0 {
5083 pp.raceprocctx = raceprocctx0
5084 raceprocctx0 = 0 // bootstrap
5086 pp.raceprocctx = raceproccreate()
5089 lockInit(&pp.timersLock, lockRankTimers)
5091 // This P may get timers when it starts running. Set the mask here
5092 // since the P may not go through pidleget (notably P 0 on startup).
5094 // Similarly, we may not go through pidleget before this P starts
5095 // running if it is P 0 on startup.
5099 // destroy releases all of the resources associated with pp and
5100 // transitions it to status _Pdead.
5102 // sched.lock must be held and the world must be stopped.
5103 func (pp *p) destroy() {
5104 assertLockHeld(&sched.lock)
5105 assertWorldStopped()
5107 // Move all runnable goroutines to the global queue
5108 for pp.runqhead != pp.runqtail {
5109 // Pop from tail of local queue
5111 gp := pp.runq[pp.runqtail%uint32(len(pp.runq))].ptr()
5112 // Push onto head of global queue
5115 if pp.runnext != 0 {
5116 globrunqputhead(pp.runnext.ptr())
5119 if len(pp.timers) > 0 {
5120 plocal := getg().m.p.ptr()
5121 // The world is stopped, but we acquire timersLock to
5122 // protect against sysmon calling timeSleepUntil.
5123 // This is the only case where we hold the timersLock of
5124 // more than one P, so there are no deadlock concerns.
5125 lock(&plocal.timersLock)
5126 lock(&pp.timersLock)
5127 moveTimers(plocal, pp.timers)
5129 pp.numTimers.Store(0)
5130 pp.deletedTimers.Store(0)
5131 pp.timer0When.Store(0)
5132 unlock(&pp.timersLock)
5133 unlock(&plocal.timersLock)
5135 // Flush p's write barrier buffer.
5136 if gcphase != _GCoff {
5140 for i := range pp.sudogbuf {
5141 pp.sudogbuf[i] = nil
5143 pp.sudogcache = pp.sudogbuf[:0]
5144 pp.pinnerCache = nil
5145 for j := range pp.deferpoolbuf {
5146 pp.deferpoolbuf[j] = nil
5148 pp.deferpool = pp.deferpoolbuf[:0]
5149 systemstack(func() {
5150 for i := 0; i < pp.mspancache.len; i++ {
5151 // Safe to call since the world is stopped.
5152 mheap_.spanalloc.free(unsafe.Pointer(pp.mspancache.buf[i]))
5154 pp.mspancache.len = 0
5156 pp.pcache.flush(&mheap_.pages)
5157 unlock(&mheap_.lock)
5159 freemcache(pp.mcache)
5164 if pp.timerRaceCtx != 0 {
5165 // The race detector code uses a callback to fetch
5166 // the proc context, so arrange for that callback
5167 // to see the right thing.
5168 // This hack only works because we are the only
5174 racectxend(pp.timerRaceCtx)
5179 raceprocdestroy(pp.raceprocctx)
5186 // Change number of processors.
5188 // sched.lock must be held, and the world must be stopped.
5190 // gcworkbufs must not be being modified by either the GC or the write barrier
5191 // code, so the GC must not be running if the number of Ps actually changes.
5193 // Returns list of Ps with local work, they need to be scheduled by the caller.
5194 func procresize(nprocs int32) *p {
5195 assertLockHeld(&sched.lock)
5196 assertWorldStopped()
5199 if old < 0 || nprocs <= 0 {
5200 throw("procresize: invalid arg")
5203 traceGomaxprocs(nprocs)
5206 // update statistics
5208 if sched.procresizetime != 0 {
5209 sched.totaltime += int64(old) * (now - sched.procresizetime)
5211 sched.procresizetime = now
5213 maskWords := (nprocs + 31) / 32
5215 // Grow allp if necessary.
5216 if nprocs > int32(len(allp)) {
5217 // Synchronize with retake, which could be running
5218 // concurrently since it doesn't run on a P.
5220 if nprocs <= int32(cap(allp)) {
5221 allp = allp[:nprocs]
5223 nallp := make([]*p, nprocs)
5224 // Copy everything up to allp's cap so we
5225 // never lose old allocated Ps.
5226 copy(nallp, allp[:cap(allp)])
5230 if maskWords <= int32(cap(idlepMask)) {
5231 idlepMask = idlepMask[:maskWords]
5232 timerpMask = timerpMask[:maskWords]
5234 nidlepMask := make([]uint32, maskWords)
5235 // No need to copy beyond len, old Ps are irrelevant.
5236 copy(nidlepMask, idlepMask)
5237 idlepMask = nidlepMask
5239 ntimerpMask := make([]uint32, maskWords)
5240 copy(ntimerpMask, timerpMask)
5241 timerpMask = ntimerpMask
5246 // initialize new P's
5247 for i := old; i < nprocs; i++ {
5253 atomicstorep(unsafe.Pointer(&allp[i]), unsafe.Pointer(pp))
5257 if gp.m.p != 0 && gp.m.p.ptr().id < nprocs {
5258 // continue to use the current P
5259 gp.m.p.ptr().status = _Prunning
5260 gp.m.p.ptr().mcache.prepareForSweep()
5262 // release the current P and acquire allp[0].
5264 // We must do this before destroying our current P
5265 // because p.destroy itself has write barriers, so we
5266 // need to do that from a valid P.
5269 // Pretend that we were descheduled
5270 // and then scheduled again to keep
5273 traceProcStop(gp.m.p.ptr())
5287 // g.m.p is now set, so we no longer need mcache0 for bootstrapping.
5290 // release resources from unused P's
5291 for i := nprocs; i < old; i++ {
5294 // can't free P itself because it can be referenced by an M in syscall
5298 if int32(len(allp)) != nprocs {
5300 allp = allp[:nprocs]
5301 idlepMask = idlepMask[:maskWords]
5302 timerpMask = timerpMask[:maskWords]
5307 for i := nprocs - 1; i >= 0; i-- {
5309 if gp.m.p.ptr() == pp {
5317 pp.link.set(runnablePs)
5321 stealOrder.reset(uint32(nprocs))
5322 var int32p *int32 = &gomaxprocs // make compiler check that gomaxprocs is an int32
5323 atomic.Store((*uint32)(unsafe.Pointer(int32p)), uint32(nprocs))
5325 // Notify the limiter that the amount of procs has changed.
5326 gcCPULimiter.resetCapacity(now, nprocs)
5331 // Associate p and the current m.
5333 // This function is allowed to have write barriers even if the caller
5334 // isn't because it immediately acquires pp.
5336 //go:yeswritebarrierrec
5337 func acquirep(pp *p) {
5338 // Do the part that isn't allowed to have write barriers.
5341 // Have p; write barriers now allowed.
5343 // Perform deferred mcache flush before this P can allocate
5344 // from a potentially stale mcache.
5345 pp.mcache.prepareForSweep()
5352 // wirep is the first step of acquirep, which actually associates the
5353 // current M to pp. This is broken out so we can disallow write
5354 // barriers for this part, since we don't yet have a P.
5356 //go:nowritebarrierrec
5362 throw("wirep: already in go")
5364 if pp.m != 0 || pp.status != _Pidle {
5369 print("wirep: p->m=", pp.m, "(", id, ") p->status=", pp.status, "\n")
5370 throw("wirep: invalid p state")
5374 pp.status = _Prunning
5377 // Disassociate p and the current m.
5378 func releasep() *p {
5382 throw("releasep: invalid arg")
5385 if pp.m.ptr() != gp.m || pp.status != _Prunning {
5386 print("releasep: m=", gp.m, " m->p=", gp.m.p.ptr(), " p->m=", hex(pp.m), " p->status=", pp.status, "\n")
5387 throw("releasep: invalid p state")
5390 traceProcStop(gp.m.p.ptr())
5398 func incidlelocked(v int32) {
5400 sched.nmidlelocked += v
5407 // Check for deadlock situation.
5408 // The check is based on number of running M's, if 0 -> deadlock.
5409 // sched.lock must be held.
5411 assertLockHeld(&sched.lock)
5413 // For -buildmode=c-shared or -buildmode=c-archive it's OK if
5414 // there are no running goroutines. The calling program is
5415 // assumed to be running.
5416 if islibrary || isarchive {
5420 // If we are dying because of a signal caught on an already idle thread,
5421 // freezetheworld will cause all running threads to block.
5422 // And runtime will essentially enter into deadlock state,
5423 // except that there is a thread that will call exit soon.
5424 if panicking.Load() > 0 {
5428 // If we are not running under cgo, but we have an extra M then account
5429 // for it. (It is possible to have an extra M on Windows without cgo to
5430 // accommodate callbacks created by syscall.NewCallback. See issue #6751
5433 if !iscgo && cgoHasExtraM && extraMLength.Load() > 0 {
5437 run := mcount() - sched.nmidle - sched.nmidlelocked - sched.nmsys
5442 print("runtime: checkdead: nmidle=", sched.nmidle, " nmidlelocked=", sched.nmidlelocked, " mcount=", mcount(), " nmsys=", sched.nmsys, "\n")
5444 throw("checkdead: inconsistent counts")
5448 forEachG(func(gp *g) {
5449 if isSystemGoroutine(gp, false) {
5452 s := readgstatus(gp)
5453 switch s &^ _Gscan {
5460 print("runtime: checkdead: find g ", gp.goid, " in status ", s, "\n")
5462 throw("checkdead: runnable g")
5465 if grunning == 0 { // possible if main goroutine calls runtime·Goexit()
5466 unlock(&sched.lock) // unlock so that GODEBUG=scheddetail=1 doesn't hang
5467 fatal("no goroutines (main called runtime.Goexit) - deadlock!")
5470 // Maybe jump time forward for playground.
5472 if when := timeSleepUntil(); when < maxWhen {
5475 // Start an M to steal the timer.
5476 pp, _ := pidleget(faketime)
5478 // There should always be a free P since
5479 // nothing is running.
5481 throw("checkdead: no p for timer")
5485 // There should always be a free M since
5486 // nothing is running.
5488 throw("checkdead: no m for timer")
5490 // M must be spinning to steal. We set this to be
5491 // explicit, but since this is the only M it would
5492 // become spinning on its own anyways.
5493 sched.nmspinning.Add(1)
5496 notewakeup(&mp.park)
5501 // There are no goroutines running, so we can look at the P's.
5502 for _, pp := range allp {
5503 if len(pp.timers) > 0 {
5508 unlock(&sched.lock) // unlock so that GODEBUG=scheddetail=1 doesn't hang
5509 fatal("all goroutines are asleep - deadlock!")
5512 // forcegcperiod is the maximum time in nanoseconds between garbage
5513 // collections. If we go this long without a garbage collection, one
5514 // is forced to run.
5516 // This is a variable for testing purposes. It normally doesn't change.
5517 var forcegcperiod int64 = 2 * 60 * 1e9
5519 // needSysmonWorkaround is true if the workaround for
5520 // golang.org/issue/42515 is needed on NetBSD.
5521 var needSysmonWorkaround bool = false
5523 // Always runs without a P, so write barriers are not allowed.
5525 //go:nowritebarrierrec
5532 lasttrace := int64(0)
5533 idle := 0 // how many cycles in succession we had not wokeup somebody
5537 if idle == 0 { // start with 20us sleep...
5539 } else if idle > 50 { // start doubling the sleep after 1ms...
5542 if delay > 10*1000 { // up to 10ms
5547 // sysmon should not enter deep sleep if schedtrace is enabled so that
5548 // it can print that information at the right time.
5550 // It should also not enter deep sleep if there are any active P's so
5551 // that it can retake P's from syscalls, preempt long running G's, and
5552 // poll the network if all P's are busy for long stretches.
5554 // It should wakeup from deep sleep if any P's become active either due
5555 // to exiting a syscall or waking up due to a timer expiring so that it
5556 // can resume performing those duties. If it wakes from a syscall it
5557 // resets idle and delay as a bet that since it had retaken a P from a
5558 // syscall before, it may need to do it again shortly after the
5559 // application starts work again. It does not reset idle when waking
5560 // from a timer to avoid adding system load to applications that spend
5561 // most of their time sleeping.
5563 if debug.schedtrace <= 0 && (sched.gcwaiting.Load() || sched.npidle.Load() == gomaxprocs) {
5565 if sched.gcwaiting.Load() || sched.npidle.Load() == gomaxprocs {
5566 syscallWake := false
5567 next := timeSleepUntil()
5569 sched.sysmonwait.Store(true)
5571 // Make wake-up period small enough
5572 // for the sampling to be correct.
5573 sleep := forcegcperiod / 2
5574 if next-now < sleep {
5577 shouldRelax := sleep >= osRelaxMinNS
5581 syscallWake = notetsleep(&sched.sysmonnote, sleep)
5586 sched.sysmonwait.Store(false)
5587 noteclear(&sched.sysmonnote)
5597 lock(&sched.sysmonlock)
5598 // Update now in case we blocked on sysmonnote or spent a long time
5599 // blocked on schedlock or sysmonlock above.
5602 // trigger libc interceptors if needed
5603 if *cgo_yield != nil {
5604 asmcgocall(*cgo_yield, nil)
5606 // poll network if not polled for more than 10ms
5607 lastpoll := sched.lastpoll.Load()
5608 if netpollinited() && lastpoll != 0 && lastpoll+10*1000*1000 < now {
5609 sched.lastpoll.CompareAndSwap(lastpoll, now)
5610 list, delta := netpoll(0) // non-blocking - returns list of goroutines
5612 // Need to decrement number of idle locked M's
5613 // (pretending that one more is running) before injectglist.
5614 // Otherwise it can lead to the following situation:
5615 // injectglist grabs all P's but before it starts M's to run the P's,
5616 // another M returns from syscall, finishes running its G,
5617 // observes that there is no work to do and no other running M's
5618 // and reports deadlock.
5622 netpollAdjustWaiters(delta)
5625 if GOOS == "netbsd" && needSysmonWorkaround {
5626 // netpoll is responsible for waiting for timer
5627 // expiration, so we typically don't have to worry
5628 // about starting an M to service timers. (Note that
5629 // sleep for timeSleepUntil above simply ensures sysmon
5630 // starts running again when that timer expiration may
5631 // cause Go code to run again).
5633 // However, netbsd has a kernel bug that sometimes
5634 // misses netpollBreak wake-ups, which can lead to
5635 // unbounded delays servicing timers. If we detect this
5636 // overrun, then startm to get something to handle the
5639 // See issue 42515 and
5640 // https://gnats.netbsd.org/cgi-bin/query-pr-single.pl?number=50094.
5641 if next := timeSleepUntil(); next < now {
5642 startm(nil, false, false)
5645 if scavenger.sysmonWake.Load() != 0 {
5646 // Kick the scavenger awake if someone requested it.
5649 // retake P's blocked in syscalls
5650 // and preempt long running G's
5651 if retake(now) != 0 {
5656 // check if we need to force a GC
5657 if t := (gcTrigger{kind: gcTriggerTime, now: now}); t.test() && forcegc.idle.Load() {
5659 forcegc.idle.Store(false)
5661 list.push(forcegc.g)
5663 unlock(&forcegc.lock)
5665 if debug.schedtrace > 0 && lasttrace+int64(debug.schedtrace)*1000000 <= now {
5667 schedtrace(debug.scheddetail > 0)
5669 unlock(&sched.sysmonlock)
5673 type sysmontick struct {
5680 // forcePreemptNS is the time slice given to a G before it is
5682 const forcePreemptNS = 10 * 1000 * 1000 // 10ms
5684 func retake(now int64) uint32 {
5686 // Prevent allp slice changes. This lock will be completely
5687 // uncontended unless we're already stopping the world.
5689 // We can't use a range loop over allp because we may
5690 // temporarily drop the allpLock. Hence, we need to re-fetch
5691 // allp each time around the loop.
5692 for i := 0; i < len(allp); i++ {
5695 // This can happen if procresize has grown
5696 // allp but not yet created new Ps.
5699 pd := &pp.sysmontick
5702 if s == _Prunning || s == _Psyscall {
5703 // Preempt G if it's running for too long.
5704 t := int64(pp.schedtick)
5705 if int64(pd.schedtick) != t {
5706 pd.schedtick = uint32(t)
5708 } else if pd.schedwhen+forcePreemptNS <= now {
5710 // In case of syscall, preemptone() doesn't
5711 // work, because there is no M wired to P.
5716 // Retake P from syscall if it's there for more than 1 sysmon tick (at least 20us).
5717 t := int64(pp.syscalltick)
5718 if !sysretake && int64(pd.syscalltick) != t {
5719 pd.syscalltick = uint32(t)
5720 pd.syscallwhen = now
5723 // On the one hand we don't want to retake Ps if there is no other work to do,
5724 // but on the other hand we want to retake them eventually
5725 // because they can prevent the sysmon thread from deep sleep.
5726 if runqempty(pp) && sched.nmspinning.Load()+sched.npidle.Load() > 0 && pd.syscallwhen+10*1000*1000 > now {
5729 // Drop allpLock so we can take sched.lock.
5731 // Need to decrement number of idle locked M's
5732 // (pretending that one more is running) before the CAS.
5733 // Otherwise the M from which we retake can exit the syscall,
5734 // increment nmidle and report deadlock.
5736 if atomic.Cas(&pp.status, s, _Pidle) {
5753 // Tell all goroutines that they have been preempted and they should stop.
5754 // This function is purely best-effort. It can fail to inform a goroutine if a
5755 // processor just started running it.
5756 // No locks need to be held.
5757 // Returns true if preemption request was issued to at least one goroutine.
5758 func preemptall() bool {
5760 for _, pp := range allp {
5761 if pp.status != _Prunning {
5771 // Tell the goroutine running on processor P to stop.
5772 // This function is purely best-effort. It can incorrectly fail to inform the
5773 // goroutine. It can inform the wrong goroutine. Even if it informs the
5774 // correct goroutine, that goroutine might ignore the request if it is
5775 // simultaneously executing newstack.
5776 // No lock needs to be held.
5777 // Returns true if preemption request was issued.
5778 // The actual preemption will happen at some point in the future
5779 // and will be indicated by the gp->status no longer being
5781 func preemptone(pp *p) bool {
5783 if mp == nil || mp == getg().m {
5787 if gp == nil || gp == mp.g0 {
5793 // Every call in a goroutine checks for stack overflow by
5794 // comparing the current stack pointer to gp->stackguard0.
5795 // Setting gp->stackguard0 to StackPreempt folds
5796 // preemption into the normal stack overflow check.
5797 gp.stackguard0 = stackPreempt
5799 // Request an async preemption of this P.
5800 if preemptMSupported && debug.asyncpreemptoff == 0 {
5810 func schedtrace(detailed bool) {
5817 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)
5819 print(" gcwaiting=", sched.gcwaiting.Load(), " nmidlelocked=", sched.nmidlelocked, " stopwait=", sched.stopwait, " sysmonwait=", sched.sysmonwait.Load(), "\n")
5821 // We must be careful while reading data from P's, M's and G's.
5822 // Even if we hold schedlock, most data can be changed concurrently.
5823 // E.g. (p->m ? p->m->id : -1) can crash if p->m changes from non-nil to nil.
5824 for i, pp := range allp {
5826 h := atomic.Load(&pp.runqhead)
5827 t := atomic.Load(&pp.runqtail)
5829 print(" P", i, ": status=", pp.status, " schedtick=", pp.schedtick, " syscalltick=", pp.syscalltick, " m=")
5835 print(" runqsize=", t-h, " gfreecnt=", pp.gFree.n, " timerslen=", len(pp.timers), "\n")
5837 // In non-detailed mode format lengths of per-P run queues as:
5838 // [len1 len2 len3 len4]
5844 if i == len(allp)-1 {
5855 for mp := allm; mp != nil; mp = mp.alllink {
5857 print(" M", mp.id, ": p=")
5869 print(" mallocing=", mp.mallocing, " throwing=", mp.throwing, " preemptoff=", mp.preemptoff, " locks=", mp.locks, " dying=", mp.dying, " spinning=", mp.spinning, " blocked=", mp.blocked, " lockedg=")
5870 if lockedg := mp.lockedg.ptr(); lockedg != nil {
5878 forEachG(func(gp *g) {
5879 print(" G", gp.goid, ": status=", readgstatus(gp), "(", gp.waitreason.String(), ") m=")
5886 if lockedm := gp.lockedm.ptr(); lockedm != nil {
5896 // schedEnableUser enables or disables the scheduling of user
5899 // This does not stop already running user goroutines, so the caller
5900 // should first stop the world when disabling user goroutines.
5901 func schedEnableUser(enable bool) {
5903 if sched.disable.user == !enable {
5907 sched.disable.user = !enable
5909 n := sched.disable.n
5911 globrunqputbatch(&sched.disable.runnable, n)
5913 for ; n != 0 && sched.npidle.Load() != 0; n-- {
5914 startm(nil, false, false)
5921 // schedEnabled reports whether gp should be scheduled. It returns
5922 // false is scheduling of gp is disabled.
5924 // sched.lock must be held.
5925 func schedEnabled(gp *g) bool {
5926 assertLockHeld(&sched.lock)
5928 if sched.disable.user {
5929 return isSystemGoroutine(gp, true)
5934 // Put mp on midle list.
5935 // sched.lock must be held.
5936 // May run during STW, so write barriers are not allowed.
5938 //go:nowritebarrierrec
5940 assertLockHeld(&sched.lock)
5942 mp.schedlink = sched.midle
5948 // Try to get an m from midle list.
5949 // sched.lock must be held.
5950 // May run during STW, so write barriers are not allowed.
5952 //go:nowritebarrierrec
5954 assertLockHeld(&sched.lock)
5956 mp := sched.midle.ptr()
5958 sched.midle = mp.schedlink
5964 // Put gp on the global runnable queue.
5965 // sched.lock must be held.
5966 // May run during STW, so write barriers are not allowed.
5968 //go:nowritebarrierrec
5969 func globrunqput(gp *g) {
5970 assertLockHeld(&sched.lock)
5972 sched.runq.pushBack(gp)
5976 // Put gp at the head of the global runnable queue.
5977 // sched.lock must be held.
5978 // May run during STW, so write barriers are not allowed.
5980 //go:nowritebarrierrec
5981 func globrunqputhead(gp *g) {
5982 assertLockHeld(&sched.lock)
5988 // Put a batch of runnable goroutines on the global runnable queue.
5989 // This clears *batch.
5990 // sched.lock must be held.
5991 // May run during STW, so write barriers are not allowed.
5993 //go:nowritebarrierrec
5994 func globrunqputbatch(batch *gQueue, n int32) {
5995 assertLockHeld(&sched.lock)
5997 sched.runq.pushBackAll(*batch)
6002 // Try get a batch of G's from the global runnable queue.
6003 // sched.lock must be held.
6004 func globrunqget(pp *p, max int32) *g {
6005 assertLockHeld(&sched.lock)
6007 if sched.runqsize == 0 {
6011 n := sched.runqsize/gomaxprocs + 1
6012 if n > sched.runqsize {
6015 if max > 0 && n > max {
6018 if n > int32(len(pp.runq))/2 {
6019 n = int32(len(pp.runq)) / 2
6024 gp := sched.runq.pop()
6027 gp1 := sched.runq.pop()
6028 runqput(pp, gp1, false)
6033 // pMask is an atomic bitstring with one bit per P.
6036 // read returns true if P id's bit is set.
6037 func (p pMask) read(id uint32) bool {
6039 mask := uint32(1) << (id % 32)
6040 return (atomic.Load(&p[word]) & mask) != 0
6043 // set sets P id's bit.
6044 func (p pMask) set(id int32) {
6046 mask := uint32(1) << (id % 32)
6047 atomic.Or(&p[word], mask)
6050 // clear clears P id's bit.
6051 func (p pMask) clear(id int32) {
6053 mask := uint32(1) << (id % 32)
6054 atomic.And(&p[word], ^mask)
6057 // updateTimerPMask clears pp's timer mask if it has no timers on its heap.
6059 // Ideally, the timer mask would be kept immediately consistent on any timer
6060 // operations. Unfortunately, updating a shared global data structure in the
6061 // timer hot path adds too much overhead in applications frequently switching
6062 // between no timers and some timers.
6064 // As a compromise, the timer mask is updated only on pidleget / pidleput. A
6065 // running P (returned by pidleget) may add a timer at any time, so its mask
6066 // must be set. An idle P (passed to pidleput) cannot add new timers while
6067 // idle, so if it has no timers at that time, its mask may be cleared.
6069 // Thus, we get the following effects on timer-stealing in findrunnable:
6071 // - Idle Ps with no timers when they go idle are never checked in findrunnable
6072 // (for work- or timer-stealing; this is the ideal case).
6073 // - Running Ps must always be checked.
6074 // - Idle Ps whose timers are stolen must continue to be checked until they run
6075 // again, even after timer expiration.
6077 // When the P starts running again, the mask should be set, as a timer may be
6078 // added at any time.
6080 // TODO(prattmic): Additional targeted updates may improve the above cases.
6081 // e.g., updating the mask when stealing a timer.
6082 func updateTimerPMask(pp *p) {
6083 if pp.numTimers.Load() > 0 {
6087 // Looks like there are no timers, however another P may transiently
6088 // decrement numTimers when handling a timerModified timer in
6089 // checkTimers. We must take timersLock to serialize with these changes.
6090 lock(&pp.timersLock)
6091 if pp.numTimers.Load() == 0 {
6092 timerpMask.clear(pp.id)
6094 unlock(&pp.timersLock)
6097 // pidleput puts p on the _Pidle list. now must be a relatively recent call
6098 // to nanotime or zero. Returns now or the current time if now was zero.
6100 // This releases ownership of p. Once sched.lock is released it is no longer
6103 // sched.lock must be held.
6105 // May run during STW, so write barriers are not allowed.
6107 //go:nowritebarrierrec
6108 func pidleput(pp *p, now int64) int64 {
6109 assertLockHeld(&sched.lock)
6112 throw("pidleput: P has non-empty run queue")
6117 updateTimerPMask(pp) // clear if there are no timers.
6118 idlepMask.set(pp.id)
6119 pp.link = sched.pidle
6122 if !pp.limiterEvent.start(limiterEventIdle, now) {
6123 throw("must be able to track idle limiter event")
6128 // pidleget tries to get a p from the _Pidle list, acquiring ownership.
6130 // sched.lock must be held.
6132 // May run during STW, so write barriers are not allowed.
6134 //go:nowritebarrierrec
6135 func pidleget(now int64) (*p, int64) {
6136 assertLockHeld(&sched.lock)
6138 pp := sched.pidle.ptr()
6140 // Timer may get added at any time now.
6144 timerpMask.set(pp.id)
6145 idlepMask.clear(pp.id)
6146 sched.pidle = pp.link
6147 sched.npidle.Add(-1)
6148 pp.limiterEvent.stop(limiterEventIdle, now)
6153 // pidlegetSpinning tries to get a p from the _Pidle list, acquiring ownership.
6154 // This is called by spinning Ms (or callers than need a spinning M) that have
6155 // found work. If no P is available, this must synchronized with non-spinning
6156 // Ms that may be preparing to drop their P without discovering this work.
6158 // sched.lock must be held.
6160 // May run during STW, so write barriers are not allowed.
6162 //go:nowritebarrierrec
6163 func pidlegetSpinning(now int64) (*p, int64) {
6164 assertLockHeld(&sched.lock)
6166 pp, now := pidleget(now)
6168 // See "Delicate dance" comment in findrunnable. We found work
6169 // that we cannot take, we must synchronize with non-spinning
6170 // Ms that may be preparing to drop their P.
6171 sched.needspinning.Store(1)
6178 // runqempty reports whether pp has no Gs on its local run queue.
6179 // It never returns true spuriously.
6180 func runqempty(pp *p) bool {
6181 // Defend against a race where 1) pp has G1 in runqnext but runqhead == runqtail,
6182 // 2) runqput on pp kicks G1 to the runq, 3) runqget on pp empties runqnext.
6183 // Simply observing that runqhead == runqtail and then observing that runqnext == nil
6184 // does not mean the queue is empty.
6186 head := atomic.Load(&pp.runqhead)
6187 tail := atomic.Load(&pp.runqtail)
6188 runnext := atomic.Loaduintptr((*uintptr)(unsafe.Pointer(&pp.runnext)))
6189 if tail == atomic.Load(&pp.runqtail) {
6190 return head == tail && runnext == 0
6195 // To shake out latent assumptions about scheduling order,
6196 // we introduce some randomness into scheduling decisions
6197 // when running with the race detector.
6198 // The need for this was made obvious by changing the
6199 // (deterministic) scheduling order in Go 1.5 and breaking
6200 // many poorly-written tests.
6201 // With the randomness here, as long as the tests pass
6202 // consistently with -race, they shouldn't have latent scheduling
6204 const randomizeScheduler = raceenabled
6206 // runqput tries to put g on the local runnable queue.
6207 // If next is false, runqput adds g to the tail of the runnable queue.
6208 // If next is true, runqput puts g in the pp.runnext slot.
6209 // If the run queue is full, runnext puts g on the global queue.
6210 // Executed only by the owner P.
6211 func runqput(pp *p, gp *g, next bool) {
6212 if randomizeScheduler && next && fastrandn(2) == 0 {
6218 oldnext := pp.runnext
6219 if !pp.runnext.cas(oldnext, guintptr(unsafe.Pointer(gp))) {
6225 // Kick the old runnext out to the regular run queue.
6230 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with consumers
6232 if t-h < uint32(len(pp.runq)) {
6233 pp.runq[t%uint32(len(pp.runq))].set(gp)
6234 atomic.StoreRel(&pp.runqtail, t+1) // store-release, makes the item available for consumption
6237 if runqputslow(pp, gp, h, t) {
6240 // the queue is not full, now the put above must succeed
6244 // Put g and a batch of work from local runnable queue on global queue.
6245 // Executed only by the owner P.
6246 func runqputslow(pp *p, gp *g, h, t uint32) bool {
6247 var batch [len(pp.runq)/2 + 1]*g
6249 // First, grab a batch from local queue.
6252 if n != uint32(len(pp.runq)/2) {
6253 throw("runqputslow: queue is not full")
6255 for i := uint32(0); i < n; i++ {
6256 batch[i] = pp.runq[(h+i)%uint32(len(pp.runq))].ptr()
6258 if !atomic.CasRel(&pp.runqhead, h, h+n) { // cas-release, commits consume
6263 if randomizeScheduler {
6264 for i := uint32(1); i <= n; i++ {
6265 j := fastrandn(i + 1)
6266 batch[i], batch[j] = batch[j], batch[i]
6270 // Link the goroutines.
6271 for i := uint32(0); i < n; i++ {
6272 batch[i].schedlink.set(batch[i+1])
6275 q.head.set(batch[0])
6276 q.tail.set(batch[n])
6278 // Now put the batch on global queue.
6280 globrunqputbatch(&q, int32(n+1))
6285 // runqputbatch tries to put all the G's on q on the local runnable queue.
6286 // If the queue is full, they are put on the global queue; in that case
6287 // this will temporarily acquire the scheduler lock.
6288 // Executed only by the owner P.
6289 func runqputbatch(pp *p, q *gQueue, qsize int) {
6290 h := atomic.LoadAcq(&pp.runqhead)
6293 for !q.empty() && t-h < uint32(len(pp.runq)) {
6295 pp.runq[t%uint32(len(pp.runq))].set(gp)
6301 if randomizeScheduler {
6302 off := func(o uint32) uint32 {
6303 return (pp.runqtail + o) % uint32(len(pp.runq))
6305 for i := uint32(1); i < n; i++ {
6306 j := fastrandn(i + 1)
6307 pp.runq[off(i)], pp.runq[off(j)] = pp.runq[off(j)], pp.runq[off(i)]
6311 atomic.StoreRel(&pp.runqtail, t)
6314 globrunqputbatch(q, int32(qsize))
6319 // Get g from local runnable queue.
6320 // If inheritTime is true, gp should inherit the remaining time in the
6321 // current time slice. Otherwise, it should start a new time slice.
6322 // Executed only by the owner P.
6323 func runqget(pp *p) (gp *g, inheritTime bool) {
6324 // If there's a runnext, it's the next G to run.
6326 // If the runnext is non-0 and the CAS fails, it could only have been stolen by another P,
6327 // because other Ps can race to set runnext to 0, but only the current P can set it to non-0.
6328 // Hence, there's no need to retry this CAS if it fails.
6329 if next != 0 && pp.runnext.cas(next, 0) {
6330 return next.ptr(), true
6334 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with other consumers
6339 gp := pp.runq[h%uint32(len(pp.runq))].ptr()
6340 if atomic.CasRel(&pp.runqhead, h, h+1) { // cas-release, commits consume
6346 // runqdrain drains the local runnable queue of pp and returns all goroutines in it.
6347 // Executed only by the owner P.
6348 func runqdrain(pp *p) (drainQ gQueue, n uint32) {
6349 oldNext := pp.runnext
6350 if oldNext != 0 && pp.runnext.cas(oldNext, 0) {
6351 drainQ.pushBack(oldNext.ptr())
6356 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with other consumers
6362 if qn > uint32(len(pp.runq)) { // read inconsistent h and t
6366 if !atomic.CasRel(&pp.runqhead, h, h+qn) { // cas-release, commits consume
6370 // We've inverted the order in which it gets G's from the local P's runnable queue
6371 // and then advances the head pointer because we don't want to mess up the statuses of G's
6372 // while runqdrain() and runqsteal() are running in parallel.
6373 // Thus we should advance the head pointer before draining the local P into a gQueue,
6374 // so that we can update any gp.schedlink only after we take the full ownership of G,
6375 // meanwhile, other P's can't access to all G's in local P's runnable queue and steal them.
6376 // See https://groups.google.com/g/golang-dev/c/0pTKxEKhHSc/m/6Q85QjdVBQAJ for more details.
6377 for i := uint32(0); i < qn; i++ {
6378 gp := pp.runq[(h+i)%uint32(len(pp.runq))].ptr()
6385 // Grabs a batch of goroutines from pp's runnable queue into batch.
6386 // Batch is a ring buffer starting at batchHead.
6387 // Returns number of grabbed goroutines.
6388 // Can be executed by any P.
6389 func runqgrab(pp *p, batch *[256]guintptr, batchHead uint32, stealRunNextG bool) uint32 {
6391 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with other consumers
6392 t := atomic.LoadAcq(&pp.runqtail) // load-acquire, synchronize with the producer
6397 // Try to steal from pp.runnext.
6398 if next := pp.runnext; next != 0 {
6399 if pp.status == _Prunning {
6400 // Sleep to ensure that pp isn't about to run the g
6401 // we are about to steal.
6402 // The important use case here is when the g running
6403 // on pp ready()s another g and then almost
6404 // immediately blocks. Instead of stealing runnext
6405 // in this window, back off to give pp a chance to
6406 // schedule runnext. This will avoid thrashing gs
6407 // between different Ps.
6408 // A sync chan send/recv takes ~50ns as of time of
6409 // writing, so 3us gives ~50x overshoot.
6410 if GOOS != "windows" && GOOS != "openbsd" && GOOS != "netbsd" {
6413 // On some platforms system timer granularity is
6414 // 1-15ms, which is way too much for this
6415 // optimization. So just yield.
6419 if !pp.runnext.cas(next, 0) {
6422 batch[batchHead%uint32(len(batch))] = next
6428 if n > uint32(len(pp.runq)/2) { // read inconsistent h and t
6431 for i := uint32(0); i < n; i++ {
6432 g := pp.runq[(h+i)%uint32(len(pp.runq))]
6433 batch[(batchHead+i)%uint32(len(batch))] = g
6435 if atomic.CasRel(&pp.runqhead, h, h+n) { // cas-release, commits consume
6441 // Steal half of elements from local runnable queue of p2
6442 // and put onto local runnable queue of p.
6443 // Returns one of the stolen elements (or nil if failed).
6444 func runqsteal(pp, p2 *p, stealRunNextG bool) *g {
6446 n := runqgrab(p2, &pp.runq, t, stealRunNextG)
6451 gp := pp.runq[(t+n)%uint32(len(pp.runq))].ptr()
6455 h := atomic.LoadAcq(&pp.runqhead) // load-acquire, synchronize with consumers
6456 if t-h+n >= uint32(len(pp.runq)) {
6457 throw("runqsteal: runq overflow")
6459 atomic.StoreRel(&pp.runqtail, t+n) // store-release, makes the item available for consumption
6463 // A gQueue is a dequeue of Gs linked through g.schedlink. A G can only
6464 // be on one gQueue or gList at a time.
6465 type gQueue struct {
6470 // empty reports whether q is empty.
6471 func (q *gQueue) empty() bool {
6475 // push adds gp to the head of q.
6476 func (q *gQueue) push(gp *g) {
6477 gp.schedlink = q.head
6484 // pushBack adds gp to the tail of q.
6485 func (q *gQueue) pushBack(gp *g) {
6488 q.tail.ptr().schedlink.set(gp)
6495 // pushBackAll adds all Gs in q2 to the tail of q. After this q2 must
6497 func (q *gQueue) pushBackAll(q2 gQueue) {
6501 q2.tail.ptr().schedlink = 0
6503 q.tail.ptr().schedlink = q2.head
6510 // pop removes and returns the head of queue q. It returns nil if
6512 func (q *gQueue) pop() *g {
6515 q.head = gp.schedlink
6523 // popList takes all Gs in q and returns them as a gList.
6524 func (q *gQueue) popList() gList {
6525 stack := gList{q.head}
6530 // A gList is a list of Gs linked through g.schedlink. A G can only be
6531 // on one gQueue or gList at a time.
6536 // empty reports whether l is empty.
6537 func (l *gList) empty() bool {
6541 // push adds gp to the head of l.
6542 func (l *gList) push(gp *g) {
6543 gp.schedlink = l.head
6547 // pushAll prepends all Gs in q to l.
6548 func (l *gList) pushAll(q gQueue) {
6550 q.tail.ptr().schedlink = l.head
6555 // pop removes and returns the head of l. If l is empty, it returns nil.
6556 func (l *gList) pop() *g {
6559 l.head = gp.schedlink
6564 //go:linkname setMaxThreads runtime/debug.setMaxThreads
6565 func setMaxThreads(in int) (out int) {
6567 out = int(sched.maxmcount)
6568 if in > 0x7fffffff { // MaxInt32
6569 sched.maxmcount = 0x7fffffff
6571 sched.maxmcount = int32(in)
6579 func procPin() int {
6584 return int(mp.p.ptr().id)
6593 //go:linkname sync_runtime_procPin sync.runtime_procPin
6595 func sync_runtime_procPin() int {
6599 //go:linkname sync_runtime_procUnpin sync.runtime_procUnpin
6601 func sync_runtime_procUnpin() {
6605 //go:linkname sync_atomic_runtime_procPin sync/atomic.runtime_procPin
6607 func sync_atomic_runtime_procPin() int {
6611 //go:linkname sync_atomic_runtime_procUnpin sync/atomic.runtime_procUnpin
6613 func sync_atomic_runtime_procUnpin() {
6617 // Active spinning for sync.Mutex.
6619 //go:linkname sync_runtime_canSpin sync.runtime_canSpin
6621 func sync_runtime_canSpin(i int) bool {
6622 // sync.Mutex is cooperative, so we are conservative with spinning.
6623 // Spin only few times and only if running on a multicore machine and
6624 // GOMAXPROCS>1 and there is at least one other running P and local runq is empty.
6625 // As opposed to runtime mutex we don't do passive spinning here,
6626 // because there can be work on global runq or on other Ps.
6627 if i >= active_spin || ncpu <= 1 || gomaxprocs <= sched.npidle.Load()+sched.nmspinning.Load()+1 {
6630 if p := getg().m.p.ptr(); !runqempty(p) {
6636 //go:linkname sync_runtime_doSpin sync.runtime_doSpin
6638 func sync_runtime_doSpin() {
6639 procyield(active_spin_cnt)
6642 var stealOrder randomOrder
6644 // randomOrder/randomEnum are helper types for randomized work stealing.
6645 // They allow to enumerate all Ps in different pseudo-random orders without repetitions.
6646 // The algorithm is based on the fact that if we have X such that X and GOMAXPROCS
6647 // are coprime, then a sequences of (i + X) % GOMAXPROCS gives the required enumeration.
6648 type randomOrder struct {
6653 type randomEnum struct {
6660 func (ord *randomOrder) reset(count uint32) {
6662 ord.coprimes = ord.coprimes[:0]
6663 for i := uint32(1); i <= count; i++ {
6664 if gcd(i, count) == 1 {
6665 ord.coprimes = append(ord.coprimes, i)
6670 func (ord *randomOrder) start(i uint32) randomEnum {
6674 inc: ord.coprimes[i/ord.count%uint32(len(ord.coprimes))],
6678 func (enum *randomEnum) done() bool {
6679 return enum.i == enum.count
6682 func (enum *randomEnum) next() {
6684 enum.pos = (enum.pos + enum.inc) % enum.count
6687 func (enum *randomEnum) position() uint32 {
6691 func gcd(a, b uint32) uint32 {
6698 // An initTask represents the set of initializations that need to be done for a package.
6699 // Keep in sync with ../../test/noinit.go:initTask
6700 type initTask struct {
6701 state uint32 // 0 = uninitialized, 1 = in progress, 2 = done
6703 // followed by nfns pcs, uintptr sized, one per init function to run
6706 // inittrace stores statistics for init functions which are
6707 // updated by malloc and newproc when active is true.
6708 var inittrace tracestat
6710 type tracestat struct {
6711 active bool // init tracing activation status
6712 id uint64 // init goroutine id
6713 allocs uint64 // heap allocations
6714 bytes uint64 // heap allocated bytes
6717 func doInit(ts []*initTask) {
6718 for _, t := range ts {
6723 func doInit1(t *initTask) {
6725 case 2: // fully initialized
6727 case 1: // initialization in progress
6728 throw("recursive call during initialization - linker skew")
6729 default: // not initialized yet
6730 t.state = 1 // initialization in progress
6737 if inittrace.active {
6739 // Load stats non-atomically since tracinit is updated only by this init goroutine.
6744 // We should have pruned all of these in the linker.
6745 throw("inittask with no functions")
6748 firstFunc := add(unsafe.Pointer(t), 8)
6749 for i := uint32(0); i < t.nfns; i++ {
6750 p := add(firstFunc, uintptr(i)*goarch.PtrSize)
6751 f := *(*func())(unsafe.Pointer(&p))
6755 if inittrace.active {
6757 // Load stats non-atomically since tracinit is updated only by this init goroutine.
6760 f := *(*func())(unsafe.Pointer(&firstFunc))
6761 pkg := funcpkgpath(findfunc(abi.FuncPCABIInternal(f)))
6764 print("init ", pkg, " @")
6765 print(string(fmtNSAsMS(sbuf[:], uint64(start-runtimeInitTime))), " ms, ")
6766 print(string(fmtNSAsMS(sbuf[:], uint64(end-start))), " ms clock, ")
6767 print(string(itoa(sbuf[:], after.bytes-before.bytes)), " bytes, ")
6768 print(string(itoa(sbuf[:], after.allocs-before.allocs)), " allocs")
6772 t.state = 2 // initialization done