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#include "config.h"
30#include "Profiler.h"
31
32#include "CommonIdentifiers.h"
33#include "CallFrame.h"
34#include "CodeBlock.h"
35#include "InternalFunction.h"
36#include "JSFunction.h"
37#include "JSGlobalObject.h"
38#include "Nodes.h"
39#include "Profile.h"
40#include "ProfileGenerator.h"
41#include "ProfileNode.h"
42#include "UStringConcatenate.h"
43#include <stdio.h>
44
45namespace JSC {
46
47static const char* GlobalCodeExecution = "(program)";
48static const char* AnonymousFunction = "(anonymous function)";
49static unsigned ProfilesUID = 0;
50
51static CallIdentifier createCallIdentifierFromFunctionImp(ExecState*, JSFunction*);
52
53Profiler* Profiler::s_sharedProfiler = 0;
54Profiler* Profiler::s_sharedEnabledProfilerReference = 0;
55
56Profiler* Profiler::profiler()
57{
58    if (!s_sharedProfiler)
59        s_sharedProfiler = new Profiler();
60    return s_sharedProfiler;
61}
62
63void Profiler::startProfiling(ExecState* exec, const UString& title)
64{
65    ASSERT_ARG(title, !title.isNull());
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 ? exec->lexicalGlobalObject() : 0;
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    s_sharedEnabledProfilerReference = this;
78    RefPtr<ProfileGenerator> profileGenerator = ProfileGenerator::create(exec, title, ++ProfilesUID);
79    m_currentProfiles.append(profileGenerator);
80}
81
82PassRefPtr<Profile> Profiler::stopProfiling(ExecState* exec, const UString& title)
83{
84    JSGlobalObject* origin = exec ? exec->lexicalGlobalObject() : 0;
85    for (ptrdiff_t i = m_currentProfiles.size() - 1; i >= 0; --i) {
86        ProfileGenerator* profileGenerator = m_currentProfiles[i].get();
87        if (profileGenerator->origin() == origin && (title.isNull() || profileGenerator->title() == title)) {
88            profileGenerator->stopProfiling();
89            RefPtr<Profile> returnProfile = profileGenerator->profile();
90
91            m_currentProfiles.remove(i);
92            if (!m_currentProfiles.size())
93                s_sharedEnabledProfilerReference = 0;
94
95            return returnProfile;
96        }
97    }
98
99    return 0;
100}
101
102void Profiler::stopProfiling(JSGlobalObject* origin)
103{
104    for (ptrdiff_t i = m_currentProfiles.size() - 1; i >= 0; --i) {
105        ProfileGenerator* profileGenerator = m_currentProfiles[i].get();
106        if (profileGenerator->origin() == origin) {
107            profileGenerator->stopProfiling();
108            m_currentProfiles.remove(i);
109            if (!m_currentProfiles.size())
110                s_sharedEnabledProfilerReference = 0;
111        }
112    }
113}
114
115static inline void dispatchFunctionToProfiles(ExecState* callerOrHandlerCallFrame, const Vector<RefPtr<ProfileGenerator> >& profiles, ProfileGenerator::ProfileFunction function, const CallIdentifier& callIdentifier, unsigned currentProfileTargetGroup)
116{
117    for (size_t i = 0; i < profiles.size(); ++i) {
118        if (profiles[i]->profileGroup() == currentProfileTargetGroup || !profiles[i]->origin())
119            (profiles[i].get()->*function)(callerOrHandlerCallFrame, callIdentifier);
120    }
121}
122
123void Profiler::willExecute(ExecState* callerCallFrame, JSValue function)
124{
125    ASSERT(!m_currentProfiles.isEmpty());
126
127    dispatchFunctionToProfiles(callerCallFrame, m_currentProfiles, &ProfileGenerator::willExecute, createCallIdentifier(callerCallFrame, function, "", 0), callerCallFrame->lexicalGlobalObject()->profileGroup());
128}
129
130void Profiler::willExecute(ExecState* callerCallFrame, const UString& sourceURL, int startingLineNumber)
131{
132    ASSERT(!m_currentProfiles.isEmpty());
133
134    CallIdentifier callIdentifier = createCallIdentifier(callerCallFrame, JSValue(), sourceURL, startingLineNumber);
135
136    dispatchFunctionToProfiles(callerCallFrame, m_currentProfiles, &ProfileGenerator::willExecute, callIdentifier, callerCallFrame->lexicalGlobalObject()->profileGroup());
137}
138
139void Profiler::didExecute(ExecState* callerCallFrame, JSValue function)
140{
141    ASSERT(!m_currentProfiles.isEmpty());
142
143    dispatchFunctionToProfiles(callerCallFrame, m_currentProfiles, &ProfileGenerator::didExecute, createCallIdentifier(callerCallFrame, function, "", 0), callerCallFrame->lexicalGlobalObject()->profileGroup());
144}
145
146void Profiler::didExecute(ExecState* callerCallFrame, const UString& sourceURL, int startingLineNumber)
147{
148    ASSERT(!m_currentProfiles.isEmpty());
149
150    dispatchFunctionToProfiles(callerCallFrame, m_currentProfiles, &ProfileGenerator::didExecute, createCallIdentifier(callerCallFrame, JSValue(), sourceURL, startingLineNumber), callerCallFrame->lexicalGlobalObject()->profileGroup());
151}
152
153void Profiler::exceptionUnwind(ExecState* handlerCallFrame)
154{
155    ASSERT(!m_currentProfiles.isEmpty());
156
157    dispatchFunctionToProfiles(handlerCallFrame, m_currentProfiles, &ProfileGenerator::exceptionUnwind, createCallIdentifier(handlerCallFrame, JSValue(), "", 0), handlerCallFrame->lexicalGlobalObject()->profileGroup());
158}
159
160CallIdentifier Profiler::createCallIdentifier(ExecState* exec, JSValue functionValue, const UString& defaultSourceURL, int defaultLineNumber)
161{
162    if (!functionValue)
163        return CallIdentifier(GlobalCodeExecution, defaultSourceURL, defaultLineNumber);
164    if (!functionValue.isObject())
165        return CallIdentifier("(unknown)", defaultSourceURL, defaultLineNumber);
166    if (asObject(functionValue)->inherits(&JSFunction::s_info)) {
167        JSFunction* function = asFunction(functionValue);
168        if (!function->executable()->isHostFunction())
169            return createCallIdentifierFromFunctionImp(exec, function);
170    }
171    if (asObject(functionValue)->inherits(&JSFunction::s_info))
172        return CallIdentifier(static_cast<JSFunction*>(asObject(functionValue))->name(exec), defaultSourceURL, defaultLineNumber);
173    if (asObject(functionValue)->inherits(&InternalFunction::s_info))
174        return CallIdentifier(static_cast<InternalFunction*>(asObject(functionValue))->name(exec), defaultSourceURL, defaultLineNumber);
175    return CallIdentifier(makeUString("(", asObject(functionValue)->className(), " object)"), defaultSourceURL, defaultLineNumber);
176}
177
178CallIdentifier createCallIdentifierFromFunctionImp(ExecState* exec, JSFunction* function)
179{
180    ASSERT(!function->isHostFunction());
181    const UString& name = function->calculatedDisplayName(exec);
182    return CallIdentifier(name.isEmpty() ? AnonymousFunction : name, function->jsExecutable()->sourceURL(), function->jsExecutable()->lineNo());
183}
184
185} // namespace JSC
186