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