88cd27e2b4cc0343abe603a49827c334cf280866
[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 #ifndef MarkedBlock_h
23 #define MarkedBlock_h
24
25 #include "AllocatorAttributes.h"
26 #include "DestructionMode.h"
27 #include "FreeList.h"
28 #include "HeapCell.h"
29 #include "HeapOperation.h"
30 #include "IterationStatus.h"
31 #include "WeakSet.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
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         VM* vm() const;
114         WeakSet& weakSet();
115             
116         // Sweeping ensures that destructors get called and removes the block from the unswept
117         // set. Sweeping to free list also removes the block from the empty set, if it was in that
118         // set. Sweeping with SweepOnly may add this block to the empty set, if the block is found
119         // to be empty.
120         //
121         // Note that you need to make sure that the empty bit reflects reality. If it's not set
122         // and the block is freshly created, then we'll make the mistake of running destructors in
123         // the block. If it's not set and the block has nothing marked, then we'll make the
124         // mistake of making a pop freelist rather than a bump freelist.
125         enum SweepMode { SweepOnly, SweepToFreeList };
126         FreeList sweep(SweepMode = SweepOnly);
127         
128         void unsweepWithNoNewlyAllocated();
129         
130         void zap(const FreeList&);
131         
132         void shrink();
133             
134         unsigned visitWeakSet(HeapRootVisitor&);
135         void reapWeakSet();
136             
137         // While allocating from a free list, MarkedBlock temporarily has bogus
138         // cell liveness data. To restore accurate cell liveness data, call one
139         // of these functions:
140         void didConsumeFreeList(); // Call this once you've allocated all the items in the free list.
141         void stopAllocating(const FreeList&);
142         FreeList resumeAllocating(); // Call this if you canonicalized a block for some non-collection related purpose.
143             
144         // Returns true if the "newly allocated" bitmap was non-null 
145         // and was successfully cleared and false otherwise.
146         bool clearNewlyAllocated();
147             
148         size_t cellSize();
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, const HeapCell*);
158         inline bool isLiveCell(HeapVersion, const void*);
159
160         bool isLive(const HeapCell*);
161         bool isLiveCell(const void*);
162
163         bool isMarkedOrNewlyAllocated(const HeapCell*);
164         bool isMarkedOrNewlyAllocated(HeapVersion, const HeapCell*);
165             
166         bool isNewlyAllocated(const void*);
167         void setNewlyAllocated(const void*);
168         void clearNewlyAllocated(const void*);
169         
170         bool hasAnyNewlyAllocated() const { return !!m_newlyAllocated; }
171             
172         template <typename Functor> IterationStatus forEachCell(const Functor&);
173         template <typename Functor> inline IterationStatus forEachLiveCell(const Functor&);
174         template <typename Functor> inline IterationStatus forEachDeadCell(const Functor&);
175             
176         bool needsFlip();
177         
178         void assertFlipped();
179             
180         bool isFreeListed() const { return m_isFreeListed; }
181         
182         size_t index() const { return m_index; }
183         
184         void removeFromAllocator();
185         
186         void didAddToAllocator(MarkedAllocator*, size_t index);
187         void didRemoveFromAllocator();
188         
189     private:
190         Handle(Heap&, void*);
191             
192         template<DestructionMode>
193         FreeList sweepHelperSelectScribbleMode(SweepMode = SweepOnly);
194             
195         enum ScribbleMode { DontScribble, Scribble };
196             
197         template<DestructionMode, ScribbleMode>
198         FreeList sweepHelperSelectEmptyMode(SweepMode = SweepOnly);
199             
200         enum EmptyMode { IsEmpty, NotEmpty };
201         
202         template<EmptyMode, DestructionMode, ScribbleMode>
203         FreeList sweepHelperSelectHasNewlyAllocated(SweepMode = SweepOnly);
204         
205         enum NewlyAllocatedMode { HasNewlyAllocated, DoesNotHaveNewlyAllocated };
206         
207         template<EmptyMode, DestructionMode, ScribbleMode, NewlyAllocatedMode>
208         FreeList sweepHelperSelectSweepMode(SweepMode = SweepOnly);
209         
210         template<EmptyMode, SweepMode, DestructionMode, ScribbleMode, NewlyAllocatedMode>
211         FreeList sweepHelperSelectFlipMode();
212         
213         enum FlipMode { NeedsFlip, DoesNotNeedFlip };
214         
215         template<EmptyMode, SweepMode, DestructionMode, ScribbleMode, NewlyAllocatedMode, FlipMode>
216         FreeList specializedSweep();
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         std::unique_ptr<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         MarkedBlock* m_block { nullptr };
239     };
240         
241     static MarkedBlock::Handle* tryCreate(Heap&);
242         
243     Handle& handle();
244         
245     VM* vm() const;
246
247     static bool isAtomAligned(const void*);
248     static MarkedBlock* blockFor(const void*);
249     static size_t firstAtom();
250     size_t atomNumber(const void*);
251         
252     size_t markCount();
253
254     bool isMarked(const void*);
255     bool isMarked(HeapVersion, const void*);
256     bool isMarkedConcurrently(HeapVersion, const void*);
257     bool testAndSetMarked(const void*);
258         
259     bool isMarkedOrNewlyAllocated(const HeapCell*);
260     bool isMarkedOrNewlyAllocated(HeapVersion, const HeapCell*);
261     
262     bool isAtom(const void*);
263     void clearMarked(const void*);
264     
265     size_t cellSize();
266     const AllocatorAttributes& attributes() const;
267     
268     bool hasAnyMarked() const;
269     void noteMarked();
270         
271     WeakSet& weakSet();
272     
273     bool needsFlip(HeapVersion);
274     bool needsFlip();
275     
276     void aboutToMark(HeapVersion);
277         
278     void assertFlipped();
279         
280     bool needsDestruction() const { return m_needsDestruction; }
281     
282     inline void resetVersion();
283     
284 private:
285     static const size_t atomAlignmentMask = atomSize - 1;
286
287     typedef char Atom[atomSize];
288
289     MarkedBlock(VM&, Handle&);
290     Atom* atoms();
291         
292     void aboutToMarkSlow(HeapVersion);
293     void clearMarks();
294     void clearMarks(HeapVersion);
295     void clearHasAnyMarked();
296     
297     void noteMarkedSlow();
298         
299     WTF::Bitmap<atomsPerBlock, WTF::BitmapAtomic, uint8_t> m_marks;
300
301     bool m_needsDestruction;
302     Lock m_lock;
303     
304     // The actual mark count can be computed by doing: m_biasedMarkCount - m_markCountBias. Note
305     // that this count is racy. It will accurately detect whether or not exactly zero things were
306     // marked, but if N things got marked, then this may report anything in the range [1, N] (or
307     // before unbiased, it would be [1 + m_markCountBias, N + m_markCountBias].)
308     int16_t m_biasedMarkCount;
309     
310     // We bias the mark count so that if m_biasedMarkCount >= 0 then the block should be retired.
311     // We go to all this trouble to make marking a bit faster: this way, marking knows when to
312     // retire a block using a js/jns on m_biasedMarkCount.
313     //
314     // For example, if a block has room for 100 objects and retirement happens whenever 90% are
315     // live, then m_markCountBias will be -90. This way, when marking begins, this will cause us to
316     // set m_biasedMarkCount to -90 as well, since:
317     //
318     //     m_biasedMarkCount = actualMarkCount + m_markCountBias.
319     //
320     // Marking an object will increment m_biasedMarkCount. Once 90 objects get marked, we will have
321     // m_biasedMarkCount = 0, which will trigger retirement. In other words, we want to set
322     // m_markCountBias like so:
323     //
324     //     m_markCountBias = -(minMarkedBlockUtilization * cellsPerBlock)
325     //
326     // All of this also means that you can detect if any objects are marked by doing:
327     //
328     //     m_biasedMarkCount != m_markCountBias
329     int16_t m_markCountBias;
330
331     HeapVersion m_version;
332     
333     Handle& m_handle;
334     VM* m_vm;
335 };
336
337 inline MarkedBlock::Handle& MarkedBlock::handle()
338 {
339     return m_handle;
340 }
341
342 inline MarkedBlock& MarkedBlock::Handle::block()
343 {
344     return *m_block;
345 }
346
347 inline size_t MarkedBlock::firstAtom()
348 {
349     return WTF::roundUpToMultipleOf<atomSize>(sizeof(MarkedBlock)) / atomSize;
350 }
351
352 inline MarkedBlock::Atom* MarkedBlock::atoms()
353 {
354     return reinterpret_cast<Atom*>(this);
355 }
356
357 inline bool MarkedBlock::isAtomAligned(const void* p)
358 {
359     return !(reinterpret_cast<Bits>(p) & atomAlignmentMask);
360 }
361
362 inline void* MarkedBlock::Handle::cellAlign(void* p)
363 {
364     Bits base = reinterpret_cast<Bits>(block().atoms() + firstAtom());
365     Bits bits = reinterpret_cast<Bits>(p);
366     bits -= base;
367     bits -= bits % cellSize();
368     bits += base;
369     return reinterpret_cast<void*>(bits);
370 }
371
372 inline MarkedBlock* MarkedBlock::blockFor(const void* p)
373 {
374     return reinterpret_cast<MarkedBlock*>(reinterpret_cast<Bits>(p) & blockMask);
375 }
376
377 inline MarkedAllocator* MarkedBlock::Handle::allocator() const
378 {
379     return m_allocator;
380 }
381
382 inline Heap* MarkedBlock::Handle::heap() const
383 {
384     return m_weakSet.heap();
385 }
386
387 inline VM* MarkedBlock::Handle::vm() const
388 {
389     return m_weakSet.vm();
390 }
391
392 inline VM* MarkedBlock::vm() const
393 {
394     return m_vm;
395 }
396
397 inline WeakSet& MarkedBlock::Handle::weakSet()
398 {
399     return m_weakSet;
400 }
401
402 inline WeakSet& MarkedBlock::weakSet()
403 {
404     return m_handle.weakSet();
405 }
406
407 inline void MarkedBlock::Handle::shrink()
408 {
409     m_weakSet.shrink();
410 }
411
412 inline unsigned MarkedBlock::Handle::visitWeakSet(HeapRootVisitor& heapRootVisitor)
413 {
414     return m_weakSet.visit(heapRootVisitor);
415 }
416
417 inline void MarkedBlock::Handle::reapWeakSet()
418 {
419     m_weakSet.reap();
420 }
421
422 inline size_t MarkedBlock::Handle::cellSize()
423 {
424     return m_atomsPerCell * atomSize;
425 }
426
427 inline size_t MarkedBlock::cellSize()
428 {
429     return m_handle.cellSize();
430 }
431
432 inline const AllocatorAttributes& MarkedBlock::Handle::attributes() const
433 {
434     return m_attributes;
435 }
436
437 inline const AllocatorAttributes& MarkedBlock::attributes() const
438 {
439     return m_handle.attributes();
440 }
441
442 inline bool MarkedBlock::Handle::needsDestruction() const
443 {
444     return m_attributes.destruction == NeedsDestruction;
445 }
446
447 inline DestructionMode MarkedBlock::Handle::destruction() const
448 {
449     return m_attributes.destruction;
450 }
451
452 inline HeapCell::Kind MarkedBlock::Handle::cellKind() const
453 {
454     return m_attributes.cellKind;
455 }
456
457 inline size_t MarkedBlock::Handle::markCount()
458 {
459     return m_block->markCount();
460 }
461
462 inline size_t MarkedBlock::Handle::size()
463 {
464     return markCount() * cellSize();
465 }
466
467 inline size_t MarkedBlock::atomNumber(const void* p)
468 {
469     return (reinterpret_cast<Bits>(p) - reinterpret_cast<Bits>(this)) / atomSize;
470 }
471
472 inline bool MarkedBlock::needsFlip(HeapVersion heapVersion)
473 {
474     return heapVersion != m_version;
475 }
476
477 inline void MarkedBlock::aboutToMark(HeapVersion heapVersion)
478 {
479     if (UNLIKELY(needsFlip(heapVersion)))
480         aboutToMarkSlow(heapVersion);
481     WTF::loadLoadFence();
482 }
483
484 #if ASSERT_DISABLED
485 inline void MarkedBlock::assertFlipped()
486 {
487 }
488 #endif // ASSERT_DISABLED
489
490 inline void MarkedBlock::Handle::assertFlipped()
491 {
492     block().assertFlipped();
493 }
494
495 inline bool MarkedBlock::isMarked(HeapVersion heapVersion, const void* p)
496 {
497     return needsFlip(heapVersion) ? false : m_marks.get(atomNumber(p));
498 }
499
500 inline bool MarkedBlock::isMarkedConcurrently(HeapVersion heapVersion, const void* p)
501 {
502     if (needsFlip(heapVersion))
503         return false;
504     WTF::loadLoadFence();
505     return m_marks.get(atomNumber(p));
506 }
507
508 inline bool MarkedBlock::testAndSetMarked(const void* p)
509 {
510     assertFlipped();
511     return m_marks.concurrentTestAndSet(atomNumber(p));
512 }
513
514 inline bool MarkedBlock::Handle::isNewlyAllocated(const void* p)
515 {
516     return m_newlyAllocated->get(m_block->atomNumber(p));
517 }
518
519 inline void MarkedBlock::Handle::setNewlyAllocated(const void* p)
520 {
521     m_newlyAllocated->set(m_block->atomNumber(p));
522 }
523
524 inline void MarkedBlock::Handle::clearNewlyAllocated(const void* p)
525 {
526     m_newlyAllocated->clear(m_block->atomNumber(p));
527 }
528
529 inline bool MarkedBlock::Handle::clearNewlyAllocated()
530 {
531     if (m_newlyAllocated) {
532         m_newlyAllocated = nullptr;
533         return true;
534     }
535     return false;
536 }
537
538 inline bool MarkedBlock::Handle::isMarkedOrNewlyAllocated(HeapVersion version, const HeapCell* cell)
539 {
540     return m_block->isMarked(version, cell) || (m_newlyAllocated && isNewlyAllocated(cell));
541 }
542
543 inline bool MarkedBlock::isMarkedOrNewlyAllocated(HeapVersion version, const HeapCell* cell)
544 {
545     return isMarked(version, cell) || (m_handle.m_newlyAllocated && m_handle.isNewlyAllocated(cell));
546 }
547
548 inline bool MarkedBlock::isAtom(const void* p)
549 {
550     ASSERT(MarkedBlock::isAtomAligned(p));
551     size_t atomNumber = this->atomNumber(p);
552     size_t firstAtom = MarkedBlock::firstAtom();
553     if (atomNumber < firstAtom) // Filters pointers into MarkedBlock metadata.
554         return false;
555     if ((atomNumber - firstAtom) % m_handle.m_atomsPerCell) // Filters pointers into cell middles.
556         return false;
557     if (atomNumber >= m_handle.m_endAtom) // Filters pointers into invalid cells out of the range.
558         return false;
559     return true;
560 }
561
562 template <typename Functor>
563 inline IterationStatus MarkedBlock::Handle::forEachCell(const Functor& functor)
564 {
565     HeapCell::Kind kind = m_attributes.cellKind;
566     for (size_t i = firstAtom(); i < m_endAtom; i += m_atomsPerCell) {
567         HeapCell* cell = reinterpret_cast_ptr<HeapCell*>(&m_block->atoms()[i]);
568         if (functor(cell, kind) == IterationStatus::Done)
569             return IterationStatus::Done;
570     }
571     return IterationStatus::Continue;
572 }
573
574 inline bool MarkedBlock::hasAnyMarked() const
575 {
576     return m_biasedMarkCount != m_markCountBias;
577 }
578
579 inline void MarkedBlock::noteMarked()
580 {
581     // This is racy by design. We don't want to pay the price of an atomic increment!
582     int16_t biasedMarkCount = m_biasedMarkCount;
583     ++biasedMarkCount;
584     m_biasedMarkCount = biasedMarkCount;
585     if (UNLIKELY(!biasedMarkCount))
586         noteMarkedSlow();
587 }
588
589 } // namespace JSC
590
591 namespace WTF {
592
593 struct MarkedBlockHash : PtrHash<JSC::MarkedBlock*> {
594     static unsigned hash(JSC::MarkedBlock* const& key)
595     {
596         // Aligned VM regions tend to be monotonically increasing integers,
597         // which is a great hash function, but we have to remove the low bits,
598         // since they're always zero, which is a terrible hash function!
599         return reinterpret_cast<JSC::Bits>(key) / JSC::MarkedBlock::blockSize;
600     }
601 };
602
603 template<> struct DefaultHash<JSC::MarkedBlock*> {
604     typedef MarkedBlockHash Hash;
605 };
606
607 void printInternal(PrintStream& out, JSC::MarkedBlock::Handle::SweepMode);
608
609 } // namespace WTF
610
611 #endif // MarkedBlock_h