Build fix for gcc 4.3 and Gtk.
[WebKit-https.git] / JavaScriptCore / profiler / Profiler.cpp
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 "FunctionCallProfile.h"
33 #include <kjs/ExecState.h>
34 #include <kjs/function.h>
35
36 #include <stdio.h>
37
38 namespace KJS {
39
40 static Profiler* sharedProfiler = 0;
41 static const char* Script = "[SCRIPT] ";
42
43 Profiler* Profiler::profiler()
44 {
45     if (!sharedProfiler)
46         sharedProfiler = new Profiler;
47     return sharedProfiler;
48 }
49
50 void Profiler::startProfiling()
51 {
52     if (m_profiling)
53         return;
54
55     // FIXME: When multi-threading is supported this will be a vector and calls
56     // into the profiler will need to know which thread it is executing on.
57     m_callTree.set(new FunctionCallProfile("Thread_1"));
58     m_profiling = true;
59 }
60
61 void Profiler::stopProfiling()
62 {
63     m_profiling = false;
64 }
65
66 void Profiler::willExecute(ExecState* exec, JSObject* calledFunction)
67 {
68     ASSERT(m_profiling);
69
70     Vector<UString> callStackNames;
71     getStackNames(callStackNames, exec, calledFunction);
72     insertStackNamesInTree(callStackNames);
73 }
74
75 void Profiler::willExecute(ExecState* exec, const UString& sourceURL, int startingLineNumber)
76 {
77     ASSERT(m_profiling);
78
79     Vector<UString> callStackNames;
80     getStackNames(callStackNames, exec, sourceURL, startingLineNumber);
81     insertStackNamesInTree(callStackNames);
82 }
83
84 void Profiler::didExecute(ExecState* exec, JSObject* calledFunction)
85 {
86     ASSERT(m_profiling);
87
88     Vector<UString> callStackNames;
89     getStackNames(callStackNames, exec, calledFunction);
90     m_callTree->didExecute(callStackNames, 0);
91 }
92
93 void Profiler::didExecute(ExecState* exec, const UString& sourceURL, int startingLineNumber)
94 {
95     ASSERT(m_profiling);
96
97     Vector<UString> callStackNames;
98     getStackNames(callStackNames, exec, sourceURL, startingLineNumber);
99     m_callTree->didExecute(callStackNames, 0);
100 }
101
102 void Profiler::insertStackNamesInTree(const Vector<UString>& callStackNames)
103 {
104     FunctionCallProfile* callTreeInsertionPoint = 0;
105     FunctionCallProfile* foundNameInTree = m_callTree.get();
106     NameIterator callStackLocation = callStackNames.begin();
107
108     while (callStackLocation != callStackNames.end() && foundNameInTree) {
109         callTreeInsertionPoint = foundNameInTree;
110         foundNameInTree = callTreeInsertionPoint->findChild(*callStackLocation);
111         ++callStackLocation;
112     }
113
114     if (!foundNameInTree) {   // Insert remains of the stack into the call tree.
115         --callStackLocation;
116         for (FunctionCallProfile* next; callStackLocation != callStackNames.end(); ++callStackLocation) {
117             next = new FunctionCallProfile(*callStackLocation);
118             callTreeInsertionPoint->addChild(next);
119             callTreeInsertionPoint = next;
120         }
121     } else    // We are calling a function that is already in the call tree.
122         foundNameInTree->willExecute();
123 }
124
125 void Profiler::getStackNames(Vector<UString>& names, ExecState* exec) const
126 {
127     UString currentName;
128     for (ExecState* currentState = exec; currentState; currentState = currentState->callingExecState()) {
129         if (FunctionImp* functionImp = exec->function())
130             names.prepend(getFunctionName(functionImp));
131         else if (ScopeNode* scopeNode = exec->scopeNode())
132             names.prepend(Script + scopeNode->sourceURL() + ": " + UString::from(scopeNode->lineNo() + 1));   // FIXME: Why is the line number always off by one?
133     }
134 }
135
136 void Profiler::getStackNames(Vector<UString>& names, ExecState* exec, JSObject* calledFunction) const
137 {
138     getStackNames(names, exec);
139
140     if (calledFunction->inherits(&FunctionImp::info))
141         names.append(getFunctionName(static_cast<FunctionImp*>(calledFunction)));
142     else if (calledFunction->inherits(&InternalFunctionImp::info))
143         names.append(static_cast<InternalFunctionImp*>(calledFunction)->functionName().ustring());
144 }
145
146
147 void Profiler::getStackNames(Vector<UString>& names, ExecState* exec, const UString& sourceURL, int startingLineNumber) const
148 {
149     getStackNames(names, exec);
150     names.append(Script + sourceURL + ": " + UString::from(startingLineNumber + 1));
151 }
152
153 UString Profiler::getFunctionName(FunctionImp* functionImp) const
154 {
155     UString name = functionImp->functionName().ustring();
156     int lineNumber = functionImp->body->lineNo();
157     UString URL = functionImp->body->sourceURL();
158
159     return (name.isEmpty() ? "[anonymous function]" : name) + " " + URL + ": " + UString::from(lineNumber);
160 }
161
162 void Profiler::printDataSampleStyle() const
163 {
164     printf("Call graph:\n");
165     m_callTree->printDataSampleStyle(0);
166
167     // FIXME: Since no one seems to understand this part of sample's output I will implement it when I have a better idea of what it's meant to be doing.
168     printf("\nTotal number in stack (recursive counted multiple, when >=5):\n");
169     printf("\nSort by top of stack, same collapsed (when >= 5):\n");
170 }
171
172 void Profiler::debugLog(UString message)
173 {
174     printf("Profiler Log: %s\n", message.UTF8String().c_str());
175 }
176
177 }   // namespace KJS