Refactored the JSC::Heap extra cost API for clarity and to make some known bugs more...
[WebKit-https.git] / Source / JavaScriptCore / heap / Heap.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, 2013-2014 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 Heap_h
23 #define Heap_h
24
25 #include "ArrayBuffer.h"
26 #include "CodeBlockSet.h"
27 #include "CopyVisitor.h"
28 #include "GCIncomingRefCountedSet.h"
29 #include "GCThreadSharedData.h"
30 #include "HandleSet.h"
31 #include "HandleStack.h"
32 #include "HeapOperation.h"
33 #include "JITStubRoutineSet.h"
34 #include "MarkedAllocator.h"
35 #include "MarkedBlock.h"
36 #include "MarkedBlockSet.h"
37 #include "MarkedSpace.h"
38 #include "Options.h"
39 #include "SlotVisitor.h"
40 #include "StructureIDTable.h"
41 #include "WeakHandleOwner.h"
42 #include "WriteBarrierBuffer.h"
43 #include "WriteBarrierSupport.h"
44 #include <wtf/HashCountedSet.h>
45 #include <wtf/HashSet.h>
46
47 namespace JSC {
48
49 class CopiedSpace;
50 class CodeBlock;
51 class ExecutableBase;
52 class EdenGCActivityCallback;
53 class FullGCActivityCallback;
54 class GCActivityCallback;
55 class GCAwareJITStubRoutine;
56 class GlobalCodeBlock;
57 class Heap;
58 class HeapRootVisitor;
59 class HeapVerifier;
60 class IncrementalSweeper;
61 class JITStubRoutine;
62 class JSCell;
63 class VM;
64 class JSStack;
65 class JSValue;
66 class LiveObjectIterator;
67 class LLIntOffsetsExtractor;
68 class MarkedArgumentBuffer;
69 class WeakGCHandlePool;
70 class SlotVisitor;
71
72 namespace DFG {
73 class Worklist;
74 }
75
76 static void* const zombifiedBits = reinterpret_cast<void*>(0xdeadbeef);
77
78 typedef std::pair<JSValue, WTF::String> ValueStringPair;
79 typedef HashCountedSet<JSCell*> ProtectCountSet;
80 typedef HashCountedSet<const char*> TypeCountSet;
81
82 enum HeapType { SmallHeap, LargeHeap };
83
84 class Heap {
85     WTF_MAKE_NONCOPYABLE(Heap);
86 public:
87     friend class JIT;
88     friend class DFG::SpeculativeJIT;
89     friend class GCThreadSharedData;
90     static Heap* heap(const JSValue); // 0 for immediate values
91     static Heap* heap(const JSCell*);
92
93     // This constant determines how many blocks we iterate between checks of our 
94     // deadline when calling Heap::isPagedOut. Decreasing it will cause us to detect 
95     // overstepping our deadline more quickly, while increasing it will cause 
96     // our scan to run faster. 
97     static const unsigned s_timeCheckResolution = 16;
98
99     static bool isLive(const void*);
100     static bool isMarked(const void*);
101     static bool testAndSetMarked(const void*);
102     static void setMarked(const void*);
103     static bool isRemembered(const void*);
104
105     JS_EXPORT_PRIVATE void addToRememberedSet(const JSCell*);
106     static bool isWriteBarrierEnabled();
107     void writeBarrier(const JSCell*);
108     void writeBarrier(const JSCell*, JSValue);
109     void writeBarrier(const JSCell*, JSCell*);
110
111     WriteBarrierBuffer& writeBarrierBuffer() { return m_writeBarrierBuffer; }
112     void flushWriteBarrierBuffer(JSCell*);
113
114     Heap(VM*, HeapType);
115     ~Heap();
116     JS_EXPORT_PRIVATE void lastChanceToFinalize();
117     void releaseDelayedReleasedObjects();
118
119     VM* vm() const { return m_vm; }
120     MarkedSpace& objectSpace() { return m_objectSpace; }
121     MachineThreads& machineThreads() { return m_machineThreads; }
122
123     const SlotVisitor& slotVisitor() const { return m_slotVisitor; }
124
125     JS_EXPORT_PRIVATE GCActivityCallback* fullActivityCallback();
126     JS_EXPORT_PRIVATE GCActivityCallback* edenActivityCallback();
127     JS_EXPORT_PRIVATE void setFullActivityCallback(PassRefPtr<FullGCActivityCallback>);
128     JS_EXPORT_PRIVATE void setEdenActivityCallback(PassRefPtr<EdenGCActivityCallback>);
129     JS_EXPORT_PRIVATE void setGarbageCollectionTimerEnabled(bool);
130
131     JS_EXPORT_PRIVATE IncrementalSweeper* sweeper();
132     JS_EXPORT_PRIVATE void setIncrementalSweeper(std::unique_ptr<IncrementalSweeper>);
133
134     // true if collection is in progress
135     bool isCollecting();
136     HeapOperation operationInProgress() { return m_operationInProgress; }
137     // true if an allocation or collection is in progress
138     bool isBusy();
139     MarkedSpace::Subspace& subspaceForObjectWithoutDestructor() { return m_objectSpace.subspaceForObjectsWithoutDestructor(); }
140     MarkedSpace::Subspace& subspaceForObjectNormalDestructor() { return m_objectSpace.subspaceForObjectsWithNormalDestructor(); }
141     MarkedSpace::Subspace& subspaceForObjectsWithImmortalStructure() { return m_objectSpace.subspaceForObjectsWithImmortalStructure(); }
142     template<typename ClassType> MarkedSpace::Subspace& subspaceForObjectOfType();
143     MarkedAllocator& allocatorForObjectWithoutDestructor(size_t bytes) { return m_objectSpace.allocatorFor(bytes); }
144     MarkedAllocator& allocatorForObjectWithNormalDestructor(size_t bytes) { return m_objectSpace.normalDestructorAllocatorFor(bytes); }
145     MarkedAllocator& allocatorForObjectWithImmortalStructureDestructor(size_t bytes) { return m_objectSpace.immortalStructureDestructorAllocatorFor(bytes); }
146     template<typename ClassType> MarkedAllocator& allocatorForObjectOfType(size_t bytes);
147     CopiedAllocator& storageAllocator() { return m_storageSpace.allocator(); }
148     CheckedBoolean tryAllocateStorage(JSCell* intendedOwner, size_t, void**);
149     CheckedBoolean tryReallocateStorage(JSCell* intendedOwner, void**, size_t, size_t);
150     void ascribeOwner(JSCell* intendedOwner, void*);
151
152     typedef void (*Finalizer)(JSCell*);
153     JS_EXPORT_PRIVATE void addFinalizer(JSCell*, Finalizer);
154     void addCompiledCode(ExecutableBase*);
155
156     void notifyIsSafeToCollect() { m_isSafeToCollect = true; }
157     bool isSafeToCollect() const { return m_isSafeToCollect; }
158
159     JS_EXPORT_PRIVATE void collectAllGarbage();
160     bool shouldCollect();
161     JS_EXPORT_PRIVATE void collect(HeapOperation collectionType = AnyCollection);
162     bool collectIfNecessaryOrDefer(); // Returns true if it did collect.
163
164     // Use this API to report non-GC memory referenced by GC objects. Be sure to
165     // call both of these functions: Calling only one may trigger catastropic
166     // memory growth.
167     void reportExtraMemoryAllocated(size_t);
168     void reportExtraMemoryVisited(JSCell*, size_t);
169
170     // Use this API to report non-GC memory if you can't use the better API above.
171     void deprecatedReportExtraMemory(size_t);
172
173     JS_EXPORT_PRIVATE void reportAbandonedObjectGraph();
174
175     JS_EXPORT_PRIVATE void protect(JSValue);
176     JS_EXPORT_PRIVATE bool unprotect(JSValue); // True when the protect count drops to 0.
177     
178     size_t extraMemorySize(); // Non-GC memory referenced by GC objects.
179     JS_EXPORT_PRIVATE size_t size();
180     JS_EXPORT_PRIVATE size_t capacity();
181     JS_EXPORT_PRIVATE size_t objectCount();
182     JS_EXPORT_PRIVATE size_t globalObjectCount();
183     JS_EXPORT_PRIVATE size_t protectedObjectCount();
184     JS_EXPORT_PRIVATE size_t protectedGlobalObjectCount();
185     JS_EXPORT_PRIVATE std::unique_ptr<TypeCountSet> protectedObjectTypeCounts();
186     JS_EXPORT_PRIVATE std::unique_ptr<TypeCountSet> objectTypeCounts();
187     void showStatistics();
188
189     void pushTempSortVector(Vector<ValueStringPair, 0, UnsafeVectorOverflow>*);
190     void popTempSortVector(Vector<ValueStringPair, 0, UnsafeVectorOverflow>*);
191
192     HashSet<MarkedArgumentBuffer*>& markListSet();
193     
194     template<typename Functor> typename Functor::ReturnType forEachProtectedCell(Functor&);
195     template<typename Functor> typename Functor::ReturnType forEachProtectedCell();
196     template<typename Functor> void forEachCodeBlock(Functor&);
197
198     HandleSet* handleSet() { return &m_handleSet; }
199     HandleStack* handleStack() { return &m_handleStack; }
200
201     void willStartIterating();
202     void didFinishIterating();
203     void getConservativeRegisterRoots(HashSet<JSCell*>& roots);
204
205     double lastFullGCLength() const { return m_lastFullGCLength; }
206     double lastEdenGCLength() const { return m_lastEdenGCLength; }
207     void increaseLastFullGCLength(double amount) { m_lastFullGCLength += amount; }
208
209     size_t sizeBeforeLastEdenCollection() const { return m_sizeBeforeLastEdenCollect; }
210     size_t sizeAfterLastEdenCollection() const { return m_sizeAfterLastEdenCollect; }
211     size_t sizeBeforeLastFullCollection() const { return m_sizeBeforeLastFullCollect; }
212     size_t sizeAfterLastFullCollection() const { return m_sizeAfterLastFullCollect; }
213
214     JS_EXPORT_PRIVATE void deleteAllCompiledCode();
215     void deleteAllUnlinkedFunctionCode();
216
217     void didAllocate(size_t);
218     void didAbandon(size_t);
219
220     bool isPagedOut(double deadline);
221     
222     const JITStubRoutineSet& jitStubRoutines() { return m_jitStubRoutines; }
223     
224     void addReference(JSCell*, ArrayBuffer*);
225     
226     bool isDeferred() const { return !!m_deferralDepth || Options::disableGC(); }
227
228     StructureIDTable& structureIDTable() { return m_structureIDTable; }
229
230 #if USE(CF)
231         template<typename T> void releaseSoon(RetainPtr<T>&&);
232 #endif
233
234     void removeCodeBlock(CodeBlock* cb) { m_codeBlocks.remove(cb); }
235
236     static bool isZombified(JSCell* cell) { return *(void**)cell == zombifiedBits; }
237
238     void registerWeakGCMap(void* weakGCMap, std::function<void()> pruningCallback);
239     void unregisterWeakGCMap(void* weakGCMap);
240
241 private:
242     friend class CodeBlock;
243     friend class CopiedBlock;
244     friend class DeferGC;
245     friend class DeferGCForAWhile;
246     friend class GCAwareJITStubRoutine;
247     friend class GCLogging;
248     friend class HandleSet;
249     friend class HeapVerifier;
250     friend class JITStubRoutine;
251     friend class LLIntOffsetsExtractor;
252     friend class MarkedSpace;
253     friend class MarkedAllocator;
254     friend class MarkedBlock;
255     friend class CopiedSpace;
256     friend class CopyVisitor;
257     friend class RecursiveAllocationScope;
258     friend class SlotVisitor;
259     friend class SuperRegion;
260     friend class IncrementalSweeper;
261     friend class HeapStatistics;
262     friend class VM;
263     friend class WeakSet;
264     template<typename T> friend void* allocateCell(Heap&);
265     template<typename T> friend void* allocateCell(Heap&, size_t);
266
267     void* allocateWithImmortalStructureDestructor(size_t); // For use with special objects whose Structures never die.
268     void* allocateWithNormalDestructor(size_t); // For use with objects that inherit directly or indirectly from JSDestructibleObject.
269     void* allocateWithoutDestructor(size_t); // For use with objects without destructors.
270     template<typename ClassType> void* allocateObjectOfType(size_t); // Chooses one of the methods above based on type.
271
272     static const size_t minExtraMemory = 256;
273     
274     class FinalizerOwner : public WeakHandleOwner {
275         virtual void finalize(Handle<Unknown>, void* context) override;
276     };
277
278     JS_EXPORT_PRIVATE bool isValidAllocation(size_t);
279     JS_EXPORT_PRIVATE void reportExtraMemoryAllocatedSlowCase(size_t);
280     JS_EXPORT_PRIVATE void deprecatedReportExtraMemorySlowCase(size_t);
281
282     void collectImpl(HeapOperation, void* stackOrigin, void* stackTop, MachineThreads::RegisterState&);
283
284     void suspendCompilerThreads();
285     void willStartCollection(HeapOperation collectionType);
286     void deleteOldCode(double gcStartTime);
287     void flushOldStructureIDTables();
288     void flushWriteBarrierBuffer();
289     void stopAllocation();
290
291     void markRoots(double gcStartTime, void* stackOrigin, void* stackTop, MachineThreads::RegisterState&);
292     void gatherStackRoots(ConservativeRoots&, void* stackOrigin, void* stackTop, MachineThreads::RegisterState&);
293     void gatherJSStackRoots(ConservativeRoots&);
294     void gatherScratchBufferRoots(ConservativeRoots&);
295     void clearLivenessData();
296     void visitExternalRememberedSet();
297     void visitSmallStrings();
298     void visitConservativeRoots(ConservativeRoots&);
299     void visitCompilerWorklistWeakReferences();
300     void removeDeadCompilerWorklistEntries();
301     void visitProtectedObjects(HeapRootVisitor&);
302     void visitTempSortVectors(HeapRootVisitor&);
303     void visitArgumentBuffers(HeapRootVisitor&);
304     void visitException(HeapRootVisitor&);
305     void visitStrongHandles(HeapRootVisitor&);
306     void visitHandleStack(HeapRootVisitor&);
307     void traceCodeBlocksAndJITStubRoutines();
308     void converge();
309     void visitWeakHandles(HeapRootVisitor&);
310     void clearRememberedSet(Vector<const JSCell*>&);
311     void updateObjectCounts(double gcStartTime);
312     void resetVisitors();
313
314     void reapWeakHandles();
315     void pruneStaleEntriesFromWeakGCMaps();
316     void sweepArrayBuffers();
317     void snapshotMarkedSpace();
318     void deleteSourceProviderCaches();
319     void notifyIncrementalSweeper();
320     void rememberCurrentlyExecutingCodeBlocks();
321     void resetAllocators();
322     void copyBackingStores();
323     void harvestWeakReferences();
324     void finalizeUnconditionalFinalizers();
325     void clearUnmarkedExecutables();
326     void deleteUnmarkedCompiledCode();
327     void updateAllocationLimits();
328     void didFinishCollection(double gcStartTime);
329     void resumeCompilerThreads();
330     void zombifyDeadObjects();
331     void markDeadObjects();
332
333     bool shouldDoFullCollection(HeapOperation requestedCollectionType) const;
334     size_t sizeAfterCollect();
335
336     JSStack& stack();
337     
338     void incrementDeferralDepth();
339     void decrementDeferralDepth();
340     void decrementDeferralDepthAndGCIfNeeded();
341
342     const HeapType m_heapType;
343     const size_t m_ramSize;
344     const size_t m_minBytesPerCycle;
345     size_t m_sizeAfterLastCollect;
346     size_t m_sizeAfterLastFullCollect;
347     size_t m_sizeBeforeLastFullCollect;
348     size_t m_sizeAfterLastEdenCollect;
349     size_t m_sizeBeforeLastEdenCollect;
350
351     size_t m_bytesAllocatedThisCycle;
352     size_t m_bytesAbandonedSinceLastFullCollect;
353     size_t m_maxEdenSize;
354     size_t m_maxHeapSize;
355     bool m_shouldDoFullCollection;
356     size_t m_totalBytesVisited;
357     size_t m_totalBytesCopied;
358     
359     HeapOperation m_operationInProgress;
360     StructureIDTable m_structureIDTable;
361     MarkedSpace m_objectSpace;
362     CopiedSpace m_storageSpace;
363     GCIncomingRefCountedSet<ArrayBuffer> m_arrayBuffers;
364     size_t m_extraMemorySize;
365     size_t m_deprecatedExtraMemorySize;
366
367     HashSet<const JSCell*> m_copyingRememberedSet;
368
369     ProtectCountSet m_protectedValues;
370     Vector<Vector<ValueStringPair, 0, UnsafeVectorOverflow>*> m_tempSortingVectors;
371     std::unique_ptr<HashSet<MarkedArgumentBuffer*>> m_markListSet;
372
373     MachineThreads m_machineThreads;
374     
375     GCThreadSharedData m_sharedData;
376     SlotVisitor m_slotVisitor;
377     CopyVisitor m_copyVisitor;
378
379     HandleSet m_handleSet;
380     HandleStack m_handleStack;
381     CodeBlockSet m_codeBlocks;
382     JITStubRoutineSet m_jitStubRoutines;
383     FinalizerOwner m_finalizerOwner;
384     
385     bool m_isSafeToCollect;
386
387     WriteBarrierBuffer m_writeBarrierBuffer;
388
389     VM* m_vm;
390     double m_lastFullGCLength;
391     double m_lastEdenGCLength;
392     double m_lastCodeDiscardTime;
393
394     Vector<ExecutableBase*> m_compiledCode;
395     
396     RefPtr<GCActivityCallback> m_fullActivityCallback;
397     RefPtr<GCActivityCallback> m_edenActivityCallback;
398     std::unique_ptr<IncrementalSweeper> m_sweeper;
399     Vector<MarkedBlock*> m_blockSnapshot;
400     
401     unsigned m_deferralDepth;
402     Vector<DFG::Worklist*> m_suspendedCompilerWorklists;
403
404     std::unique_ptr<HeapVerifier> m_verifier;
405 #if USE(CF)
406     Vector<RetainPtr<CFTypeRef>> m_delayedReleaseObjects;
407     unsigned m_delayedReleaseRecursionCount;
408 #endif
409
410     HashMap<void*, std::function<void()>> m_weakGCMaps;
411 };
412
413 } // namespace JSC
414
415 #endif // Heap_h