Make the HeapVerifier useful again.
[WebKit-https.git] / Source / JavaScriptCore / tools / HeapVerifier.h
1 /*
2  * Copyright (C) 2014-2017 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 "CellList.h"
29 #include "Heap.h"
30 #include <wtf/MonotonicTime.h>
31
32 namespace JSC {
33
34 class JSCell;
35 class MarkedBlock;
36
37 class HeapVerifier {
38     WTF_MAKE_FAST_ALLOCATED;
39 public:
40     enum class Phase {
41         BeforeGC,
42         BeforeMarking,
43         AfterMarking,
44         AfterGC
45     };
46
47     HeapVerifier(Heap*, unsigned numberOfGCCyclesToRecord);
48
49     void startGC();
50     void endGC();
51
52     void gatherLiveCells(Phase);
53     void trimDeadCells();
54     void verify(Phase);
55
56     static const char* phaseName(Phase);
57     
58     // Scans all previously recorded CellLists and checks if the specified
59     // cell was in any of those lists.
60     JS_EXPORT_PRIVATE static void checkIfRecorded(uintptr_t maybeCell);
61
62     // Returns false if anything is found to be inconsistent/incorrect about the specified cell.
63     JS_EXPORT_PRIVATE static bool validateCell(HeapCell*, VM* expectedVM = nullptr);
64
65 private:
66     struct GCCycle {
67         GCCycle()
68             : before("Before Marking")
69             , after("After Marking")
70         {
71         }
72
73         void reset()
74         {
75             before.reset();
76             after.reset();
77         }
78
79         CollectionScope scope;
80         MonotonicTime timestamp;
81         CellList before;
82         CellList after;
83     };
84
85     void incrementCycle() { m_currentCycle = (m_currentCycle + 1) % m_numberOfCycles; }
86     GCCycle& currentCycle() { return m_cycles[m_currentCycle]; }
87     GCCycle& cycleForIndex(int cycleIndex)
88     {
89         ASSERT(cycleIndex <= 0 && cycleIndex > -m_numberOfCycles);
90         cycleIndex += m_currentCycle;
91         if (cycleIndex < 0)
92             cycleIndex += m_numberOfCycles;
93         ASSERT(cycleIndex < m_numberOfCycles);
94         return m_cycles[cycleIndex];
95     }
96
97     CellList* cellListForGathering(Phase);
98     bool verifyCellList(Phase, CellList&);
99     static bool validateJSCell(VM* expectedVM, JSCell*, CellProfile*, CellList*, std::function<void()> printHeaderIfNeeded, const char* prefix = "");
100
101     void printVerificationHeader();
102
103     void checkIfRecorded(HeapCell* maybeHeapCell);
104     void reportCell(CellProfile&, int cycleIndex, HeapVerifier::GCCycle&, CellList&, const char* prefix = nullptr);
105
106     Heap* m_heap;
107     int m_currentCycle;
108     int m_numberOfCycles;
109     bool m_didPrintLogs { false };
110     std::unique_ptr<GCCycle[]> m_cycles;
111 };
112
113 } // namespace JSC