Use member function pointers for the Profile::forEach function.
[WebKit-https.git] / JavaScriptCore / profiler / ProfileNode.h
1 /*
2  * Copyright (C) 2008 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef ProfileNode_h
30 #define ProfileNode_h
31
32 #include <kjs/ustring.h>
33 #include <wtf/Vector.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/RefPtr.h>
36
37 namespace KJS {
38
39     class ProfileNode;
40
41     typedef Vector<RefPtr<ProfileNode> >::const_iterator StackIterator;
42     typedef HashCountedSet<UString::Rep*> FunctionCallHashCount;
43
44     struct CallIdentifier {
45         UString name;
46         UString url;
47         unsigned lineNumber;
48         
49         CallIdentifier(UString name, UString url, int lineNumber)
50             : name(name)
51             , url(url)
52             , lineNumber(lineNumber)
53         {
54         }
55
56         CallIdentifier(const CallIdentifier& ci)
57             : name(ci.name)
58             , url(ci.url)
59             , lineNumber(ci.lineNumber)
60         {
61         }
62
63         inline bool operator==(const CallIdentifier& ci) const { return ci.lineNumber == lineNumber && ci.name == name && ci.url == url; }
64         inline bool operator!=(const CallIdentifier& ci) const { return !(*this == ci); }
65
66 #ifndef NDEBUG
67         operator const char* () const { return name.UTF8String().c_str(); }
68         const char* toString() const { return *this; }
69 #endif
70     };
71
72     class ProfileNode : public RefCounted<ProfileNode> {
73     public:
74         static PassRefPtr<ProfileNode> create(const CallIdentifier& callIdentifier, ProfileNode* headNode, ProfileNode* parentNode) {
75             return adoptRef(new ProfileNode(callIdentifier, headNode, parentNode)); }
76
77         ProfileNode* willExecute(const CallIdentifier&);
78         ProfileNode* didExecute();
79
80         void stopProfiling();
81
82         const CallIdentifier& callIdentifier() const { return m_callIdentifier; }
83         ProfileNode* parent() const { return m_parent; }
84         void setParent(ProfileNode* parent) { m_parent = parent; }
85         ProfileNode* nextSibling() const { return m_nextSibling; }
86         void setNextSibling(ProfileNode* nextSibling) { m_nextSibling = nextSibling; }
87         UString functionName() const { return m_callIdentifier.name; }
88         UString url() const { return m_callIdentifier.url; }
89         unsigned lineNumber() const { return m_callIdentifier.lineNumber; }
90
91         double startTime() const { return m_startTime; }
92         void setStartTime(double startTime) { m_startTime = startTime; }
93         double totalTime() const { return m_visibleTotalTime; }
94         void setTotalTime(double time) { m_actualTotalTime = time; m_visibleTotalTime = time; }
95         void setActualTotalTime(double time) { m_actualTotalTime = time; }
96         void setVisibleTotalTime(double time) { m_visibleTotalTime = time; }
97         double selfTime() const { return m_visibleSelfTime; }
98         void setSelfTime(double time) {m_actualSelfTime = time; m_visibleSelfTime = time; }
99         void setActualSelfTime(double time) { m_actualSelfTime = time; }
100         void setVisibleSelfTime(double time) { m_visibleSelfTime = time; }
101
102         double totalPercent() const { return (m_visibleTotalTime / (m_head ? m_head->totalTime() : totalTime())) * 100.0; }
103         double selfPercent() const { return (m_visibleSelfTime / (m_head ? m_head->totalTime() : totalTime())) * 100.0; }
104
105         unsigned numberOfCalls() const { return m_numberOfCalls; }
106         void setNumberOfCalls(unsigned number) { m_numberOfCalls = number; }
107
108         const Vector<RefPtr<ProfileNode> >& children() const { return m_children; }
109         ProfileNode* firstChild() const { return m_children.size() ? m_children.first().get() : 0; }
110         ProfileNode* lastChild() const { return m_children.size() ? m_children.last().get() : 0; }
111         void removeChild(unsigned index) { m_children.remove(index); }
112         void addChild(PassRefPtr<ProfileNode> prpChild);
113         void insertNode(PassRefPtr<ProfileNode> prpNode);
114
115         bool visible() const { return m_visible; }
116         void setVisible(bool visible) { m_visible = visible; }
117
118         static void setTreeVisible(ProfileNode*, bool visible);
119
120         ProfileNode* traverseNextNodePostOrder() const;
121         ProfileNode* traverseNextNodePreOrder(bool processChildren = true) const;
122         
123         void sort(bool (*)(const RefPtr<ProfileNode>&, const RefPtr<ProfileNode>&));
124         void sortTotalTimeDescending() { sort(totalTimeDescendingComparator); }
125         void sortTotalTimeAscending() { sort(totalTimeAscendingComparator); }
126         void sortSelfTimeDescending() { sort(selfTimeDescendingComparator); }
127         void sortSelfTimeAscending() { sort(selfTimeAscendingComparator); }
128         void sortCallsDescending() { sort(callsDescendingComparator); }
129         void sortCallsAscending() { sort(callsAscendingComparator); }
130         void sortFunctionNameDescending() { sort(functionNameDescendingComparator); }
131         void sortFunctionNameAscending() { sort(functionNameAscendingComparator); }
132
133         void calculateVisibleTotalTime();
134         bool focus(const CallIdentifier&);
135         void exclude(const CallIdentifier&);
136         void restore();
137
138         void endAndRecordCall();
139
140 #ifndef NDEBUG
141         const char* toString() const { return m_callIdentifier; }
142         void debugPrintData(int indentLevel) const;
143         double debugPrintDataSampleStyle(int indentLevel, FunctionCallHashCount&) const;
144 #endif
145     private:
146         ProfileNode(const CallIdentifier&, ProfileNode* headNode, ProfileNode* parentNode);
147         void startTimer();
148         void resetChildrensSiblings();
149         RefPtr<ProfileNode>* childrenBegin() { return m_children.begin(); }
150         RefPtr<ProfileNode>* childrenEnd() { return m_children.end(); }
151
152         // Sorting comparators
153         static inline bool totalTimeDescendingComparator(const RefPtr<ProfileNode>& a, const RefPtr<ProfileNode>& b) { return a->totalTime() > b->totalTime(); }
154         static inline bool totalTimeAscendingComparator(const RefPtr<ProfileNode>& a, const RefPtr<ProfileNode>& b) { return a->totalTime() < b->totalTime(); }
155         static inline bool selfTimeDescendingComparator(const RefPtr<ProfileNode>& a, const RefPtr<ProfileNode>& b) { return a->selfTime() > b->selfTime(); }
156         static inline bool selfTimeAscendingComparator(const RefPtr<ProfileNode>& a, const RefPtr<ProfileNode>& b) { return a->selfTime() < b->selfTime(); }
157         static inline bool callsDescendingComparator(const RefPtr<ProfileNode>& a, const RefPtr<ProfileNode>& b) { return a->numberOfCalls() > b->numberOfCalls(); }
158         static inline bool callsAscendingComparator(const RefPtr<ProfileNode>& a, const RefPtr<ProfileNode>& b) { return a->numberOfCalls() < b->numberOfCalls(); }
159         static inline bool functionNameDescendingComparator(const RefPtr<ProfileNode>& a, const RefPtr<ProfileNode>& b) { return a->functionName() > b->functionName(); }
160         static inline bool functionNameAscendingComparator(const RefPtr<ProfileNode>& a, const RefPtr<ProfileNode>& b) { return a->functionName() < b->functionName(); }
161
162         CallIdentifier m_callIdentifier;
163         ProfileNode* m_head;
164         ProfileNode* m_parent;
165         ProfileNode* m_nextSibling;
166
167         double m_startTime;
168         double m_actualTotalTime;
169         double m_visibleTotalTime;
170         double m_actualSelfTime;
171         double m_visibleSelfTime;
172         unsigned m_numberOfCalls;
173
174         bool m_visible;
175
176         Vector<RefPtr<ProfileNode> > m_children;
177     };
178
179 } // namespace KJS
180
181 #endif // ProfileNode_h