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