1/*
2 * Copyright (C) 2014-2015 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#ifndef HeapVerifier_h
27#define HeapVerifier_h
28
29#include "Heap.h"
30#include "LiveObjectList.h"
31
32namespace JSC {
33
34class JSObject;
35class MarkedBlock;
36
37class HeapVerifier {
38 WTF_MAKE_FAST_ALLOCATED;
39public:
40 enum class Phase {
41 BeforeGC,
42 BeforeMarking,
43 AfterMarking,
44 AfterGC
45 };
46
47 HeapVerifier(Heap*, unsigned numberOfGCCyclesToRecord);
48
49 void initializeGCCycle();
50 void gatherLiveObjects(Phase);
51 void trimDeadObjects();
52 void verify(Phase);
53
54 // Scans all previously recorded LiveObjectLists and checks if the specified
55 // object was in any of those lists.
56 JS_EXPORT_PRIVATE void checkIfRecorded(JSObject*);
57
58 static const char* collectionTypeName(HeapOperation);
59 static const char* phaseName(Phase);
60
61private:
62 struct GCCycle {
63 GCCycle()
64 : before("Before Marking")
65 , after("After Marking")
66 {
67 }
68
69 HeapOperation collectionType;
70 LiveObjectList before;
71 LiveObjectList after;
72
73 const char* collectionTypeName() const
74 {
75 return HeapVerifier::collectionTypeName(collectionType);
76 }
77 };
78
79 void incrementCycle() { m_currentCycle = (m_currentCycle + 1) % m_numberOfCycles; }
80 GCCycle& currentCycle() { return m_cycles[m_currentCycle]; }
81 GCCycle& cycleForIndex(int cycleIndex)
82 {
83 ASSERT(cycleIndex <= 0 && cycleIndex > -m_numberOfCycles);
84 cycleIndex += m_currentCycle;
85 if (cycleIndex < 0)
86 cycleIndex += m_numberOfCycles;
87 ASSERT(cycleIndex < m_numberOfCycles);
88 return m_cycles[cycleIndex];
89 }
90
91 LiveObjectList* liveObjectListForGathering(Phase);
92 bool verifyButterflyIsInStorageSpace(Phase, LiveObjectList&);
93
94 static void reportObject(LiveObjectData&, int cycleIndex, HeapVerifier::GCCycle&, LiveObjectList&);
95
96 Heap* m_heap;
97 int m_currentCycle;
98 int m_numberOfCycles;
99 std::unique_ptr<GCCycle[]> m_cycles;
100};
101
102} // namespace JSC
103
104#endif // HeapVerifier
105