3a99cc4ea20d47b163edc2ab29d6cf101c4b326a
[WebKit-https.git] / Source / JavaScriptCore / profiler / LegacyProfiler.cpp
1 /*
2  * Copyright (C) 2008, 2012, 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  *
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 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 #include "config.h"
30 #include "LegacyProfiler.h"
31
32 #include "CallFrame.h"
33 #include "CodeBlock.h"
34 #include "CommonIdentifiers.h"
35 #include "DebuggerCallFrame.h"
36 #include "InternalFunction.h"
37 #include "JSFunction.h"
38 #include "JSGlobalObject.h"
39 #include "Nodes.h"
40 #include "JSCInlines.h"
41 #include "Profile.h"
42 #include "ProfileGenerator.h"
43 #include "ProfileNode.h"
44
45 namespace JSC {
46
47 static const char* GlobalCodeExecution = "(program)";
48 static const char* AnonymousFunction = "(anonymous function)";
49 static unsigned ProfilesUID = 0;
50
51 static CallIdentifier createCallIdentifierFromFunctionImp(ExecState*, JSObject*, const String& defaultSourceURL, unsigned defaultLineNumber, unsigned defaultColumnNumber);
52
53 LegacyProfiler* LegacyProfiler::s_sharedLegacyProfiler = 0;
54
55 LegacyProfiler* LegacyProfiler::profiler()
56 {
57     if (!s_sharedLegacyProfiler)
58         s_sharedLegacyProfiler = new LegacyProfiler();
59     return s_sharedLegacyProfiler;
60 }   
61
62 void LegacyProfiler::startProfiling(ExecState* exec, const String& title)
63 {
64     if (!exec)
65         return;
66
67     // Check if we currently have a Profile for this global ExecState and title.
68     // If so return early and don't create a new Profile.
69     JSGlobalObject* origin = exec->lexicalGlobalObject();
70
71     for (size_t i = 0; i < m_currentProfiles.size(); ++i) {
72         ProfileGenerator* profileGenerator = m_currentProfiles[i].get();
73         if (profileGenerator->origin() == origin && profileGenerator->title() == title)
74             return;
75     }
76
77     exec->vm().setEnabledProfiler(this);
78     RefPtr<ProfileGenerator> profileGenerator = ProfileGenerator::create(exec, title, ++ProfilesUID);
79     m_currentProfiles.append(profileGenerator);
80 }
81
82 PassRefPtr<Profile> LegacyProfiler::stopProfiling(ExecState* exec, const String& title)
83 {
84     if (!exec)
85         return 0;
86
87     JSGlobalObject* origin = exec->lexicalGlobalObject();
88     for (ptrdiff_t i = m_currentProfiles.size() - 1; i >= 0; --i) {
89         ProfileGenerator* profileGenerator = m_currentProfiles[i].get();
90         if (profileGenerator->origin() == origin && (title.isNull() || profileGenerator->title() == title)) {
91             profileGenerator->stopProfiling();
92             RefPtr<Profile> returnProfile = profileGenerator->profile();
93
94             m_currentProfiles.remove(i);
95             if (!m_currentProfiles.size())
96                 exec->vm().setEnabledProfiler(nullptr);
97             
98             return returnProfile;
99         }
100     }
101
102     return 0;
103 }
104
105 void LegacyProfiler::stopProfiling(JSGlobalObject* origin)
106 {
107     for (ptrdiff_t i = m_currentProfiles.size() - 1; i >= 0; --i) {
108         ProfileGenerator* profileGenerator = m_currentProfiles[i].get();
109         if (profileGenerator->origin() == origin) {
110             profileGenerator->stopProfiling();
111             m_currentProfiles.remove(i);
112             if (!m_currentProfiles.size())
113                 origin->vm().setEnabledProfiler(nullptr);
114         }
115     }
116 }
117
118 static inline void callFunctionForProfilesWithGroup(std::function<void(ProfileGenerator*)> callback, const Vector<RefPtr<ProfileGenerator>>& profiles, unsigned targetProfileGroup)
119 {
120     for (const RefPtr<ProfileGenerator>& profile : profiles) {
121         if (profile->profileGroup() == targetProfileGroup || !profile->origin())
122             callback(profile.get());
123     }
124 }
125
126 void LegacyProfiler::willExecute(ExecState* callerCallFrame, JSValue function)
127 {
128     ASSERT(!m_currentProfiles.isEmpty());
129
130     CallIdentifier callIdentifier = createCallIdentifier(callerCallFrame, function, StringImpl::empty(), 0, 0);
131
132     callFunctionForProfilesWithGroup(std::bind(&ProfileGenerator::willExecute, std::placeholders::_1, callerCallFrame, callIdentifier), m_currentProfiles, callerCallFrame->lexicalGlobalObject()->profileGroup());
133 }
134
135 void LegacyProfiler::willExecute(ExecState* callerCallFrame, const String& sourceURL, unsigned startingLineNumber, unsigned startingColumnNumber)
136 {
137     ASSERT(!m_currentProfiles.isEmpty());
138
139     CallIdentifier callIdentifier = createCallIdentifier(callerCallFrame, JSValue(), sourceURL, startingLineNumber, startingColumnNumber);
140
141     callFunctionForProfilesWithGroup(std::bind(&ProfileGenerator::willExecute, std::placeholders::_1, callerCallFrame, callIdentifier), m_currentProfiles, callerCallFrame->lexicalGlobalObject()->profileGroup());
142 }
143
144 void LegacyProfiler::didExecute(ExecState* callerCallFrame, JSValue function)
145 {
146     ASSERT(!m_currentProfiles.isEmpty());
147
148     CallIdentifier callIdentifier = createCallIdentifier(callerCallFrame, function, StringImpl::empty(), 0, 0);
149
150     callFunctionForProfilesWithGroup(std::bind(&ProfileGenerator::didExecute, std::placeholders::_1, callerCallFrame, callIdentifier), m_currentProfiles, callerCallFrame->lexicalGlobalObject()->profileGroup());
151 }
152
153 void LegacyProfiler::didExecute(ExecState* callerCallFrame, const String& sourceURL, unsigned startingLineNumber, unsigned startingColumnNumber)
154 {
155     ASSERT(!m_currentProfiles.isEmpty());
156
157     CallIdentifier callIdentifier = createCallIdentifier(callerCallFrame, JSValue(), sourceURL, startingLineNumber, startingColumnNumber);
158
159     callFunctionForProfilesWithGroup(std::bind(&ProfileGenerator::didExecute, std::placeholders::_1, callerCallFrame, callIdentifier), m_currentProfiles, callerCallFrame->lexicalGlobalObject()->profileGroup());
160 }
161
162 void LegacyProfiler::exceptionUnwind(ExecState* handlerCallFrame)
163 {
164     ASSERT(!m_currentProfiles.isEmpty());
165
166     CallIdentifier callIdentifier = createCallIdentifier(handlerCallFrame, JSValue(), StringImpl::empty(), 0, 0);
167
168     callFunctionForProfilesWithGroup(std::bind(&ProfileGenerator::exceptionUnwind, std::placeholders::_1, handlerCallFrame, callIdentifier), m_currentProfiles, handlerCallFrame->lexicalGlobalObject()->profileGroup());
169 }
170
171 void LegacyProfiler::didPause(PassRefPtr<DebuggerCallFrame> prpCallFrame)
172 {
173     if (m_currentProfiles.isEmpty())
174         return;
175
176     RefPtr<DebuggerCallFrame> callFrame = prpCallFrame;
177     CallIdentifier callIdentifier = createCallIdentifier(callFrame->exec(), JSValue(), StringImpl::empty(), 0, 0);
178
179     callFunctionForProfilesWithGroup(std::bind(&ProfileGenerator::didPause, std::placeholders::_1, callFrame, callIdentifier), m_currentProfiles, callFrame->vmEntryGlobalObject()->profileGroup());
180 }
181
182 void LegacyProfiler::didContinue(PassRefPtr<DebuggerCallFrame> prpCallFrame)
183 {
184     if (m_currentProfiles.isEmpty())
185         return;
186
187     RefPtr<DebuggerCallFrame> callFrame = prpCallFrame;
188     CallIdentifier callIdentifier = createCallIdentifier(callFrame->exec(), JSValue(), StringImpl::empty(), 0, 0);
189
190     callFunctionForProfilesWithGroup(std::bind(&ProfileGenerator::didContinue, std::placeholders::_1, callFrame, callIdentifier), m_currentProfiles, callFrame->vmEntryGlobalObject()->profileGroup());
191 }
192
193 CallIdentifier LegacyProfiler::createCallIdentifier(ExecState* exec, JSValue functionValue, const String& defaultSourceURL, unsigned defaultLineNumber, unsigned defaultColumnNumber)
194 {
195     if (!functionValue)
196         return CallIdentifier(ASCIILiteral(GlobalCodeExecution), defaultSourceURL, defaultLineNumber, defaultColumnNumber);
197     if (!functionValue.isObject())
198         return CallIdentifier(ASCIILiteral("(unknown)"), defaultSourceURL, defaultLineNumber, defaultColumnNumber);
199     if (asObject(functionValue)->inherits(JSFunction::info()) || asObject(functionValue)->inherits(InternalFunction::info()))
200         return createCallIdentifierFromFunctionImp(exec, asObject(functionValue), defaultSourceURL, defaultLineNumber, defaultColumnNumber);
201     if (asObject(functionValue)->inherits(JSCallee::info()))
202         return CallIdentifier(ASCIILiteral(GlobalCodeExecution), defaultSourceURL, defaultLineNumber, defaultColumnNumber);
203     return CallIdentifier(asObject(functionValue)->methodTable()->className(asObject(functionValue)), defaultSourceURL, defaultLineNumber, defaultColumnNumber);
204 }
205
206 CallIdentifier createCallIdentifierFromFunctionImp(ExecState* exec, JSObject* function, const String& defaultSourceURL, unsigned defaultLineNumber, unsigned defaultColumnNumber)
207 {
208     const String& name = getCalculatedDisplayName(exec, function);
209     JSFunction* jsFunction = jsDynamicCast<JSFunction*>(function);
210     if (jsFunction && !jsFunction->isHostOrBuiltinFunction())
211         return CallIdentifier(name.isEmpty() ? ASCIILiteral(AnonymousFunction) : name, jsFunction->jsExecutable()->sourceURL(), jsFunction->jsExecutable()->lineNo(), jsFunction->jsExecutable()->startColumn());
212     return CallIdentifier(name.isEmpty() ? ASCIILiteral(AnonymousFunction) : name, defaultSourceURL, defaultLineNumber, defaultColumnNumber);
213 }
214
215 } // namespace JSC