Unreviewed, rolling out r209766.
[WebKit.git] / Source / JavaScriptCore / heap / MarkedBlockInlines.h
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #pragma once
27
28 #include "MarkedAllocator.h"
29 #include "MarkedBlock.h"
30 #include "MarkedSpace.h"
31 #include "VM.h"
32
33 namespace JSC {
34
35 inline unsigned MarkedBlock::Handle::cellsPerBlock()
36 {
37     return MarkedSpace::blockPayload / cellSize();
38 }
39
40 inline bool MarkedBlock::marksConveyLivenessDuringMarking(HeapVersion markingVersion)
41 {
42     // This returns true if any of these is true:
43     // - We just created the block and so the bits are clear already.
44     // - This block has objects marked during the last GC, and so its version was up-to-date just
45     //   before the current collection did beginMarking(). This means that any objects that have 
46     //   their mark bit set are valid objects that were never deleted, and so are candidates for
47     //   marking in any conservative scan. Using our jargon, they are "live".
48     // - We did ~2^32 collections and rotated the version back to null, so we needed to hard-reset
49     //   everything. If the marks had been stale, we would have cleared them. So, we can be sure that
50     //   any set mark bit reflects objects marked during last GC, i.e. "live" objects.
51     // It would be absurd to use this method when not collecting, since this special "one version
52     // back" state only makes sense when we're in a concurrent collection and have to be
53     // conservative.
54     ASSERT(space()->isMarking());
55     if (heap()->collectionScope() != CollectionScope::Full)
56         return false;
57     return m_markingVersion == MarkedSpace::nullVersion
58         || MarkedSpace::nextVersion(m_markingVersion) == markingVersion;
59 }
60
61 inline bool MarkedBlock::Handle::isLive(HeapVersion markingVersion, bool isMarking, const HeapCell* cell)
62 {
63     ASSERT(!isFreeListed());
64     
65     if (UNLIKELY(hasAnyNewlyAllocated())) {
66         if (isNewlyAllocated(cell))
67             return true;
68     }
69     
70     if (allocator()->isAllocated(NoLockingNecessary, this))
71         return true;
72     
73     MarkedBlock& block = this->block();
74     
75     if (block.areMarksStale()) {
76         if (!isMarking)
77             return false;
78         if (!block.marksConveyLivenessDuringMarking(markingVersion))
79             return false;
80     }
81
82     return block.m_marks.get(block.atomNumber(cell));
83 }
84
85 inline bool MarkedBlock::Handle::isLiveCell(HeapVersion markingVersion, bool isMarking, const void* p)
86 {
87     if (!m_block->isAtom(p))
88         return false;
89     return isLive(markingVersion, isMarking, static_cast<const HeapCell*>(p));
90 }
91
92 inline bool MarkedBlock::Handle::isNewlyAllocatedStale() const
93 {
94     return m_newlyAllocatedVersion != space()->newlyAllocatedVersion();
95 }
96
97 inline bool MarkedBlock::Handle::hasAnyNewlyAllocated()
98 {
99     return !isNewlyAllocatedStale();
100 }
101
102 template <typename Functor>
103 inline IterationStatus MarkedBlock::Handle::forEachLiveCell(const Functor& functor)
104 {
105     HeapCell::Kind kind = m_attributes.cellKind;
106     for (size_t i = firstAtom(); i < m_endAtom; i += m_atomsPerCell) {
107         HeapCell* cell = reinterpret_cast_ptr<HeapCell*>(&m_block->atoms()[i]);
108         if (!isLive(cell))
109             continue;
110
111         if (functor(cell, kind) == IterationStatus::Done)
112             return IterationStatus::Done;
113     }
114     return IterationStatus::Continue;
115 }
116
117 template <typename Functor>
118 inline IterationStatus MarkedBlock::Handle::forEachDeadCell(const Functor& functor)
119 {
120     HeapCell::Kind kind = m_attributes.cellKind;
121     for (size_t i = firstAtom(); i < m_endAtom; i += m_atomsPerCell) {
122         HeapCell* cell = reinterpret_cast_ptr<HeapCell*>(&m_block->atoms()[i]);
123         if (isLive(cell))
124             continue;
125
126         if (functor(cell, kind) == IterationStatus::Done)
127             return IterationStatus::Done;
128     }
129     return IterationStatus::Continue;
130 }
131
132 inline Heap* MarkedBlock::heap() const
133 {
134     return &vm()->heap;
135 }
136
137 inline MarkedSpace* MarkedBlock::space() const
138 {
139     return &heap()->objectSpace();
140 }
141
142 inline MarkedSpace* MarkedBlock::Handle::space() const
143 {
144     return &heap()->objectSpace();
145 }
146
147 } // namespace JSC
148