ae4741d91936727931315071f9684d568852e269
[WebKit-https.git] / Source / WebCore / bindings / js / ScriptCallStackFactory.cpp
1 /*
2  * Copyright (c) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2012 Research In Motion Limited. All rights reserved.
4  * 
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  * 
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  * 
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33 #include "ScriptCallStackFactory.h"
34
35 #include "InspectorInstrumentation.h"
36 #include "JSDOMBinding.h"
37 #include "JSMainThreadExecState.h"
38 #include "ScriptArguments.h"
39 #include "ScriptCallFrame.h"
40 #include "ScriptCallStack.h"
41 #include "ScriptValue.h"
42 #include <interpreter/CallFrame.h>
43 #include <interpreter/CallFrameInlines.h>
44 #include <interpreter/StackIterator.h>
45 #include <runtime/ArgList.h>
46 #include <runtime/JSCJSValue.h>
47 #include <runtime/JSFunction.h>
48 #include <runtime/VM.h>
49 #include <wtf/text/WTFString.h>
50
51 using namespace JSC;
52
53 namespace WebCore {
54
55 class ScriptExecutionContext;
56
57 PassRefPtr<ScriptCallStack> createScriptCallStack(size_t maxStackSize, bool emptyIsAllowed)
58 {
59     Vector<ScriptCallFrame> frames;
60     if (JSC::ExecState* exec = JSMainThreadExecState::currentState()) {
61         CallFrame* frame = exec->vm().topCallFrame;
62         for (StackIterator iter = frame->begin(); iter != frame->end() && maxStackSize--; ++iter) {
63             unsigned line;
64             unsigned column;
65             iter->computeLineAndColumn(line, column);
66             frames.append(ScriptCallFrame(iter->functionName(), iter->sourceURL(), line, column));
67         }
68     }
69     if (frames.isEmpty() && !emptyIsAllowed) {
70         // No frames found. It may happen in the case where
71         // a bound function is called from native code for example.
72         // Fallback to setting lineNumber to 0, and source and function name to "undefined".
73         frames.append(ScriptCallFrame("undefined", "undefined", 0, 0));
74     }
75     return ScriptCallStack::create(frames);
76 }
77
78 PassRefPtr<ScriptCallStack> createScriptCallStack(JSC::ExecState* exec, size_t maxStackSize)
79 {
80     Vector<ScriptCallFrame> frames;
81     ASSERT(exec);
82     CallFrame* frame = exec->vm().topCallFrame;
83     StackIterator iter = frame->begin();
84     if (iter.numberOfFrames() > 1)
85         ++iter;
86     for (; iter != frame->end() && maxStackSize--; ++iter) {
87         // This early exit is necessary to maintain our old behaviour
88         // but the stack trace we produce now is complete and handles all
89         // ways in which code may be running
90         if (!iter->callee() && frames.size())
91             break;
92         unsigned line;
93         unsigned column;
94         iter->computeLineAndColumn(line, column);
95         frames.append(ScriptCallFrame(iter->functionName(), iter->sourceURL(), line, column));
96     }
97     return ScriptCallStack::create(frames);
98 }
99
100 PassRefPtr<ScriptCallStack> createScriptCallStackFromException(JSC::ExecState* exec, JSC::JSValue& exception, size_t maxStackSize)
101 {
102     Vector<ScriptCallFrame> frames;
103     RefCountedArray<StackFrame> stackTrace = exec->vm().exceptionStack();
104     for (size_t i = 0; i < stackTrace.size() && i < maxStackSize; i++) {
105         if (!stackTrace[i].callee && frames.size())
106             break;
107
108         String functionName = stackTrace[i].friendlyFunctionName(exec);
109         unsigned line;
110         unsigned column;
111         stackTrace[i].computeLineAndColumn(line, column);
112         frames.append(ScriptCallFrame(functionName, stackTrace[i].sourceURL, line, column));
113     }
114
115     // FIXME: <http://webkit.org/b/115087> Web Inspector: WebCore::reportException should not evaluate JavaScript handling exceptions
116     // Fallback to getting at least the line and sourceURL from the exception if it has values and the exceptionStack doesn't.
117     if (frames.size() > 0) {
118         const ScriptCallFrame& firstCallFrame = frames.first();
119         JSObject* exceptionObject = exception.toObject(exec);
120         if (exception.isObject() && firstCallFrame.sourceURL().isEmpty()) {
121             JSValue lineValue = exceptionObject->getDirect(exec->vm(), Identifier(exec, "line"));
122             int lineNumber = lineValue && lineValue.isNumber() ? int(lineValue.toNumber(exec)) : 0;
123             JSValue sourceURLValue = exceptionObject->getDirect(exec->vm(), Identifier(exec, "sourceURL"));
124             String exceptionSourceURL = sourceURLValue && sourceURLValue.isString() ? sourceURLValue.toString(exec)->value(exec) : ASCIILiteral("undefined");
125             frames[0] = ScriptCallFrame(firstCallFrame.functionName(), exceptionSourceURL, lineNumber, 0);
126         }
127     }
128
129     return ScriptCallStack::create(frames);
130 }
131
132 PassRefPtr<ScriptCallStack> createScriptCallStackForConsole(JSC::ExecState* exec)
133 {
134     size_t maxStackSize = 1;
135     if (InspectorInstrumentation::hasFrontends()) {
136         ScriptExecutionContext* scriptExecutionContext = jsCast<JSDOMGlobalObject*>(exec->lexicalGlobalObject())->scriptExecutionContext();
137         if (InspectorInstrumentation::consoleAgentEnabled(scriptExecutionContext))
138             maxStackSize = ScriptCallStack::maxCallStackSizeToCapture;
139     }
140     return createScriptCallStack(exec, maxStackSize);
141 }
142
143 PassRefPtr<ScriptArguments> createScriptArguments(JSC::ExecState* exec, unsigned skipArgumentCount)
144 {
145     Vector<ScriptValue> arguments;
146     size_t argumentCount = exec->argumentCount();
147     for (size_t i = skipArgumentCount; i < argumentCount; ++i)
148         arguments.append(ScriptValue(exec->vm(), exec->argument(i)));
149     return ScriptArguments::create(exec, arguments);
150 }
151
152 } // namespace WebCore