595330adf4f91c9fc0765fde7bcf712b0730f097
[WebKit-https.git] / Source / JavaScriptCore / heap / ConservativeRoots.cpp
1 /*
2  * Copyright (C) 2011, 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "ConservativeRoots.h"
28
29 #include "CodeBlock.h"
30 #include "CodeBlockSetInlines.h"
31 #include "HeapInlines.h"
32 #include "HeapUtil.h"
33 #include "JITStubRoutineSet.h"
34 #include "JSCell.h"
35 #include "JSObject.h"
36 #include "JSCInlines.h"
37 #include "MarkedBlockInlines.h"
38 #include "Structure.h"
39 #include <wtf/OSAllocator.h>
40
41 namespace JSC {
42
43 ConservativeRoots::ConservativeRoots(Heap& heap)
44     : m_roots(m_inlineRoots)
45     , m_size(0)
46     , m_capacity(inlineCapacity)
47     , m_heap(heap)
48 {
49 }
50
51 ConservativeRoots::~ConservativeRoots()
52 {
53     if (m_roots != m_inlineRoots)
54         OSAllocator::decommitAndRelease(m_roots, m_capacity * sizeof(HeapCell*));
55 }
56
57 void ConservativeRoots::grow()
58 {
59     size_t newCapacity = m_capacity == inlineCapacity ? nonInlineCapacity : m_capacity * 2;
60     HeapCell** newRoots = static_cast<HeapCell**>(OSAllocator::reserveAndCommit(newCapacity * sizeof(HeapCell*)));
61     memcpy(newRoots, m_roots, m_size * sizeof(HeapCell*));
62     if (m_roots != m_inlineRoots)
63         OSAllocator::decommitAndRelease(m_roots, m_capacity * sizeof(HeapCell*));
64     m_capacity = newCapacity;
65     m_roots = newRoots;
66 }
67
68 template<typename MarkHook>
69 inline void ConservativeRoots::genericAddPointer(void* p, HeapVersion markingVersion, TinyBloomFilter filter, MarkHook& markHook)
70 {
71     markHook.mark(p);
72
73     HeapUtil::findGCObjectPointersForMarking(
74         m_heap, markingVersion, filter, p,
75         [&] (void* p) {
76             if (m_size == m_capacity)
77                 grow();
78             
79             m_roots[m_size++] = bitwise_cast<HeapCell*>(p);
80         });
81 }
82
83 template<typename MarkHook>
84 SUPPRESS_ASAN
85 void ConservativeRoots::genericAddSpan(void* begin, void* end, MarkHook& markHook)
86 {
87     if (begin > end) {
88         void* swapTemp = begin;
89         begin = end;
90         end = swapTemp;
91     }
92
93     RELEASE_ASSERT(isPointerAligned(begin));
94     RELEASE_ASSERT(isPointerAligned(end));
95
96     TinyBloomFilter filter = m_heap.objectSpace().blocks().filter(); // Make a local copy of filter to show the compiler it won't alias, and can be register-allocated.
97     HeapVersion markingVersion = m_heap.objectSpace().markingVersion();
98     for (char** it = static_cast<char**>(begin); it != static_cast<char**>(end); ++it)
99         genericAddPointer(*it, markingVersion, filter, markHook);
100 }
101
102 class DummyMarkHook {
103 public:
104     void mark(void*) { }
105 };
106
107 void ConservativeRoots::add(void* begin, void* end)
108 {
109     DummyMarkHook dummy;
110     genericAddSpan(begin, end, dummy);
111 }
112
113 void ConservativeRoots::add(void* begin, void* end, JITStubRoutineSet& jitStubRoutines)
114 {
115     genericAddSpan(begin, end, jitStubRoutines);
116 }
117
118 class CompositeMarkHook {
119 public:
120     CompositeMarkHook(JITStubRoutineSet& stubRoutines, CodeBlockSet& codeBlocks, const AbstractLocker& locker)
121         : m_stubRoutines(stubRoutines)
122         , m_codeBlocks(codeBlocks)
123         , m_codeBlocksLocker(locker)
124     {
125     }
126     
127     void mark(void* address)
128     {
129         m_stubRoutines.mark(address);
130         m_codeBlocks.mark(m_codeBlocksLocker, address);
131     }
132
133 private:
134     JITStubRoutineSet& m_stubRoutines;
135     CodeBlockSet& m_codeBlocks;
136     const AbstractLocker& m_codeBlocksLocker;
137 };
138
139 void ConservativeRoots::add(
140     void* begin, void* end, JITStubRoutineSet& jitStubRoutines, CodeBlockSet& codeBlocks)
141 {
142     LockHolder locker(codeBlocks.getLock());
143     CompositeMarkHook markHook(jitStubRoutines, codeBlocks, locker);
144     genericAddSpan(begin, end, markHook);
145 }
146
147 } // namespace JSC