]> Cypherpunks.ru repositories - gostls13.git/blob - src/runtime/mgcmark.go
[dev.fuzz] all: merge master (65f0d24) into dev.fuzz
[gostls13.git] / src / runtime / mgcmark.go
1 // Copyright 2009 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
4
5 // Garbage collector: marking and scanning
6
7 package runtime
8
9 import (
10         "internal/goarch"
11         "runtime/internal/atomic"
12         "runtime/internal/sys"
13         "unsafe"
14 )
15
16 const (
17         fixedRootFinalizers = iota
18         fixedRootFreeGStacks
19         fixedRootCount
20
21         // rootBlockBytes is the number of bytes to scan per data or
22         // BSS root.
23         rootBlockBytes = 256 << 10
24
25         // maxObletBytes is the maximum bytes of an object to scan at
26         // once. Larger objects will be split up into "oblets" of at
27         // most this size. Since we can scan 1–2 MB/ms, 128 KB bounds
28         // scan preemption at ~100 µs.
29         //
30         // This must be > _MaxSmallSize so that the object base is the
31         // span base.
32         maxObletBytes = 128 << 10
33
34         // drainCheckThreshold specifies how many units of work to do
35         // between self-preemption checks in gcDrain. Assuming a scan
36         // rate of 1 MB/ms, this is ~100 µs. Lower values have higher
37         // overhead in the scan loop (the scheduler check may perform
38         // a syscall, so its overhead is nontrivial). Higher values
39         // make the system less responsive to incoming work.
40         drainCheckThreshold = 100000
41
42         // pagesPerSpanRoot indicates how many pages to scan from a span root
43         // at a time. Used by special root marking.
44         //
45         // Higher values improve throughput by increasing locality, but
46         // increase the minimum latency of a marking operation.
47         //
48         // Must be a multiple of the pageInUse bitmap element size and
49         // must also evenly divide pagesPerArena.
50         pagesPerSpanRoot = 512
51 )
52
53 // gcMarkRootPrepare queues root scanning jobs (stacks, globals, and
54 // some miscellany) and initializes scanning-related state.
55 //
56 // The world must be stopped.
57 func gcMarkRootPrepare() {
58         assertWorldStopped()
59
60         // Compute how many data and BSS root blocks there are.
61         nBlocks := func(bytes uintptr) int {
62                 return int(divRoundUp(bytes, rootBlockBytes))
63         }
64
65         work.nDataRoots = 0
66         work.nBSSRoots = 0
67
68         // Scan globals.
69         for _, datap := range activeModules() {
70                 nDataRoots := nBlocks(datap.edata - datap.data)
71                 if nDataRoots > work.nDataRoots {
72                         work.nDataRoots = nDataRoots
73                 }
74         }
75
76         for _, datap := range activeModules() {
77                 nBSSRoots := nBlocks(datap.ebss - datap.bss)
78                 if nBSSRoots > work.nBSSRoots {
79                         work.nBSSRoots = nBSSRoots
80                 }
81         }
82
83         // Scan span roots for finalizer specials.
84         //
85         // We depend on addfinalizer to mark objects that get
86         // finalizers after root marking.
87         //
88         // We're going to scan the whole heap (that was available at the time the
89         // mark phase started, i.e. markArenas) for in-use spans which have specials.
90         //
91         // Break up the work into arenas, and further into chunks.
92         //
93         // Snapshot allArenas as markArenas. This snapshot is safe because allArenas
94         // is append-only.
95         mheap_.markArenas = mheap_.allArenas[:len(mheap_.allArenas):len(mheap_.allArenas)]
96         work.nSpanRoots = len(mheap_.markArenas) * (pagesPerArena / pagesPerSpanRoot)
97
98         // Scan stacks.
99         //
100         // Gs may be created after this point, but it's okay that we
101         // ignore them because they begin life without any roots, so
102         // there's nothing to scan, and any roots they create during
103         // the concurrent phase will be caught by the write barrier.
104         work.nStackRoots = int(atomic.Loaduintptr(&allglen))
105
106         work.markrootNext = 0
107         work.markrootJobs = uint32(fixedRootCount + work.nDataRoots + work.nBSSRoots + work.nSpanRoots + work.nStackRoots)
108
109         // Calculate base indexes of each root type
110         work.baseData = uint32(fixedRootCount)
111         work.baseBSS = work.baseData + uint32(work.nDataRoots)
112         work.baseSpans = work.baseBSS + uint32(work.nBSSRoots)
113         work.baseStacks = work.baseSpans + uint32(work.nSpanRoots)
114         work.baseEnd = work.baseStacks + uint32(work.nStackRoots)
115 }
116
117 // gcMarkRootCheck checks that all roots have been scanned. It is
118 // purely for debugging.
119 func gcMarkRootCheck() {
120         if work.markrootNext < work.markrootJobs {
121                 print(work.markrootNext, " of ", work.markrootJobs, " markroot jobs done\n")
122                 throw("left over markroot jobs")
123         }
124
125         // Check that stacks have been scanned.
126         //
127         // We only check the first nStackRoots Gs that we should have scanned.
128         // Since we don't care about newer Gs (see comment in
129         // gcMarkRootPrepare), no locking is required.
130         i := 0
131         forEachGRace(func(gp *g) {
132                 if i >= work.nStackRoots {
133                         return
134                 }
135
136                 if !gp.gcscandone {
137                         println("gp", gp, "goid", gp.goid,
138                                 "status", readgstatus(gp),
139                                 "gcscandone", gp.gcscandone)
140                         throw("scan missed a g")
141                 }
142
143                 i++
144         })
145 }
146
147 // ptrmask for an allocation containing a single pointer.
148 var oneptrmask = [...]uint8{1}
149
150 // markroot scans the i'th root.
151 //
152 // Preemption must be disabled (because this uses a gcWork).
153 //
154 // nowritebarrier is only advisory here.
155 //
156 //go:nowritebarrier
157 func markroot(gcw *gcWork, i uint32) {
158         // Note: if you add a case here, please also update heapdump.go:dumproots.
159         switch {
160         case work.baseData <= i && i < work.baseBSS:
161                 for _, datap := range activeModules() {
162                         markrootBlock(datap.data, datap.edata-datap.data, datap.gcdatamask.bytedata, gcw, int(i-work.baseData))
163                 }
164
165         case work.baseBSS <= i && i < work.baseSpans:
166                 for _, datap := range activeModules() {
167                         markrootBlock(datap.bss, datap.ebss-datap.bss, datap.gcbssmask.bytedata, gcw, int(i-work.baseBSS))
168                 }
169
170         case i == fixedRootFinalizers:
171                 for fb := allfin; fb != nil; fb = fb.alllink {
172                         cnt := uintptr(atomic.Load(&fb.cnt))
173                         scanblock(uintptr(unsafe.Pointer(&fb.fin[0])), cnt*unsafe.Sizeof(fb.fin[0]), &finptrmask[0], gcw, nil)
174                 }
175
176         case i == fixedRootFreeGStacks:
177                 // Switch to the system stack so we can call
178                 // stackfree.
179                 systemstack(markrootFreeGStacks)
180
181         case work.baseSpans <= i && i < work.baseStacks:
182                 // mark mspan.specials
183                 markrootSpans(gcw, int(i-work.baseSpans))
184
185         default:
186                 // the rest is scanning goroutine stacks
187                 var gp *g
188                 if work.baseStacks <= i && i < work.baseEnd {
189                         // N.B. Atomic read of allglen in gcMarkRootPrepare
190                         // acts as a barrier to ensure that allgs must be large
191                         // enough to contain all relevant Gs.
192                         gp = allgs[i-work.baseStacks]
193                 } else {
194                         throw("markroot: bad index")
195                 }
196
197                 // remember when we've first observed the G blocked
198                 // needed only to output in traceback
199                 status := readgstatus(gp) // We are not in a scan state
200                 if (status == _Gwaiting || status == _Gsyscall) && gp.waitsince == 0 {
201                         gp.waitsince = work.tstart
202                 }
203
204                 // scanstack must be done on the system stack in case
205                 // we're trying to scan our own stack.
206                 systemstack(func() {
207                         // If this is a self-scan, put the user G in
208                         // _Gwaiting to prevent self-deadlock. It may
209                         // already be in _Gwaiting if this is a mark
210                         // worker or we're in mark termination.
211                         userG := getg().m.curg
212                         selfScan := gp == userG && readgstatus(userG) == _Grunning
213                         if selfScan {
214                                 casgstatus(userG, _Grunning, _Gwaiting)
215                                 userG.waitreason = waitReasonGarbageCollectionScan
216                         }
217
218                         // TODO: suspendG blocks (and spins) until gp
219                         // stops, which may take a while for
220                         // running goroutines. Consider doing this in
221                         // two phases where the first is non-blocking:
222                         // we scan the stacks we can and ask running
223                         // goroutines to scan themselves; and the
224                         // second blocks.
225                         stopped := suspendG(gp)
226                         if stopped.dead {
227                                 gp.gcscandone = true
228                                 return
229                         }
230                         if gp.gcscandone {
231                                 throw("g already scanned")
232                         }
233                         scanstack(gp, gcw)
234                         gp.gcscandone = true
235                         resumeG(stopped)
236
237                         if selfScan {
238                                 casgstatus(userG, _Gwaiting, _Grunning)
239                         }
240                 })
241         }
242 }
243
244 // markrootBlock scans the shard'th shard of the block of memory [b0,
245 // b0+n0), with the given pointer mask.
246 //
247 //go:nowritebarrier
248 func markrootBlock(b0, n0 uintptr, ptrmask0 *uint8, gcw *gcWork, shard int) {
249         if rootBlockBytes%(8*goarch.PtrSize) != 0 {
250                 // This is necessary to pick byte offsets in ptrmask0.
251                 throw("rootBlockBytes must be a multiple of 8*ptrSize")
252         }
253
254         // Note that if b0 is toward the end of the address space,
255         // then b0 + rootBlockBytes might wrap around.
256         // These tests are written to avoid any possible overflow.
257         off := uintptr(shard) * rootBlockBytes
258         if off >= n0 {
259                 return
260         }
261         b := b0 + off
262         ptrmask := (*uint8)(add(unsafe.Pointer(ptrmask0), uintptr(shard)*(rootBlockBytes/(8*goarch.PtrSize))))
263         n := uintptr(rootBlockBytes)
264         if off+n > n0 {
265                 n = n0 - off
266         }
267
268         // Scan this shard.
269         scanblock(b, n, ptrmask, gcw, nil)
270 }
271
272 // markrootFreeGStacks frees stacks of dead Gs.
273 //
274 // This does not free stacks of dead Gs cached on Ps, but having a few
275 // cached stacks around isn't a problem.
276 func markrootFreeGStacks() {
277         // Take list of dead Gs with stacks.
278         lock(&sched.gFree.lock)
279         list := sched.gFree.stack
280         sched.gFree.stack = gList{}
281         unlock(&sched.gFree.lock)
282         if list.empty() {
283                 return
284         }
285
286         // Free stacks.
287         q := gQueue{list.head, list.head}
288         for gp := list.head.ptr(); gp != nil; gp = gp.schedlink.ptr() {
289                 stackfree(gp.stack)
290                 gp.stack.lo = 0
291                 gp.stack.hi = 0
292                 // Manipulate the queue directly since the Gs are
293                 // already all linked the right way.
294                 q.tail.set(gp)
295         }
296
297         // Put Gs back on the free list.
298         lock(&sched.gFree.lock)
299         sched.gFree.noStack.pushAll(q)
300         unlock(&sched.gFree.lock)
301 }
302
303 // markrootSpans marks roots for one shard of markArenas.
304 //
305 //go:nowritebarrier
306 func markrootSpans(gcw *gcWork, shard int) {
307         // Objects with finalizers have two GC-related invariants:
308         //
309         // 1) Everything reachable from the object must be marked.
310         // This ensures that when we pass the object to its finalizer,
311         // everything the finalizer can reach will be retained.
312         //
313         // 2) Finalizer specials (which are not in the garbage
314         // collected heap) are roots. In practice, this means the fn
315         // field must be scanned.
316         sg := mheap_.sweepgen
317
318         // Find the arena and page index into that arena for this shard.
319         ai := mheap_.markArenas[shard/(pagesPerArena/pagesPerSpanRoot)]
320         ha := mheap_.arenas[ai.l1()][ai.l2()]
321         arenaPage := uint(uintptr(shard) * pagesPerSpanRoot % pagesPerArena)
322
323         // Construct slice of bitmap which we'll iterate over.
324         specialsbits := ha.pageSpecials[arenaPage/8:]
325         specialsbits = specialsbits[:pagesPerSpanRoot/8]
326         for i := range specialsbits {
327                 // Find set bits, which correspond to spans with specials.
328                 specials := atomic.Load8(&specialsbits[i])
329                 if specials == 0 {
330                         continue
331                 }
332                 for j := uint(0); j < 8; j++ {
333                         if specials&(1<<j) == 0 {
334                                 continue
335                         }
336                         // Find the span for this bit.
337                         //
338                         // This value is guaranteed to be non-nil because having
339                         // specials implies that the span is in-use, and since we're
340                         // currently marking we can be sure that we don't have to worry
341                         // about the span being freed and re-used.
342                         s := ha.spans[arenaPage+uint(i)*8+j]
343
344                         // The state must be mSpanInUse if the specials bit is set, so
345                         // sanity check that.
346                         if state := s.state.get(); state != mSpanInUse {
347                                 print("s.state = ", state, "\n")
348                                 throw("non in-use span found with specials bit set")
349                         }
350                         // Check that this span was swept (it may be cached or uncached).
351                         if !useCheckmark && !(s.sweepgen == sg || s.sweepgen == sg+3) {
352                                 // sweepgen was updated (+2) during non-checkmark GC pass
353                                 print("sweep ", s.sweepgen, " ", sg, "\n")
354                                 throw("gc: unswept span")
355                         }
356
357                         // Lock the specials to prevent a special from being
358                         // removed from the list while we're traversing it.
359                         lock(&s.speciallock)
360                         for sp := s.specials; sp != nil; sp = sp.next {
361                                 if sp.kind != _KindSpecialFinalizer {
362                                         continue
363                                 }
364                                 // don't mark finalized object, but scan it so we
365                                 // retain everything it points to.
366                                 spf := (*specialfinalizer)(unsafe.Pointer(sp))
367                                 // A finalizer can be set for an inner byte of an object, find object beginning.
368                                 p := s.base() + uintptr(spf.special.offset)/s.elemsize*s.elemsize
369
370                                 // Mark everything that can be reached from
371                                 // the object (but *not* the object itself or
372                                 // we'll never collect it).
373                                 scanobject(p, gcw)
374
375                                 // The special itself is a root.
376                                 scanblock(uintptr(unsafe.Pointer(&spf.fn)), goarch.PtrSize, &oneptrmask[0], gcw, nil)
377                         }
378                         unlock(&s.speciallock)
379                 }
380         }
381 }
382
383 // gcAssistAlloc performs GC work to make gp's assist debt positive.
384 // gp must be the calling user gorountine.
385 //
386 // This must be called with preemption enabled.
387 func gcAssistAlloc(gp *g) {
388         // Don't assist in non-preemptible contexts. These are
389         // generally fragile and won't allow the assist to block.
390         if getg() == gp.m.g0 {
391                 return
392         }
393         if mp := getg().m; mp.locks > 0 || mp.preemptoff != "" {
394                 return
395         }
396
397         traced := false
398 retry:
399         // Compute the amount of scan work we need to do to make the
400         // balance positive. When the required amount of work is low,
401         // we over-assist to build up credit for future allocations
402         // and amortize the cost of assisting.
403         assistWorkPerByte := float64frombits(atomic.Load64(&gcController.assistWorkPerByte))
404         assistBytesPerWork := float64frombits(atomic.Load64(&gcController.assistBytesPerWork))
405         debtBytes := -gp.gcAssistBytes
406         scanWork := int64(assistWorkPerByte * float64(debtBytes))
407         if scanWork < gcOverAssistWork {
408                 scanWork = gcOverAssistWork
409                 debtBytes = int64(assistBytesPerWork * float64(scanWork))
410         }
411
412         // Steal as much credit as we can from the background GC's
413         // scan credit. This is racy and may drop the background
414         // credit below 0 if two mutators steal at the same time. This
415         // will just cause steals to fail until credit is accumulated
416         // again, so in the long run it doesn't really matter, but we
417         // do have to handle the negative credit case.
418         bgScanCredit := atomic.Loadint64(&gcController.bgScanCredit)
419         stolen := int64(0)
420         if bgScanCredit > 0 {
421                 if bgScanCredit < scanWork {
422                         stolen = bgScanCredit
423                         gp.gcAssistBytes += 1 + int64(assistBytesPerWork*float64(stolen))
424                 } else {
425                         stolen = scanWork
426                         gp.gcAssistBytes += debtBytes
427                 }
428                 atomic.Xaddint64(&gcController.bgScanCredit, -stolen)
429
430                 scanWork -= stolen
431
432                 if scanWork == 0 {
433                         // We were able to steal all of the credit we
434                         // needed.
435                         if traced {
436                                 traceGCMarkAssistDone()
437                         }
438                         return
439                 }
440         }
441
442         if trace.enabled && !traced {
443                 traced = true
444                 traceGCMarkAssistStart()
445         }
446
447         // Perform assist work
448         systemstack(func() {
449                 gcAssistAlloc1(gp, scanWork)
450                 // The user stack may have moved, so this can't touch
451                 // anything on it until it returns from systemstack.
452         })
453
454         completed := gp.param != nil
455         gp.param = nil
456         if completed {
457                 gcMarkDone()
458         }
459
460         if gp.gcAssistBytes < 0 {
461                 // We were unable steal enough credit or perform
462                 // enough work to pay off the assist debt. We need to
463                 // do one of these before letting the mutator allocate
464                 // more to prevent over-allocation.
465                 //
466                 // If this is because we were preempted, reschedule
467                 // and try some more.
468                 if gp.preempt {
469                         Gosched()
470                         goto retry
471                 }
472
473                 // Add this G to an assist queue and park. When the GC
474                 // has more background credit, it will satisfy queued
475                 // assists before flushing to the global credit pool.
476                 //
477                 // Note that this does *not* get woken up when more
478                 // work is added to the work list. The theory is that
479                 // there wasn't enough work to do anyway, so we might
480                 // as well let background marking take care of the
481                 // work that is available.
482                 if !gcParkAssist() {
483                         goto retry
484                 }
485
486                 // At this point either background GC has satisfied
487                 // this G's assist debt, or the GC cycle is over.
488         }
489         if traced {
490                 traceGCMarkAssistDone()
491         }
492 }
493
494 // gcAssistAlloc1 is the part of gcAssistAlloc that runs on the system
495 // stack. This is a separate function to make it easier to see that
496 // we're not capturing anything from the user stack, since the user
497 // stack may move while we're in this function.
498 //
499 // gcAssistAlloc1 indicates whether this assist completed the mark
500 // phase by setting gp.param to non-nil. This can't be communicated on
501 // the stack since it may move.
502 //
503 //go:systemstack
504 func gcAssistAlloc1(gp *g, scanWork int64) {
505         // Clear the flag indicating that this assist completed the
506         // mark phase.
507         gp.param = nil
508
509         if atomic.Load(&gcBlackenEnabled) == 0 {
510                 // The gcBlackenEnabled check in malloc races with the
511                 // store that clears it but an atomic check in every malloc
512                 // would be a performance hit.
513                 // Instead we recheck it here on the non-preemptable system
514                 // stack to determine if we should perform an assist.
515
516                 // GC is done, so ignore any remaining debt.
517                 gp.gcAssistBytes = 0
518                 return
519         }
520         // Track time spent in this assist. Since we're on the
521         // system stack, this is non-preemptible, so we can
522         // just measure start and end time.
523         startTime := nanotime()
524
525         decnwait := atomic.Xadd(&work.nwait, -1)
526         if decnwait == work.nproc {
527                 println("runtime: work.nwait =", decnwait, "work.nproc=", work.nproc)
528                 throw("nwait > work.nprocs")
529         }
530
531         // gcDrainN requires the caller to be preemptible.
532         casgstatus(gp, _Grunning, _Gwaiting)
533         gp.waitreason = waitReasonGCAssistMarking
534
535         // drain own cached work first in the hopes that it
536         // will be more cache friendly.
537         gcw := &getg().m.p.ptr().gcw
538         workDone := gcDrainN(gcw, scanWork)
539
540         casgstatus(gp, _Gwaiting, _Grunning)
541
542         // Record that we did this much scan work.
543         //
544         // Back out the number of bytes of assist credit that
545         // this scan work counts for. The "1+" is a poor man's
546         // round-up, to ensure this adds credit even if
547         // assistBytesPerWork is very low.
548         assistBytesPerWork := float64frombits(atomic.Load64(&gcController.assistBytesPerWork))
549         gp.gcAssistBytes += 1 + int64(assistBytesPerWork*float64(workDone))
550
551         // If this is the last worker and we ran out of work,
552         // signal a completion point.
553         incnwait := atomic.Xadd(&work.nwait, +1)
554         if incnwait > work.nproc {
555                 println("runtime: work.nwait=", incnwait,
556                         "work.nproc=", work.nproc)
557                 throw("work.nwait > work.nproc")
558         }
559
560         if incnwait == work.nproc && !gcMarkWorkAvailable(nil) {
561                 // This has reached a background completion point. Set
562                 // gp.param to a non-nil value to indicate this. It
563                 // doesn't matter what we set it to (it just has to be
564                 // a valid pointer).
565                 gp.param = unsafe.Pointer(gp)
566         }
567         duration := nanotime() - startTime
568         _p_ := gp.m.p.ptr()
569         _p_.gcAssistTime += duration
570         if _p_.gcAssistTime > gcAssistTimeSlack {
571                 atomic.Xaddint64(&gcController.assistTime, _p_.gcAssistTime)
572                 _p_.gcAssistTime = 0
573         }
574 }
575
576 // gcWakeAllAssists wakes all currently blocked assists. This is used
577 // at the end of a GC cycle. gcBlackenEnabled must be false to prevent
578 // new assists from going to sleep after this point.
579 func gcWakeAllAssists() {
580         lock(&work.assistQueue.lock)
581         list := work.assistQueue.q.popList()
582         injectglist(&list)
583         unlock(&work.assistQueue.lock)
584 }
585
586 // gcParkAssist puts the current goroutine on the assist queue and parks.
587 //
588 // gcParkAssist reports whether the assist is now satisfied. If it
589 // returns false, the caller must retry the assist.
590 //
591 //go:nowritebarrier
592 func gcParkAssist() bool {
593         lock(&work.assistQueue.lock)
594         // If the GC cycle finished while we were getting the lock,
595         // exit the assist. The cycle can't finish while we hold the
596         // lock.
597         if atomic.Load(&gcBlackenEnabled) == 0 {
598                 unlock(&work.assistQueue.lock)
599                 return true
600         }
601
602         gp := getg()
603         oldList := work.assistQueue.q
604         work.assistQueue.q.pushBack(gp)
605
606         // Recheck for background credit now that this G is in
607         // the queue, but can still back out. This avoids a
608         // race in case background marking has flushed more
609         // credit since we checked above.
610         if atomic.Loadint64(&gcController.bgScanCredit) > 0 {
611                 work.assistQueue.q = oldList
612                 if oldList.tail != 0 {
613                         oldList.tail.ptr().schedlink.set(nil)
614                 }
615                 unlock(&work.assistQueue.lock)
616                 return false
617         }
618         // Park.
619         goparkunlock(&work.assistQueue.lock, waitReasonGCAssistWait, traceEvGoBlockGC, 2)
620         return true
621 }
622
623 // gcFlushBgCredit flushes scanWork units of background scan work
624 // credit. This first satisfies blocked assists on the
625 // work.assistQueue and then flushes any remaining credit to
626 // gcController.bgScanCredit.
627 //
628 // Write barriers are disallowed because this is used by gcDrain after
629 // it has ensured that all work is drained and this must preserve that
630 // condition.
631 //
632 //go:nowritebarrierrec
633 func gcFlushBgCredit(scanWork int64) {
634         if work.assistQueue.q.empty() {
635                 // Fast path; there are no blocked assists. There's a
636                 // small window here where an assist may add itself to
637                 // the blocked queue and park. If that happens, we'll
638                 // just get it on the next flush.
639                 atomic.Xaddint64(&gcController.bgScanCredit, scanWork)
640                 return
641         }
642
643         assistBytesPerWork := float64frombits(atomic.Load64(&gcController.assistBytesPerWork))
644         scanBytes := int64(float64(scanWork) * assistBytesPerWork)
645
646         lock(&work.assistQueue.lock)
647         for !work.assistQueue.q.empty() && scanBytes > 0 {
648                 gp := work.assistQueue.q.pop()
649                 // Note that gp.gcAssistBytes is negative because gp
650                 // is in debt. Think carefully about the signs below.
651                 if scanBytes+gp.gcAssistBytes >= 0 {
652                         // Satisfy this entire assist debt.
653                         scanBytes += gp.gcAssistBytes
654                         gp.gcAssistBytes = 0
655                         // It's important that we *not* put gp in
656                         // runnext. Otherwise, it's possible for user
657                         // code to exploit the GC worker's high
658                         // scheduler priority to get itself always run
659                         // before other goroutines and always in the
660                         // fresh quantum started by GC.
661                         ready(gp, 0, false)
662                 } else {
663                         // Partially satisfy this assist.
664                         gp.gcAssistBytes += scanBytes
665                         scanBytes = 0
666                         // As a heuristic, we move this assist to the
667                         // back of the queue so that large assists
668                         // can't clog up the assist queue and
669                         // substantially delay small assists.
670                         work.assistQueue.q.pushBack(gp)
671                         break
672                 }
673         }
674
675         if scanBytes > 0 {
676                 // Convert from scan bytes back to work.
677                 assistWorkPerByte := float64frombits(atomic.Load64(&gcController.assistWorkPerByte))
678                 scanWork = int64(float64(scanBytes) * assistWorkPerByte)
679                 atomic.Xaddint64(&gcController.bgScanCredit, scanWork)
680         }
681         unlock(&work.assistQueue.lock)
682 }
683
684 // scanstack scans gp's stack, greying all pointers found on the stack.
685 //
686 // scanstack will also shrink the stack if it is safe to do so. If it
687 // is not, it schedules a stack shrink for the next synchronous safe
688 // point.
689 //
690 // scanstack is marked go:systemstack because it must not be preempted
691 // while using a workbuf.
692 //
693 //go:nowritebarrier
694 //go:systemstack
695 func scanstack(gp *g, gcw *gcWork) {
696         if readgstatus(gp)&_Gscan == 0 {
697                 print("runtime:scanstack: gp=", gp, ", goid=", gp.goid, ", gp->atomicstatus=", hex(readgstatus(gp)), "\n")
698                 throw("scanstack - bad status")
699         }
700
701         switch readgstatus(gp) &^ _Gscan {
702         default:
703                 print("runtime: gp=", gp, ", goid=", gp.goid, ", gp->atomicstatus=", readgstatus(gp), "\n")
704                 throw("mark - bad status")
705         case _Gdead:
706                 return
707         case _Grunning:
708                 print("runtime: gp=", gp, ", goid=", gp.goid, ", gp->atomicstatus=", readgstatus(gp), "\n")
709                 throw("scanstack: goroutine not stopped")
710         case _Grunnable, _Gsyscall, _Gwaiting:
711                 // ok
712         }
713
714         if gp == getg() {
715                 throw("can't scan our own stack")
716         }
717
718         if isShrinkStackSafe(gp) {
719                 // Shrink the stack if not much of it is being used.
720                 shrinkstack(gp)
721         } else {
722                 // Otherwise, shrink the stack at the next sync safe point.
723                 gp.preemptShrink = true
724         }
725
726         var state stackScanState
727         state.stack = gp.stack
728
729         if stackTraceDebug {
730                 println("stack trace goroutine", gp.goid)
731         }
732
733         if debugScanConservative && gp.asyncSafePoint {
734                 print("scanning async preempted goroutine ", gp.goid, " stack [", hex(gp.stack.lo), ",", hex(gp.stack.hi), ")\n")
735         }
736
737         // Scan the saved context register. This is effectively a live
738         // register that gets moved back and forth between the
739         // register and sched.ctxt without a write barrier.
740         if gp.sched.ctxt != nil {
741                 scanblock(uintptr(unsafe.Pointer(&gp.sched.ctxt)), goarch.PtrSize, &oneptrmask[0], gcw, &state)
742         }
743
744         // Scan the stack. Accumulate a list of stack objects.
745         scanframe := func(frame *stkframe, unused unsafe.Pointer) bool {
746                 scanframeworker(frame, &state, gcw)
747                 return true
748         }
749         gentraceback(^uintptr(0), ^uintptr(0), 0, gp, 0, nil, 0x7fffffff, scanframe, nil, 0)
750
751         // Find additional pointers that point into the stack from the heap.
752         // Currently this includes defers and panics. See also function copystack.
753
754         // Find and trace other pointers in defer records.
755         for d := gp._defer; d != nil; d = d.link {
756                 if d.fn != nil {
757                         // Scan the func value, which could be a stack allocated closure.
758                         // See issue 30453.
759                         scanblock(uintptr(unsafe.Pointer(&d.fn)), goarch.PtrSize, &oneptrmask[0], gcw, &state)
760                 }
761                 if d.link != nil {
762                         // The link field of a stack-allocated defer record might point
763                         // to a heap-allocated defer record. Keep that heap record live.
764                         scanblock(uintptr(unsafe.Pointer(&d.link)), goarch.PtrSize, &oneptrmask[0], gcw, &state)
765                 }
766                 // Retain defers records themselves.
767                 // Defer records might not be reachable from the G through regular heap
768                 // tracing because the defer linked list might weave between the stack and the heap.
769                 if d.heap {
770                         scanblock(uintptr(unsafe.Pointer(&d)), goarch.PtrSize, &oneptrmask[0], gcw, &state)
771                 }
772         }
773         if gp._panic != nil {
774                 // Panics are always stack allocated.
775                 state.putPtr(uintptr(unsafe.Pointer(gp._panic)), false)
776         }
777
778         // Find and scan all reachable stack objects.
779         //
780         // The state's pointer queue prioritizes precise pointers over
781         // conservative pointers so that we'll prefer scanning stack
782         // objects precisely.
783         state.buildIndex()
784         for {
785                 p, conservative := state.getPtr()
786                 if p == 0 {
787                         break
788                 }
789                 obj := state.findObject(p)
790                 if obj == nil {
791                         continue
792                 }
793                 r := obj.r
794                 if r == nil {
795                         // We've already scanned this object.
796                         continue
797                 }
798                 obj.setRecord(nil) // Don't scan it again.
799                 if stackTraceDebug {
800                         printlock()
801                         print("  live stkobj at", hex(state.stack.lo+uintptr(obj.off)), "of size", obj.size)
802                         if conservative {
803                                 print(" (conservative)")
804                         }
805                         println()
806                         printunlock()
807                 }
808                 gcdata := r.gcdata
809                 var s *mspan
810                 if r.useGCProg() {
811                         // This path is pretty unlikely, an object large enough
812                         // to have a GC program allocated on the stack.
813                         // We need some space to unpack the program into a straight
814                         // bitmask, which we allocate/free here.
815                         // TODO: it would be nice if there were a way to run a GC
816                         // program without having to store all its bits. We'd have
817                         // to change from a Lempel-Ziv style program to something else.
818                         // Or we can forbid putting objects on stacks if they require
819                         // a gc program (see issue 27447).
820                         s = materializeGCProg(r.ptrdata(), gcdata)
821                         gcdata = (*byte)(unsafe.Pointer(s.startAddr))
822                 }
823
824                 b := state.stack.lo + uintptr(obj.off)
825                 if conservative {
826                         scanConservative(b, r.ptrdata(), gcdata, gcw, &state)
827                 } else {
828                         scanblock(b, r.ptrdata(), gcdata, gcw, &state)
829                 }
830
831                 if s != nil {
832                         dematerializeGCProg(s)
833                 }
834         }
835
836         // Deallocate object buffers.
837         // (Pointer buffers were all deallocated in the loop above.)
838         for state.head != nil {
839                 x := state.head
840                 state.head = x.next
841                 if stackTraceDebug {
842                         for i := 0; i < x.nobj; i++ {
843                                 obj := &x.obj[i]
844                                 if obj.r == nil { // reachable
845                                         continue
846                                 }
847                                 println("  dead stkobj at", hex(gp.stack.lo+uintptr(obj.off)), "of size", obj.r.size)
848                                 // Note: not necessarily really dead - only reachable-from-ptr dead.
849                         }
850                 }
851                 x.nobj = 0
852                 putempty((*workbuf)(unsafe.Pointer(x)))
853         }
854         if state.buf != nil || state.cbuf != nil || state.freeBuf != nil {
855                 throw("remaining pointer buffers")
856         }
857 }
858
859 // Scan a stack frame: local variables and function arguments/results.
860 //go:nowritebarrier
861 func scanframeworker(frame *stkframe, state *stackScanState, gcw *gcWork) {
862         if _DebugGC > 1 && frame.continpc != 0 {
863                 print("scanframe ", funcname(frame.fn), "\n")
864         }
865
866         isAsyncPreempt := frame.fn.valid() && frame.fn.funcID == funcID_asyncPreempt
867         isDebugCall := frame.fn.valid() && frame.fn.funcID == funcID_debugCallV2
868         if state.conservative || isAsyncPreempt || isDebugCall {
869                 if debugScanConservative {
870                         println("conservatively scanning function", funcname(frame.fn), "at PC", hex(frame.continpc))
871                 }
872
873                 // Conservatively scan the frame. Unlike the precise
874                 // case, this includes the outgoing argument space
875                 // since we may have stopped while this function was
876                 // setting up a call.
877                 //
878                 // TODO: We could narrow this down if the compiler
879                 // produced a single map per function of stack slots
880                 // and registers that ever contain a pointer.
881                 if frame.varp != 0 {
882                         size := frame.varp - frame.sp
883                         if size > 0 {
884                                 scanConservative(frame.sp, size, nil, gcw, state)
885                         }
886                 }
887
888                 // Scan arguments to this frame.
889                 if frame.arglen != 0 {
890                         // TODO: We could pass the entry argument map
891                         // to narrow this down further.
892                         scanConservative(frame.argp, frame.arglen, nil, gcw, state)
893                 }
894
895                 if isAsyncPreempt || isDebugCall {
896                         // This function's frame contained the
897                         // registers for the asynchronously stopped
898                         // parent frame. Scan the parent
899                         // conservatively.
900                         state.conservative = true
901                 } else {
902                         // We only wanted to scan those two frames
903                         // conservatively. Clear the flag for future
904                         // frames.
905                         state.conservative = false
906                 }
907                 return
908         }
909
910         locals, args, objs := getStackMap(frame, &state.cache, false)
911
912         // Scan local variables if stack frame has been allocated.
913         if locals.n > 0 {
914                 size := uintptr(locals.n) * goarch.PtrSize
915                 scanblock(frame.varp-size, size, locals.bytedata, gcw, state)
916         }
917
918         // Scan arguments.
919         if args.n > 0 {
920                 scanblock(frame.argp, uintptr(args.n)*goarch.PtrSize, args.bytedata, gcw, state)
921         }
922
923         // Add all stack objects to the stack object list.
924         if frame.varp != 0 {
925                 // varp is 0 for defers, where there are no locals.
926                 // In that case, there can't be a pointer to its args, either.
927                 // (And all args would be scanned above anyway.)
928                 for i, obj := range objs {
929                         off := obj.off
930                         base := frame.varp // locals base pointer
931                         if off >= 0 {
932                                 base = frame.argp // arguments and return values base pointer
933                         }
934                         ptr := base + uintptr(off)
935                         if ptr < frame.sp {
936                                 // object hasn't been allocated in the frame yet.
937                                 continue
938                         }
939                         if stackTraceDebug {
940                                 println("stkobj at", hex(ptr), "of size", obj.size)
941                         }
942                         state.addObject(ptr, &objs[i])
943                 }
944         }
945 }
946
947 type gcDrainFlags int
948
949 const (
950         gcDrainUntilPreempt gcDrainFlags = 1 << iota
951         gcDrainFlushBgCredit
952         gcDrainIdle
953         gcDrainFractional
954 )
955
956 // gcDrain scans roots and objects in work buffers, blackening grey
957 // objects until it is unable to get more work. It may return before
958 // GC is done; it's the caller's responsibility to balance work from
959 // other Ps.
960 //
961 // If flags&gcDrainUntilPreempt != 0, gcDrain returns when g.preempt
962 // is set.
963 //
964 // If flags&gcDrainIdle != 0, gcDrain returns when there is other work
965 // to do.
966 //
967 // If flags&gcDrainFractional != 0, gcDrain self-preempts when
968 // pollFractionalWorkerExit() returns true. This implies
969 // gcDrainNoBlock.
970 //
971 // If flags&gcDrainFlushBgCredit != 0, gcDrain flushes scan work
972 // credit to gcController.bgScanCredit every gcCreditSlack units of
973 // scan work.
974 //
975 // gcDrain will always return if there is a pending STW.
976 //
977 //go:nowritebarrier
978 func gcDrain(gcw *gcWork, flags gcDrainFlags) {
979         if !writeBarrier.needed {
980                 throw("gcDrain phase incorrect")
981         }
982
983         gp := getg().m.curg
984         preemptible := flags&gcDrainUntilPreempt != 0
985         flushBgCredit := flags&gcDrainFlushBgCredit != 0
986         idle := flags&gcDrainIdle != 0
987
988         initScanWork := gcw.scanWork
989
990         // checkWork is the scan work before performing the next
991         // self-preempt check.
992         checkWork := int64(1<<63 - 1)
993         var check func() bool
994         if flags&(gcDrainIdle|gcDrainFractional) != 0 {
995                 checkWork = initScanWork + drainCheckThreshold
996                 if idle {
997                         check = pollWork
998                 } else if flags&gcDrainFractional != 0 {
999                         check = pollFractionalWorkerExit
1000                 }
1001         }
1002
1003         // Drain root marking jobs.
1004         if work.markrootNext < work.markrootJobs {
1005                 // Stop if we're preemptible or if someone wants to STW.
1006                 for !(gp.preempt && (preemptible || atomic.Load(&sched.gcwaiting) != 0)) {
1007                         job := atomic.Xadd(&work.markrootNext, +1) - 1
1008                         if job >= work.markrootJobs {
1009                                 break
1010                         }
1011                         markroot(gcw, job)
1012                         if check != nil && check() {
1013                                 goto done
1014                         }
1015                 }
1016         }
1017
1018         // Drain heap marking jobs.
1019         // Stop if we're preemptible or if someone wants to STW.
1020         for !(gp.preempt && (preemptible || atomic.Load(&sched.gcwaiting) != 0)) {
1021                 // Try to keep work available on the global queue. We used to
1022                 // check if there were waiting workers, but it's better to
1023                 // just keep work available than to make workers wait. In the
1024                 // worst case, we'll do O(log(_WorkbufSize)) unnecessary
1025                 // balances.
1026                 if work.full == 0 {
1027                         gcw.balance()
1028                 }
1029
1030                 b := gcw.tryGetFast()
1031                 if b == 0 {
1032                         b = gcw.tryGet()
1033                         if b == 0 {
1034                                 // Flush the write barrier
1035                                 // buffer; this may create
1036                                 // more work.
1037                                 wbBufFlush(nil, 0)
1038                                 b = gcw.tryGet()
1039                         }
1040                 }
1041                 if b == 0 {
1042                         // Unable to get work.
1043                         break
1044                 }
1045                 scanobject(b, gcw)
1046
1047                 // Flush background scan work credit to the global
1048                 // account if we've accumulated enough locally so
1049                 // mutator assists can draw on it.
1050                 if gcw.scanWork >= gcCreditSlack {
1051                         atomic.Xaddint64(&gcController.scanWork, gcw.scanWork)
1052                         if flushBgCredit {
1053                                 gcFlushBgCredit(gcw.scanWork - initScanWork)
1054                                 initScanWork = 0
1055                         }
1056                         checkWork -= gcw.scanWork
1057                         gcw.scanWork = 0
1058
1059                         if checkWork <= 0 {
1060                                 checkWork += drainCheckThreshold
1061                                 if check != nil && check() {
1062                                         break
1063                                 }
1064                         }
1065                 }
1066         }
1067
1068 done:
1069         // Flush remaining scan work credit.
1070         if gcw.scanWork > 0 {
1071                 atomic.Xaddint64(&gcController.scanWork, gcw.scanWork)
1072                 if flushBgCredit {
1073                         gcFlushBgCredit(gcw.scanWork - initScanWork)
1074                 }
1075                 gcw.scanWork = 0
1076         }
1077 }
1078
1079 // gcDrainN blackens grey objects until it has performed roughly
1080 // scanWork units of scan work or the G is preempted. This is
1081 // best-effort, so it may perform less work if it fails to get a work
1082 // buffer. Otherwise, it will perform at least n units of work, but
1083 // may perform more because scanning is always done in whole object
1084 // increments. It returns the amount of scan work performed.
1085 //
1086 // The caller goroutine must be in a preemptible state (e.g.,
1087 // _Gwaiting) to prevent deadlocks during stack scanning. As a
1088 // consequence, this must be called on the system stack.
1089 //
1090 //go:nowritebarrier
1091 //go:systemstack
1092 func gcDrainN(gcw *gcWork, scanWork int64) int64 {
1093         if !writeBarrier.needed {
1094                 throw("gcDrainN phase incorrect")
1095         }
1096
1097         // There may already be scan work on the gcw, which we don't
1098         // want to claim was done by this call.
1099         workFlushed := -gcw.scanWork
1100
1101         gp := getg().m.curg
1102         for !gp.preempt && workFlushed+gcw.scanWork < scanWork {
1103                 // See gcDrain comment.
1104                 if work.full == 0 {
1105                         gcw.balance()
1106                 }
1107
1108                 b := gcw.tryGetFast()
1109                 if b == 0 {
1110                         b = gcw.tryGet()
1111                         if b == 0 {
1112                                 // Flush the write barrier buffer;
1113                                 // this may create more work.
1114                                 wbBufFlush(nil, 0)
1115                                 b = gcw.tryGet()
1116                         }
1117                 }
1118
1119                 if b == 0 {
1120                         // Try to do a root job.
1121                         //
1122                         // TODO: Assists should get credit for this
1123                         // work.
1124                         if work.markrootNext < work.markrootJobs {
1125                                 job := atomic.Xadd(&work.markrootNext, +1) - 1
1126                                 if job < work.markrootJobs {
1127                                         markroot(gcw, job)
1128                                         continue
1129                                 }
1130                         }
1131                         // No heap or root jobs.
1132                         break
1133                 }
1134
1135                 scanobject(b, gcw)
1136
1137                 // Flush background scan work credit.
1138                 if gcw.scanWork >= gcCreditSlack {
1139                         atomic.Xaddint64(&gcController.scanWork, gcw.scanWork)
1140                         workFlushed += gcw.scanWork
1141                         gcw.scanWork = 0
1142                 }
1143         }
1144
1145         // Unlike gcDrain, there's no need to flush remaining work
1146         // here because this never flushes to bgScanCredit and
1147         // gcw.dispose will flush any remaining work to scanWork.
1148
1149         return workFlushed + gcw.scanWork
1150 }
1151
1152 // scanblock scans b as scanobject would, but using an explicit
1153 // pointer bitmap instead of the heap bitmap.
1154 //
1155 // This is used to scan non-heap roots, so it does not update
1156 // gcw.bytesMarked or gcw.scanWork.
1157 //
1158 // If stk != nil, possible stack pointers are also reported to stk.putPtr.
1159 //go:nowritebarrier
1160 func scanblock(b0, n0 uintptr, ptrmask *uint8, gcw *gcWork, stk *stackScanState) {
1161         // Use local copies of original parameters, so that a stack trace
1162         // due to one of the throws below shows the original block
1163         // base and extent.
1164         b := b0
1165         n := n0
1166
1167         for i := uintptr(0); i < n; {
1168                 // Find bits for the next word.
1169                 bits := uint32(*addb(ptrmask, i/(goarch.PtrSize*8)))
1170                 if bits == 0 {
1171                         i += goarch.PtrSize * 8
1172                         continue
1173                 }
1174                 for j := 0; j < 8 && i < n; j++ {
1175                         if bits&1 != 0 {
1176                                 // Same work as in scanobject; see comments there.
1177                                 p := *(*uintptr)(unsafe.Pointer(b + i))
1178                                 if p != 0 {
1179                                         if obj, span, objIndex := findObject(p, b, i); obj != 0 {
1180                                                 greyobject(obj, b, i, span, gcw, objIndex)
1181                                         } else if stk != nil && p >= stk.stack.lo && p < stk.stack.hi {
1182                                                 stk.putPtr(p, false)
1183                                         }
1184                                 }
1185                         }
1186                         bits >>= 1
1187                         i += goarch.PtrSize
1188                 }
1189         }
1190 }
1191
1192 // scanobject scans the object starting at b, adding pointers to gcw.
1193 // b must point to the beginning of a heap object or an oblet.
1194 // scanobject consults the GC bitmap for the pointer mask and the
1195 // spans for the size of the object.
1196 //
1197 //go:nowritebarrier
1198 func scanobject(b uintptr, gcw *gcWork) {
1199         // Prefetch object before we scan it.
1200         //
1201         // This will overlap fetching the beginning of the object with initial
1202         // setup before we start scanning the object.
1203         sys.Prefetch(b)
1204
1205         // Find the bits for b and the size of the object at b.
1206         //
1207         // b is either the beginning of an object, in which case this
1208         // is the size of the object to scan, or it points to an
1209         // oblet, in which case we compute the size to scan below.
1210         hbits := heapBitsForAddr(b)
1211         s := spanOfUnchecked(b)
1212         n := s.elemsize
1213         if n == 0 {
1214                 throw("scanobject n == 0")
1215         }
1216
1217         if n > maxObletBytes {
1218                 // Large object. Break into oblets for better
1219                 // parallelism and lower latency.
1220                 if b == s.base() {
1221                         // It's possible this is a noscan object (not
1222                         // from greyobject, but from other code
1223                         // paths), in which case we must *not* enqueue
1224                         // oblets since their bitmaps will be
1225                         // uninitialized.
1226                         if s.spanclass.noscan() {
1227                                 // Bypass the whole scan.
1228                                 gcw.bytesMarked += uint64(n)
1229                                 return
1230                         }
1231
1232                         // Enqueue the other oblets to scan later.
1233                         // Some oblets may be in b's scalar tail, but
1234                         // these will be marked as "no more pointers",
1235                         // so we'll drop out immediately when we go to
1236                         // scan those.
1237                         for oblet := b + maxObletBytes; oblet < s.base()+s.elemsize; oblet += maxObletBytes {
1238                                 if !gcw.putFast(oblet) {
1239                                         gcw.put(oblet)
1240                                 }
1241                         }
1242                 }
1243
1244                 // Compute the size of the oblet. Since this object
1245                 // must be a large object, s.base() is the beginning
1246                 // of the object.
1247                 n = s.base() + s.elemsize - b
1248                 if n > maxObletBytes {
1249                         n = maxObletBytes
1250                 }
1251         }
1252
1253         var i uintptr
1254         for i = 0; i < n; i, hbits = i+goarch.PtrSize, hbits.next() {
1255                 // Load bits once. See CL 22712 and issue 16973 for discussion.
1256                 bits := hbits.bits()
1257                 if bits&bitScan == 0 {
1258                         break // no more pointers in this object
1259                 }
1260                 if bits&bitPointer == 0 {
1261                         continue // not a pointer
1262                 }
1263
1264                 // Work here is duplicated in scanblock and above.
1265                 // If you make changes here, make changes there too.
1266                 obj := *(*uintptr)(unsafe.Pointer(b + i))
1267
1268                 // At this point we have extracted the next potential pointer.
1269                 // Quickly filter out nil and pointers back to the current object.
1270                 if obj != 0 && obj-b >= n {
1271                         // Test if obj points into the Go heap and, if so,
1272                         // mark the object.
1273                         //
1274                         // Note that it's possible for findObject to
1275                         // fail if obj points to a just-allocated heap
1276                         // object because of a race with growing the
1277                         // heap. In this case, we know the object was
1278                         // just allocated and hence will be marked by
1279                         // allocation itself.
1280                         if obj, span, objIndex := findObject(obj, b, i); obj != 0 {
1281                                 greyobject(obj, b, i, span, gcw, objIndex)
1282                         }
1283                 }
1284         }
1285         gcw.bytesMarked += uint64(n)
1286         gcw.scanWork += int64(i)
1287 }
1288
1289 // scanConservative scans block [b, b+n) conservatively, treating any
1290 // pointer-like value in the block as a pointer.
1291 //
1292 // If ptrmask != nil, only words that are marked in ptrmask are
1293 // considered as potential pointers.
1294 //
1295 // If state != nil, it's assumed that [b, b+n) is a block in the stack
1296 // and may contain pointers to stack objects.
1297 func scanConservative(b, n uintptr, ptrmask *uint8, gcw *gcWork, state *stackScanState) {
1298         if debugScanConservative {
1299                 printlock()
1300                 print("conservatively scanning [", hex(b), ",", hex(b+n), ")\n")
1301                 hexdumpWords(b, b+n, func(p uintptr) byte {
1302                         if ptrmask != nil {
1303                                 word := (p - b) / goarch.PtrSize
1304                                 bits := *addb(ptrmask, word/8)
1305                                 if (bits>>(word%8))&1 == 0 {
1306                                         return '$'
1307                                 }
1308                         }
1309
1310                         val := *(*uintptr)(unsafe.Pointer(p))
1311                         if state != nil && state.stack.lo <= val && val < state.stack.hi {
1312                                 return '@'
1313                         }
1314
1315                         span := spanOfHeap(val)
1316                         if span == nil {
1317                                 return ' '
1318                         }
1319                         idx := span.objIndex(val)
1320                         if span.isFree(idx) {
1321                                 return ' '
1322                         }
1323                         return '*'
1324                 })
1325                 printunlock()
1326         }
1327
1328         for i := uintptr(0); i < n; i += goarch.PtrSize {
1329                 if ptrmask != nil {
1330                         word := i / goarch.PtrSize
1331                         bits := *addb(ptrmask, word/8)
1332                         if bits == 0 {
1333                                 // Skip 8 words (the loop increment will do the 8th)
1334                                 //
1335                                 // This must be the first time we've
1336                                 // seen this word of ptrmask, so i
1337                                 // must be 8-word-aligned, but check
1338                                 // our reasoning just in case.
1339                                 if i%(goarch.PtrSize*8) != 0 {
1340                                         throw("misaligned mask")
1341                                 }
1342                                 i += goarch.PtrSize*8 - goarch.PtrSize
1343                                 continue
1344                         }
1345                         if (bits>>(word%8))&1 == 0 {
1346                                 continue
1347                         }
1348                 }
1349
1350                 val := *(*uintptr)(unsafe.Pointer(b + i))
1351
1352                 // Check if val points into the stack.
1353                 if state != nil && state.stack.lo <= val && val < state.stack.hi {
1354                         // val may point to a stack object. This
1355                         // object may be dead from last cycle and
1356                         // hence may contain pointers to unallocated
1357                         // objects, but unlike heap objects we can't
1358                         // tell if it's already dead. Hence, if all
1359                         // pointers to this object are from
1360                         // conservative scanning, we have to scan it
1361                         // defensively, too.
1362                         state.putPtr(val, true)
1363                         continue
1364                 }
1365
1366                 // Check if val points to a heap span.
1367                 span := spanOfHeap(val)
1368                 if span == nil {
1369                         continue
1370                 }
1371
1372                 // Check if val points to an allocated object.
1373                 idx := span.objIndex(val)
1374                 if span.isFree(idx) {
1375                         continue
1376                 }
1377
1378                 // val points to an allocated object. Mark it.
1379                 obj := span.base() + idx*span.elemsize
1380                 greyobject(obj, b, i, span, gcw, idx)
1381         }
1382 }
1383
1384 // Shade the object if it isn't already.
1385 // The object is not nil and known to be in the heap.
1386 // Preemption must be disabled.
1387 //go:nowritebarrier
1388 func shade(b uintptr) {
1389         if obj, span, objIndex := findObject(b, 0, 0); obj != 0 {
1390                 gcw := &getg().m.p.ptr().gcw
1391                 greyobject(obj, 0, 0, span, gcw, objIndex)
1392         }
1393 }
1394
1395 // obj is the start of an object with mark mbits.
1396 // If it isn't already marked, mark it and enqueue into gcw.
1397 // base and off are for debugging only and could be removed.
1398 //
1399 // See also wbBufFlush1, which partially duplicates this logic.
1400 //
1401 //go:nowritebarrierrec
1402 func greyobject(obj, base, off uintptr, span *mspan, gcw *gcWork, objIndex uintptr) {
1403         // obj should be start of allocation, and so must be at least pointer-aligned.
1404         if obj&(goarch.PtrSize-1) != 0 {
1405                 throw("greyobject: obj not pointer-aligned")
1406         }
1407         mbits := span.markBitsForIndex(objIndex)
1408
1409         if useCheckmark {
1410                 if setCheckmark(obj, base, off, mbits) {
1411                         // Already marked.
1412                         return
1413                 }
1414         } else {
1415                 if debug.gccheckmark > 0 && span.isFree(objIndex) {
1416                         print("runtime: marking free object ", hex(obj), " found at *(", hex(base), "+", hex(off), ")\n")
1417                         gcDumpObject("base", base, off)
1418                         gcDumpObject("obj", obj, ^uintptr(0))
1419                         getg().m.traceback = 2
1420                         throw("marking free object")
1421                 }
1422
1423                 // If marked we have nothing to do.
1424                 if mbits.isMarked() {
1425                         return
1426                 }
1427                 mbits.setMarked()
1428
1429                 // Mark span.
1430                 arena, pageIdx, pageMask := pageIndexOf(span.base())
1431                 if arena.pageMarks[pageIdx]&pageMask == 0 {
1432                         atomic.Or8(&arena.pageMarks[pageIdx], pageMask)
1433                 }
1434
1435                 // If this is a noscan object, fast-track it to black
1436                 // instead of greying it.
1437                 if span.spanclass.noscan() {
1438                         gcw.bytesMarked += uint64(span.elemsize)
1439                         return
1440                 }
1441         }
1442
1443         // We're adding obj to P's local workbuf, so it's likely
1444         // this object will be processed soon by the same P.
1445         // Even if the workbuf gets flushed, there will likely still be
1446         // some benefit on platforms with inclusive shared caches.
1447         sys.Prefetch(obj)
1448         // Queue the obj for scanning.
1449         if !gcw.putFast(obj) {
1450                 gcw.put(obj)
1451         }
1452 }
1453
1454 // gcDumpObject dumps the contents of obj for debugging and marks the
1455 // field at byte offset off in obj.
1456 func gcDumpObject(label string, obj, off uintptr) {
1457         s := spanOf(obj)
1458         print(label, "=", hex(obj))
1459         if s == nil {
1460                 print(" s=nil\n")
1461                 return
1462         }
1463         print(" s.base()=", hex(s.base()), " s.limit=", hex(s.limit), " s.spanclass=", s.spanclass, " s.elemsize=", s.elemsize, " s.state=")
1464         if state := s.state.get(); 0 <= state && int(state) < len(mSpanStateNames) {
1465                 print(mSpanStateNames[state], "\n")
1466         } else {
1467                 print("unknown(", state, ")\n")
1468         }
1469
1470         skipped := false
1471         size := s.elemsize
1472         if s.state.get() == mSpanManual && size == 0 {
1473                 // We're printing something from a stack frame. We
1474                 // don't know how big it is, so just show up to an
1475                 // including off.
1476                 size = off + goarch.PtrSize
1477         }
1478         for i := uintptr(0); i < size; i += goarch.PtrSize {
1479                 // For big objects, just print the beginning (because
1480                 // that usually hints at the object's type) and the
1481                 // fields around off.
1482                 if !(i < 128*goarch.PtrSize || off-16*goarch.PtrSize < i && i < off+16*goarch.PtrSize) {
1483                         skipped = true
1484                         continue
1485                 }
1486                 if skipped {
1487                         print(" ...\n")
1488                         skipped = false
1489                 }
1490                 print(" *(", label, "+", i, ") = ", hex(*(*uintptr)(unsafe.Pointer(obj + i))))
1491                 if i == off {
1492                         print(" <==")
1493                 }
1494                 print("\n")
1495         }
1496         if skipped {
1497                 print(" ...\n")
1498         }
1499 }
1500
1501 // gcmarknewobject marks a newly allocated object black. obj must
1502 // not contain any non-nil pointers.
1503 //
1504 // This is nosplit so it can manipulate a gcWork without preemption.
1505 //
1506 //go:nowritebarrier
1507 //go:nosplit
1508 func gcmarknewobject(span *mspan, obj, size, scanSize uintptr) {
1509         if useCheckmark { // The world should be stopped so this should not happen.
1510                 throw("gcmarknewobject called while doing checkmark")
1511         }
1512
1513         // Mark object.
1514         objIndex := span.objIndex(obj)
1515         span.markBitsForIndex(objIndex).setMarked()
1516
1517         // Mark span.
1518         arena, pageIdx, pageMask := pageIndexOf(span.base())
1519         if arena.pageMarks[pageIdx]&pageMask == 0 {
1520                 atomic.Or8(&arena.pageMarks[pageIdx], pageMask)
1521         }
1522
1523         gcw := &getg().m.p.ptr().gcw
1524         gcw.bytesMarked += uint64(size)
1525         gcw.scanWork += int64(scanSize)
1526 }
1527
1528 // gcMarkTinyAllocs greys all active tiny alloc blocks.
1529 //
1530 // The world must be stopped.
1531 func gcMarkTinyAllocs() {
1532         assertWorldStopped()
1533
1534         for _, p := range allp {
1535                 c := p.mcache
1536                 if c == nil || c.tiny == 0 {
1537                         continue
1538                 }
1539                 _, span, objIndex := findObject(c.tiny, 0, 0)
1540                 gcw := &p.gcw
1541                 greyobject(c.tiny, 0, 0, span, gcw, objIndex)
1542         }
1543 }