Make opaque root scanning truly constraint-based
[WebKit-https.git] / Source / JavaScriptCore / heap / MarkedBlock.h
1 /*
2  *  Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2003-2017 Apple Inc. All rights reserved.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Lesser General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Lesser General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Lesser General Public
17  *  License along with this library; if not, write to the Free Software
18  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  */
21
22 #pragma once
23
24 #include "AllocatorAttributes.h"
25 #include "DestructionMode.h"
26 #include "FreeList.h"
27 #include "HeapCell.h"
28 #include "IterationStatus.h"
29 #include "WeakSet.h"
30 #include <wtf/Atomics.h>
31 #include <wtf/Bitmap.h>
32 #include <wtf/DataLog.h>
33 #include <wtf/DoublyLinkedList.h>
34 #include <wtf/HashFunctions.h>
35 #include <wtf/StdLibExtras.h>
36
37 namespace JSC {
38     
39 class Heap;
40 class JSCell;
41 class MarkedAllocator;
42 class MarkedSpace;
43 class SlotVisitor;
44 class Subspace;
45
46 typedef uintptr_t Bits;
47 typedef uint32_t HeapVersion;
48
49 // A marked block is a page-aligned container for heap-allocated objects.
50 // Objects are allocated within cells of the marked block. For a given
51 // marked block, all cells have the same size. Objects smaller than the
52 // cell size may be allocated in the marked block, in which case the
53 // allocation suffers from internal fragmentation: wasted space whose
54 // size is equal to the difference between the cell size and the object
55 // size.
56
57 class MarkedBlock {
58     WTF_MAKE_NONCOPYABLE(MarkedBlock);
59     friend class LLIntOffsetsExtractor;
60     friend struct VerifyMarked;
61
62 public:
63     class Handle;
64 private:
65     friend class Handle;
66 public:
67     static const size_t atomSize = 16; // bytes
68     static const size_t blockSize = 16 * KB;
69     static const size_t blockMask = ~(blockSize - 1); // blockSize must be a power of two.
70
71     static const size_t atomsPerBlock = blockSize / atomSize;
72
73     static_assert(!(MarkedBlock::atomSize & (MarkedBlock::atomSize - 1)), "MarkedBlock::atomSize must be a power of two.");
74     static_assert(!(MarkedBlock::blockSize & (MarkedBlock::blockSize - 1)), "MarkedBlock::blockSize must be a power of two.");
75     
76     struct VoidFunctor {
77         typedef void ReturnType;
78         void returnValue() { }
79     };
80     
81     class CountFunctor {
82     public:
83         typedef size_t ReturnType;
84
85         CountFunctor() : m_count(0) { }
86         void count(size_t count) const { m_count += count; }
87         ReturnType returnValue() const { return m_count; }
88
89     private:
90         // FIXME: This is mutable because we're using a functor rather than C++ lambdas.
91         // https://bugs.webkit.org/show_bug.cgi?id=159644
92         mutable ReturnType m_count;
93     };
94         
95     class Handle {
96         WTF_MAKE_NONCOPYABLE(Handle);
97         WTF_MAKE_FAST_ALLOCATED;
98         friend class LLIntOffsetsExtractor;
99         friend class MarkedBlock;
100         friend struct VerifyMarked;
101     public:
102             
103         ~Handle();
104             
105         MarkedBlock& block();
106             
107         void* cellAlign(void*);
108             
109         bool isEmpty();
110
111         void lastChanceToFinalize();
112
113         MarkedAllocator* allocator() const;
114         Subspace* subspace() const;
115         Heap* heap() const;
116         inline MarkedSpace* space() const;
117         VM* vm() const;
118         WeakSet& weakSet();
119             
120         // Sweeping ensures that destructors get called and removes the block from the unswept
121         // set. Sweeping to free list also removes the block from the empty set, if it was in that
122         // set. Sweeping with SweepOnly may add this block to the empty set, if the block is found
123         // to be empty.
124         //
125         // Note that you need to make sure that the empty bit reflects reality. If it's not set
126         // and the block is freshly created, then we'll make the mistake of running destructors in
127         // the block. If it's not set and the block has nothing marked, then we'll make the
128         // mistake of making a pop freelist rather than a bump freelist.
129         enum SweepMode { SweepOnly, SweepToFreeList };
130         FreeList sweep(SweepMode = SweepOnly);
131         
132         // This is to be called by Subspace.
133         template<typename DestroyFunc>
134         FreeList finishSweepKnowingSubspace(SweepMode, const DestroyFunc&);
135         
136         void unsweepWithNoNewlyAllocated();
137         
138         void zap(const FreeList&);
139         
140         void shrink();
141             
142         void visitWeakSet(SlotVisitor&);
143         void reapWeakSet();
144             
145         // While allocating from a free list, MarkedBlock temporarily has bogus
146         // cell liveness data. To restore accurate cell liveness data, call one
147         // of these functions:
148         void didConsumeFreeList(); // Call this once you've allocated all the items in the free list.
149         void stopAllocating(const FreeList&);
150         FreeList resumeAllocating(); // Call this if you canonicalized a block for some non-collection related purpose.
151             
152         size_t cellSize();
153         inline unsigned cellsPerBlock();
154         
155         const AllocatorAttributes& attributes() const;
156         DestructionMode destruction() const;
157         bool needsDestruction() const;
158         HeapCell::Kind cellKind() const;
159             
160         size_t markCount();
161         size_t size();
162         
163         inline bool isLive(HeapVersion markingVersion, bool isMarking, const HeapCell*);
164         inline bool isLiveCell(HeapVersion markingVersion, bool isMarking, const void*);
165
166         bool isLive(const HeapCell*);
167         bool isLiveCell(const void*);
168
169         bool isNewlyAllocated(const void*);
170         void setNewlyAllocated(const void*);
171         void clearNewlyAllocated(const void*);
172         
173         HeapVersion newlyAllocatedVersion() const { return m_newlyAllocatedVersion; }
174         
175         inline bool isNewlyAllocatedStale() const;
176         
177         inline bool hasAnyNewlyAllocated();
178         void resetAllocated();
179         
180         template <typename Functor> IterationStatus forEachCell(const Functor&);
181         template <typename Functor> inline IterationStatus forEachLiveCell(const Functor&);
182         template <typename Functor> inline IterationStatus forEachDeadCell(const Functor&);
183         template <typename Functor> inline IterationStatus forEachMarkedCell(const Functor&);
184             
185         JS_EXPORT_PRIVATE bool areMarksStale();
186         
187         void assertMarksNotStale();
188             
189         bool isFreeListed() const { return m_isFreeListed; }
190         
191         size_t index() const { return m_index; }
192         
193         void removeFromAllocator();
194         
195         void didAddToAllocator(MarkedAllocator*, size_t index);
196         void didRemoveFromAllocator();
197         
198         void dumpState(PrintStream&);
199         
200     private:
201         Handle(Heap&, void*);
202         
203         enum SweepDestructionMode { BlockHasNoDestructors, BlockHasDestructors, BlockHasDestructorsAndCollectorIsRunning };
204         enum ScribbleMode { DontScribble, Scribble };
205         enum EmptyMode { IsEmpty, NotEmpty };
206         enum NewlyAllocatedMode { HasNewlyAllocated, DoesNotHaveNewlyAllocated };
207         enum MarksMode { MarksStale, MarksNotStale };
208         
209         SweepDestructionMode sweepDestructionMode();
210         EmptyMode emptyMode();
211         ScribbleMode scribbleMode();
212         NewlyAllocatedMode newlyAllocatedMode();
213         MarksMode marksMode();
214         
215         template<bool, EmptyMode, SweepMode, SweepDestructionMode, ScribbleMode, NewlyAllocatedMode, MarksMode, typename DestroyFunc>
216         FreeList specializedSweep(EmptyMode, SweepMode, SweepDestructionMode, ScribbleMode, NewlyAllocatedMode, MarksMode, const DestroyFunc&);
217         
218         template<typename Func>
219         void forEachFreeCell(const FreeList&, const Func&);
220         
221         void setIsFreeListed();
222         
223         MarkedBlock::Handle* m_prev;
224         MarkedBlock::Handle* m_next;
225             
226         size_t m_atomsPerCell { std::numeric_limits<size_t>::max() };
227         size_t m_endAtom { std::numeric_limits<size_t>::max() }; // This is a fuzzy end. Always test for < m_endAtom.
228             
229         WTF::Bitmap<atomsPerBlock> m_newlyAllocated;
230             
231         AllocatorAttributes m_attributes;
232         bool m_isFreeListed { false };
233             
234         MarkedAllocator* m_allocator { nullptr };
235         size_t m_index { std::numeric_limits<size_t>::max() };
236         WeakSet m_weakSet;
237         
238         HeapVersion m_newlyAllocatedVersion;
239             
240         MarkedBlock* m_block { nullptr };
241     };
242         
243     static MarkedBlock::Handle* tryCreate(Heap&);
244         
245     Handle& handle();
246         
247     VM* vm() const;
248     inline Heap* heap() const;
249     inline MarkedSpace* space() const;
250
251     static bool isAtomAligned(const void*);
252     static MarkedBlock* blockFor(const void*);
253     static size_t firstAtom();
254     size_t atomNumber(const void*);
255         
256     size_t markCount();
257
258     bool isMarked(const void*);
259     bool isMarked(HeapVersion markingVersion, const void*);
260     bool isMarkedConcurrently(HeapVersion markingVersion, const void*);
261     bool testAndSetMarked(const void*);
262         
263     bool isAtom(const void*);
264     void clearMarked(const void*);
265     
266     size_t cellSize();
267     const AllocatorAttributes& attributes() const;
268     
269     bool hasAnyMarked() const;
270     void noteMarked();
271 #if ASSERT_DISABLED
272     void assertValidCell(VM&, HeapCell*) const { }
273 #else
274     void assertValidCell(VM&, HeapCell*) const;
275 #endif
276         
277     WeakSet& weakSet();
278
279     JS_EXPORT_PRIVATE bool areMarksStale();
280     bool areMarksStale(HeapVersion markingVersion);
281     struct MarksWithDependency {
282         bool areStale;
283         ConsumeDependency dependency;
284     };
285     MarksWithDependency areMarksStaleWithDependency(HeapVersion markingVersion);
286     
287     void aboutToMark(HeapVersion markingVersion);
288         
289     void assertMarksNotStale();
290         
291     bool needsDestruction() const { return m_needsDestruction; }
292     
293     // This is usually a no-op, and we use it as a no-op that touches the page in isPagedOut().
294     void updateNeedsDestruction();
295     
296     void resetMarks();
297     
298     bool isMarkedRaw(const void* p);
299     HeapVersion markingVersion() const { return m_markingVersion; }
300     
301 private:
302     static const size_t atomAlignmentMask = atomSize - 1;
303
304     typedef char Atom[atomSize];
305
306     MarkedBlock(VM&, Handle&);
307     Atom* atoms();
308         
309     void aboutToMarkSlow(HeapVersion markingVersion);
310     void clearHasAnyMarked();
311     
312     void noteMarkedSlow();
313     
314     inline bool marksConveyLivenessDuringMarking(HeapVersion markingVersion);
315         
316     WTF::Bitmap<atomsPerBlock> m_marks;
317
318     bool m_needsDestruction;
319     Lock m_lock;
320     
321     // The actual mark count can be computed by doing: m_biasedMarkCount - m_markCountBias. Note
322     // that this count is racy. It will accurately detect whether or not exactly zero things were
323     // marked, but if N things got marked, then this may report anything in the range [1, N] (or
324     // before unbiased, it would be [1 + m_markCountBias, N + m_markCountBias].)
325     int16_t m_biasedMarkCount;
326     
327     // We bias the mark count so that if m_biasedMarkCount >= 0 then the block should be retired.
328     // We go to all this trouble to make marking a bit faster: this way, marking knows when to
329     // retire a block using a js/jns on m_biasedMarkCount.
330     //
331     // For example, if a block has room for 100 objects and retirement happens whenever 90% are
332     // live, then m_markCountBias will be -90. This way, when marking begins, this will cause us to
333     // set m_biasedMarkCount to -90 as well, since:
334     //
335     //     m_biasedMarkCount = actualMarkCount + m_markCountBias.
336     //
337     // Marking an object will increment m_biasedMarkCount. Once 90 objects get marked, we will have
338     // m_biasedMarkCount = 0, which will trigger retirement. In other words, we want to set
339     // m_markCountBias like so:
340     //
341     //     m_markCountBias = -(minMarkedBlockUtilization * cellsPerBlock)
342     //
343     // All of this also means that you can detect if any objects are marked by doing:
344     //
345     //     m_biasedMarkCount != m_markCountBias
346     int16_t m_markCountBias;
347
348     HeapVersion m_markingVersion;
349     
350     Handle& m_handle;
351     VM* m_vm;
352 };
353
354 inline MarkedBlock::Handle& MarkedBlock::handle()
355 {
356     return m_handle;
357 }
358
359 inline MarkedBlock& MarkedBlock::Handle::block()
360 {
361     return *m_block;
362 }
363
364 inline size_t MarkedBlock::firstAtom()
365 {
366     return WTF::roundUpToMultipleOf<atomSize>(sizeof(MarkedBlock)) / atomSize;
367 }
368
369 inline MarkedBlock::Atom* MarkedBlock::atoms()
370 {
371     return reinterpret_cast<Atom*>(this);
372 }
373
374 inline bool MarkedBlock::isAtomAligned(const void* p)
375 {
376     return !(reinterpret_cast<Bits>(p) & atomAlignmentMask);
377 }
378
379 inline void* MarkedBlock::Handle::cellAlign(void* p)
380 {
381     Bits base = reinterpret_cast<Bits>(block().atoms() + firstAtom());
382     Bits bits = reinterpret_cast<Bits>(p);
383     bits -= base;
384     bits -= bits % cellSize();
385     bits += base;
386     return reinterpret_cast<void*>(bits);
387 }
388
389 inline MarkedBlock* MarkedBlock::blockFor(const void* p)
390 {
391     return reinterpret_cast<MarkedBlock*>(reinterpret_cast<Bits>(p) & blockMask);
392 }
393
394 inline MarkedAllocator* MarkedBlock::Handle::allocator() const
395 {
396     return m_allocator;
397 }
398
399 inline Heap* MarkedBlock::Handle::heap() const
400 {
401     return m_weakSet.heap();
402 }
403
404 inline VM* MarkedBlock::Handle::vm() const
405 {
406     return m_weakSet.vm();
407 }
408
409 inline VM* MarkedBlock::vm() const
410 {
411     return m_vm;
412 }
413
414 inline WeakSet& MarkedBlock::Handle::weakSet()
415 {
416     return m_weakSet;
417 }
418
419 inline WeakSet& MarkedBlock::weakSet()
420 {
421     return m_handle.weakSet();
422 }
423
424 inline void MarkedBlock::Handle::shrink()
425 {
426     m_weakSet.shrink();
427 }
428
429 inline void MarkedBlock::Handle::visitWeakSet(SlotVisitor& visitor)
430 {
431     return m_weakSet.visit(visitor);
432 }
433
434 inline void MarkedBlock::Handle::reapWeakSet()
435 {
436     m_weakSet.reap();
437 }
438
439 inline size_t MarkedBlock::Handle::cellSize()
440 {
441     return m_atomsPerCell * atomSize;
442 }
443
444 inline size_t MarkedBlock::cellSize()
445 {
446     return m_handle.cellSize();
447 }
448
449 inline const AllocatorAttributes& MarkedBlock::Handle::attributes() const
450 {
451     return m_attributes;
452 }
453
454 inline const AllocatorAttributes& MarkedBlock::attributes() const
455 {
456     return m_handle.attributes();
457 }
458
459 inline bool MarkedBlock::Handle::needsDestruction() const
460 {
461     return m_attributes.destruction == NeedsDestruction;
462 }
463
464 inline DestructionMode MarkedBlock::Handle::destruction() const
465 {
466     return m_attributes.destruction;
467 }
468
469 inline HeapCell::Kind MarkedBlock::Handle::cellKind() const
470 {
471     return m_attributes.cellKind;
472 }
473
474 inline size_t MarkedBlock::Handle::markCount()
475 {
476     return m_block->markCount();
477 }
478
479 inline size_t MarkedBlock::Handle::size()
480 {
481     return markCount() * cellSize();
482 }
483
484 inline size_t MarkedBlock::atomNumber(const void* p)
485 {
486     return (reinterpret_cast<Bits>(p) - reinterpret_cast<Bits>(this)) / atomSize;
487 }
488
489 inline bool MarkedBlock::areMarksStale(HeapVersion markingVersion)
490 {
491     return markingVersion != m_markingVersion;
492 }
493
494 ALWAYS_INLINE MarkedBlock::MarksWithDependency MarkedBlock::areMarksStaleWithDependency(HeapVersion markingVersion)
495 {
496     auto consumed = consumeLoad(&m_markingVersion);
497     MarksWithDependency ret;
498     ret.areStale = consumed.value != markingVersion;
499     ret.dependency = consumed.dependency;
500     return ret;
501 }
502
503 inline void MarkedBlock::aboutToMark(HeapVersion markingVersion)
504 {
505     if (UNLIKELY(areMarksStale(markingVersion)))
506         aboutToMarkSlow(markingVersion);
507     WTF::loadLoadFence();
508 }
509
510 #if ASSERT_DISABLED
511 inline void MarkedBlock::assertMarksNotStale()
512 {
513 }
514 #endif // ASSERT_DISABLED
515
516 inline void MarkedBlock::Handle::assertMarksNotStale()
517 {
518     block().assertMarksNotStale();
519 }
520
521 inline bool MarkedBlock::isMarkedRaw(const void* p)
522 {
523     return m_marks.get(atomNumber(p));
524 }
525
526 inline bool MarkedBlock::isMarked(HeapVersion markingVersion, const void* p)
527 {
528     return areMarksStale(markingVersion) ? false : isMarkedRaw(p);
529 }
530
531 inline bool MarkedBlock::isMarkedConcurrently(HeapVersion markingVersion, const void* p)
532 {
533     auto marksWithDependency = areMarksStaleWithDependency(markingVersion);
534     if (marksWithDependency.areStale)
535         return false;
536     return m_marks.get(atomNumber(p) + marksWithDependency.dependency);
537 }
538
539 inline bool MarkedBlock::testAndSetMarked(const void* p)
540 {
541     assertMarksNotStale();
542     return m_marks.concurrentTestAndSet(atomNumber(p));
543 }
544
545 inline bool MarkedBlock::Handle::isNewlyAllocated(const void* p)
546 {
547     return m_newlyAllocated.get(m_block->atomNumber(p));
548 }
549
550 inline void MarkedBlock::Handle::setNewlyAllocated(const void* p)
551 {
552     m_newlyAllocated.set(m_block->atomNumber(p));
553 }
554
555 inline void MarkedBlock::Handle::clearNewlyAllocated(const void* p)
556 {
557     m_newlyAllocated.clear(m_block->atomNumber(p));
558 }
559
560 inline bool MarkedBlock::isAtom(const void* p)
561 {
562     ASSERT(MarkedBlock::isAtomAligned(p));
563     size_t atomNumber = this->atomNumber(p);
564     size_t firstAtom = MarkedBlock::firstAtom();
565     if (atomNumber < firstAtom) // Filters pointers into MarkedBlock metadata.
566         return false;
567     if ((atomNumber - firstAtom) % m_handle.m_atomsPerCell) // Filters pointers into cell middles.
568         return false;
569     if (atomNumber >= m_handle.m_endAtom) // Filters pointers into invalid cells out of the range.
570         return false;
571     return true;
572 }
573
574 template <typename Functor>
575 inline IterationStatus MarkedBlock::Handle::forEachCell(const Functor& functor)
576 {
577     HeapCell::Kind kind = m_attributes.cellKind;
578     for (size_t i = firstAtom(); i < m_endAtom; i += m_atomsPerCell) {
579         HeapCell* cell = reinterpret_cast_ptr<HeapCell*>(&m_block->atoms()[i]);
580         if (functor(cell, kind) == IterationStatus::Done)
581             return IterationStatus::Done;
582     }
583     return IterationStatus::Continue;
584 }
585
586 inline bool MarkedBlock::hasAnyMarked() const
587 {
588     return m_biasedMarkCount != m_markCountBias;
589 }
590
591 inline void MarkedBlock::noteMarked()
592 {
593     // This is racy by design. We don't want to pay the price of an atomic increment!
594     int16_t biasedMarkCount = m_biasedMarkCount;
595     ++biasedMarkCount;
596     m_biasedMarkCount = biasedMarkCount;
597     if (UNLIKELY(!biasedMarkCount))
598         noteMarkedSlow();
599 }
600
601 } // namespace JSC
602
603 namespace WTF {
604
605 struct MarkedBlockHash : PtrHash<JSC::MarkedBlock*> {
606     static unsigned hash(JSC::MarkedBlock* const& key)
607     {
608         // Aligned VM regions tend to be monotonically increasing integers,
609         // which is a great hash function, but we have to remove the low bits,
610         // since they're always zero, which is a terrible hash function!
611         return reinterpret_cast<JSC::Bits>(key) / JSC::MarkedBlock::blockSize;
612     }
613 };
614
615 template<> struct DefaultHash<JSC::MarkedBlock*> {
616     typedef MarkedBlockHash Hash;
617 };
618
619 void printInternal(PrintStream& out, JSC::MarkedBlock::Handle::SweepMode);
620
621 } // namespace WTF