Web Inspector: timelines should not count time elapsed while paused in the debugger
[WebKit-https.git] / Source / JavaScriptCore / profiler / ProfileGenerator.cpp
1 /*
2  * Copyright (C) 2008, 2014 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 #include "config.h"
27 #include "ProfileGenerator.h"
28
29 #include "CallFrame.h"
30 #include "CodeBlock.h"
31 #include "JSGlobalObject.h"
32 #include "JSStringRef.h"
33 #include "JSFunction.h"
34 #include "LegacyProfiler.h"
35 #include "JSCInlines.h"
36 #include "Profile.h"
37 #include "StackVisitor.h"
38 #include "Tracing.h"
39
40 namespace JSC {
41
42 PassRefPtr<ProfileGenerator> ProfileGenerator::create(ExecState* exec, const String& title, unsigned uid, PassRefPtr<Stopwatch> stopwatch)
43 {
44     return adoptRef(new ProfileGenerator(exec, title, uid, stopwatch));
45 }
46
47 ProfileGenerator::ProfileGenerator(ExecState* exec, const String& title, unsigned uid, PassRefPtr<Stopwatch> stopwatch)
48     : m_origin(exec ? exec->lexicalGlobalObject() : nullptr)
49     , m_profileGroup(exec ? exec->lexicalGlobalObject()->profileGroup() : 0)
50     , m_stopwatch(stopwatch)
51     , m_foundConsoleStartParent(false)
52     , m_suspended(false)
53 {
54     m_profile = Profile::create(title, uid);
55     m_currentNode = m_rootNode = m_profile->rootNode();
56     if (exec)
57         addParentForConsoleStart(exec);
58 }
59
60 class AddParentForConsoleStartFunctor {
61 public:
62     AddParentForConsoleStartFunctor(ExecState* exec, RefPtr<ProfileNode>& rootNode, RefPtr<ProfileNode>& currentNode)
63         : m_exec(exec)
64         , m_hasSkippedFirstFrame(false)
65         , m_foundParent(false)
66         , m_rootNode(rootNode)
67         , m_currentNode(currentNode)
68     {
69     }
70
71     bool foundParent() const { return m_foundParent; }
72
73     StackVisitor::Status operator()(StackVisitor& visitor)
74     {
75         if (!m_hasSkippedFirstFrame) {
76             m_hasSkippedFirstFrame = true;
77             return StackVisitor::Continue;
78         }
79
80         unsigned line = 0;
81         unsigned column = 0;
82         visitor->computeLineAndColumn(line, column);
83         m_currentNode = ProfileNode::create(m_exec, LegacyProfiler::createCallIdentifier(m_exec, visitor->callee(), visitor->sourceURL(), line, column), m_rootNode.get());
84         m_currentNode->appendCall(ProfileNode::Call(currentTime()));
85         m_rootNode->spliceNode(m_currentNode.get());
86
87         m_foundParent = true;
88         return StackVisitor::Done;
89     }
90
91 private:
92     ExecState* m_exec;
93     bool m_hasSkippedFirstFrame;
94     bool m_foundParent;
95     RefPtr<ProfileNode>& m_rootNode;
96     RefPtr<ProfileNode>& m_currentNode;
97 };
98
99 void ProfileGenerator::addParentForConsoleStart(ExecState* exec)
100 {
101     AddParentForConsoleStartFunctor functor(exec, m_rootNode, m_currentNode);
102     exec->iterate(functor);
103
104     m_foundConsoleStartParent = functor.foundParent();
105 }
106
107 const String& ProfileGenerator::title() const
108 {
109     return m_profile->title();
110 }
111
112 void ProfileGenerator::beginCallEntry(ProfileNode* node, double startTime)
113 {
114     ASSERT_ARG(node, node);
115
116     if (isnan(startTime))
117         startTime = m_stopwatch->elapsedTime();
118
119     node->appendCall(ProfileNode::Call(startTime));
120 }
121
122 void ProfileGenerator::endCallEntry(ProfileNode* node)
123 {
124     ASSERT_ARG(node, node);
125
126     ProfileNode::Call& last = node->lastCall();
127     double previousElapsedTime = isnan(last.elapsedTime()) ? 0.0 : last.elapsedTime();
128     double newlyElapsedTime = m_stopwatch->elapsedTime() - last.startTime();
129     last.setElapsedTime(previousElapsedTime + newlyElapsedTime);
130 }
131
132 void ProfileGenerator::willExecute(ExecState* callerCallFrame, const CallIdentifier& callIdentifier)
133 {
134     if (JAVASCRIPTCORE_PROFILE_WILL_EXECUTE_ENABLED()) {
135         CString name = callIdentifier.functionName().utf8();
136         CString url = callIdentifier.url().utf8();
137         JAVASCRIPTCORE_PROFILE_WILL_EXECUTE(m_profileGroup, const_cast<char*>(name.data()), const_cast<char*>(url.data()), callIdentifier.lineNumber(), callIdentifier.columnNumber());
138     }
139
140     if (!m_origin)
141         return;
142
143     if (m_suspended)
144         return;
145
146     RefPtr<ProfileNode> calleeNode = nullptr;
147
148     // Find or create a node for the callee call frame.
149     for (const RefPtr<ProfileNode>& child : m_currentNode->children()) {
150         if (child->callIdentifier() == callIdentifier)
151             calleeNode = child;
152     }
153
154     if (!calleeNode) {
155         calleeNode = ProfileNode::create(callerCallFrame, callIdentifier, m_currentNode.get());
156         m_currentNode->addChild(calleeNode);
157     }
158
159     m_currentNode = calleeNode;
160     beginCallEntry(calleeNode.get());
161 }
162
163 void ProfileGenerator::didExecute(ExecState* callerCallFrame, const CallIdentifier& callIdentifier)
164 {
165     if (JAVASCRIPTCORE_PROFILE_DID_EXECUTE_ENABLED()) {
166         CString name = callIdentifier.functionName().utf8();
167         CString url = callIdentifier.url().utf8();
168         JAVASCRIPTCORE_PROFILE_DID_EXECUTE(m_profileGroup, const_cast<char*>(name.data()), const_cast<char*>(url.data()), callIdentifier.lineNumber(), callIdentifier.columnNumber());
169     }
170
171     if (!m_origin)
172         return;
173
174     if (m_suspended)
175         return;
176
177     // Make a new node if the caller node has never seen this callee call frame before.
178     // This can happen if |console.profile()| is called several frames deep in the call stack.
179     ASSERT(m_currentNode);
180     if (m_currentNode->callIdentifier() != callIdentifier) {
181         RefPtr<ProfileNode> calleeNode = ProfileNode::create(callerCallFrame, callIdentifier, m_currentNode.get());
182         beginCallEntry(calleeNode.get(), m_currentNode->lastCall().startTime());
183         endCallEntry(calleeNode.get());
184         m_currentNode->spliceNode(calleeNode.release());
185         return;
186     }
187
188     endCallEntry(m_currentNode.get());
189     m_currentNode = m_currentNode->parent();
190 }
191
192 void ProfileGenerator::exceptionUnwind(ExecState* handlerCallFrame, const CallIdentifier&)
193 {
194     // If the current node was called by the handler (==) or any
195     // more nested function (>) the we have exited early from it.
196     ASSERT(m_currentNode);
197     while (m_currentNode->callerCallFrame() >= handlerCallFrame) {
198         didExecute(m_currentNode->callerCallFrame(), m_currentNode->callIdentifier());
199         ASSERT(m_currentNode);
200     }
201 }
202
203 void ProfileGenerator::stopProfiling()
204 {
205     for (ProfileNode* node = m_currentNode.get(); node != m_profile->rootNode(); node = node->parent())
206         endCallEntry(node);
207
208     if (m_foundConsoleStartParent) {
209         removeProfileStart();
210         removeProfileEnd();
211     }
212
213     ASSERT(m_currentNode);
214
215     // Set the current node to the parent, because we are in a call that
216     // will not get didExecute call.
217     m_currentNode = m_currentNode->parent();
218 }
219
220 // The console.profile that started this ProfileGenerator will be the first child.
221 void ProfileGenerator::removeProfileStart()
222 {
223     ProfileNode* currentNode = nullptr;
224     for (ProfileNode* next = m_rootNode.get(); next; next = next->firstChild())
225         currentNode = next;
226
227     if (currentNode->callIdentifier().functionName() != "profile")
228         return;
229
230     currentNode->parent()->removeChild(currentNode);
231 }
232
233 // The console.profileEnd that stopped this ProfileGenerator will be the last child.
234 void ProfileGenerator::removeProfileEnd()
235 {
236     ProfileNode* currentNode = nullptr;
237     for (ProfileNode* next = m_rootNode.get(); next; next = next->lastChild())
238         currentNode = next;
239
240     if (currentNode->callIdentifier().functionName() != "profileEnd")
241         return;
242
243     ASSERT(currentNode->callIdentifier() == (currentNode->parent()->children()[currentNode->parent()->children().size() - 1])->callIdentifier());
244     currentNode->parent()->removeChild(currentNode);
245 }
246
247 } // namespace JSC