Web Inspector: partially instrument DOM Tree native memory.
[WebKit-https.git] / Source / WebCore / dom / MemoryInstrumentation.h
1 /*
2  * Copyright (C) 2012 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef MemoryInstrumentation_h
32 #define MemoryInstrumentation_h
33
34 #include <wtf/OwnPtr.h>
35 #include <wtf/RefPtr.h>
36
37 namespace WebCore {
38
39 class MemoryObjectInfo;
40
41 class MemoryInstrumentation {
42 public:
43     virtual ~MemoryInstrumentation() { }
44
45     enum ObjectType {
46         Other,
47         DOM,
48         CSS,
49         LastTypeEntry
50     };
51
52     template <typename T> void reportInstrumentedObject(const T&);
53     template <typename T> void reportObject(const T&) { }
54     template <typename T> void reportInstrumentedPointer(const T*);
55     template <typename T> void reportPointer(const T* object, ObjectType objectType)
56     {
57         if (!object || visited(object))
58             return;
59         countObjectSize(objectType, sizeof(T));
60     }
61
62 private:
63     friend class MemoryObjectInfo;
64
65     virtual void countObjectSize(ObjectType, size_t) = 0;
66     virtual bool visited(const void*) = 0;
67 };
68
69 class MemoryObjectInfo {
70 public:
71     MemoryObjectInfo(MemoryInstrumentation* memoryInstrumentation)
72         : m_memoryInstrumentation(memoryInstrumentation)
73         , m_objectType(MemoryInstrumentation::Other)
74         , m_objectSize(0)
75      { }
76
77     template <typename P>
78     void reportInstrumentedPointer(const P* memberPointer)
79     {
80         m_memoryInstrumentation->reportInstrumentedPointer(memberPointer);
81     }
82
83     template <typename P>
84     void reportPointer(const P* pointer, MemoryInstrumentation::ObjectType objectType)
85     {
86         m_memoryInstrumentation->reportPointer(pointer, objectType);
87     }
88
89     template <typename T>
90     void reportInstrumentedObject(const T& memberObject)
91     {
92         m_memoryInstrumentation->reportInstrumentedObject(memberObject);
93     }
94
95     template <typename T>
96     void reportObject(const T& object) { m_memoryInstrumentation->reportObject(object); }
97
98     template <typename T>
99     void reportObjectInfo(const T*, MemoryInstrumentation::ObjectType objectType)
100     {
101         if (m_objectType != MemoryInstrumentation::Other)
102             return;
103         m_objectType = objectType;
104         m_objectSize = sizeof(T);
105     }
106
107     MemoryInstrumentation::ObjectType objectType() const { return m_objectType; }
108     size_t objectSize() const { return m_objectSize; }
109
110  private:
111     MemoryInstrumentation* m_memoryInstrumentation;
112     MemoryInstrumentation::ObjectType m_objectType;
113     size_t m_objectSize;
114 };
115
116 template <typename T>
117 void MemoryInstrumentation::reportInstrumentedPointer(const T* const object)
118 {
119     if (!object || visited(object))
120         return;
121     MemoryObjectInfo memoryObjectInfo(this);
122     object->reportMemoryUsage(&memoryObjectInfo);
123     countObjectSize(memoryObjectInfo.objectType(), memoryObjectInfo.objectSize());
124 }
125
126 template<typename T>
127 void MemoryInstrumentation::reportInstrumentedObject(const T& object)
128 {
129     if (visited(&object))
130         return;
131     MemoryObjectInfo memoryObjectInfo(this);
132     object.reportMemoryUsage(&memoryObjectInfo);
133 }
134
135 } // namespace WebCore
136
137 #endif // !defined(MemoryInstrumentation_h)