60d82845705d2be1c1a3b9546f416374a3889b60
[WebKit.git] / Source / JavaScriptCore / heap / HeapSnapshot.h
1 /*
2  * Copyright (C) 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. ``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 "HeapSnapshotBuilder.h"
29 #include "TinyBloomFilter.h"
30 #include <wtf/Optional.h>
31
32 namespace JSC {
33
34 class HeapSnapshot {
35     WTF_MAKE_FAST_ALLOCATED;
36 public:
37     HeapSnapshot(HeapSnapshot*);
38     ~HeapSnapshot();
39
40     HeapSnapshot* previous() const { return m_previous; }
41
42     void appendNode(const HeapSnapshotNode&);
43     void sweepCell(JSCell*);
44     void shrinkToFit();
45     void finalize();
46
47     bool isEmpty() const { return m_nodes.isEmpty(); }
48     Optional<HeapSnapshotNode> nodeForCell(JSCell*);
49     Optional<HeapSnapshotNode> nodeForObjectIdentifier(unsigned objectIdentifier);
50
51 private:
52     friend class HeapSnapshotBuilder;
53     static const intptr_t CellToSweepTag = 1;
54
55     Vector<HeapSnapshotNode> m_nodes;
56     TinyBloomFilter m_filter;
57     HeapSnapshot* m_previous { nullptr };
58     unsigned m_firstObjectIdentifier { 0 };
59     unsigned m_lastObjectIdentifier { 0 };
60     bool m_finalized { false };
61     bool m_hasCellsToSweep { false };
62 };
63
64 } // namespace JSC