35f243e32e0b0a1fec2931db113f5205294f34b8
[WebKit-https.git] / Source / JavaScriptCore / tools / HeapVerifier.h
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 #pragma once
27
28 #include "CellList.h"
29 #include "Heap.h"
30
31 namespace JSC {
32
33 class JSCell;
34 class MarkedBlock;
35
36 class HeapVerifier {
37     WTF_MAKE_FAST_ALLOCATED;
38 public:
39     enum class Phase {
40         BeforeGC,
41         BeforeMarking,
42         AfterMarking,
43         AfterGC
44     };
45
46     HeapVerifier(Heap*, unsigned numberOfGCCyclesToRecord);
47
48     void initializeGCCycle();
49     void gatherLiveCells(Phase);
50     void trimDeadCells();
51     void verify(Phase);
52
53     // Scans all previously recorded CellLists and checks if the specified
54     // cell was in any of those lists.
55     JS_EXPORT_PRIVATE void checkIfRecorded(JSCell*);
56
57     static const char* phaseName(Phase);
58
59 private:
60     struct GCCycle {
61         GCCycle()
62             : before("Before Marking")
63             , after("After Marking")
64         {
65         }
66
67         CollectionScope scope;
68         CellList before;
69         CellList after;
70     };
71
72     void incrementCycle() { m_currentCycle = (m_currentCycle + 1) % m_numberOfCycles; }
73     GCCycle& currentCycle() { return m_cycles[m_currentCycle]; }
74     GCCycle& cycleForIndex(int cycleIndex)
75     {
76         ASSERT(cycleIndex <= 0 && cycleIndex > -m_numberOfCycles);
77         cycleIndex += m_currentCycle;
78         if (cycleIndex < 0)
79             cycleIndex += m_numberOfCycles;
80         ASSERT(cycleIndex < m_numberOfCycles);
81         return m_cycles[cycleIndex];
82     }
83
84     CellList* cellListForGathering(Phase);
85     bool verifyButterflyIsInStorageSpace(Phase, CellList&);
86
87     static void reportCell(CellProfile&, int cycleIndex, HeapVerifier::GCCycle&, CellList&);
88
89     Heap* m_heap;
90     int m_currentCycle;
91     int m_numberOfCycles;
92     std::unique_ptr<GCCycle[]> m_cycles;
93 };
94
95 } // namespace JSC