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