Changeset 96131 in webkit

Timestamp:

Sep 27, 2011 10:58:55 AM (13 years ago)

Author:

commit-queue@webkit.org

Message:

Implement Error.stack
​https://bugs.webkit.org/show_bug.cgi?id=66994

Patch by Juan Carlos Montemayor Elosua <​j.mont@me.com> on 2011-09-27
Reviewed by Oliver Hunt.

Source/JavaScriptCore:

This patch utilizes topCallFrame to create a stack trace when
an error is thrown. Users will also be able to use the stack()
command in jsc to get arrays with stack trace information.

• JavaScriptCore.exp:
• JavaScriptCore.vcproj/JavaScriptCore/JavaScriptCore.def:
• interpreter/Interpreter.cpp:

(JSC::getCallerLine):
(JSC::getSourceURLFromCallFrame):
(JSC::getStackFrameCodeType):
(JSC::Interpreter::getStackTrace):
(JSC::Interpreter::throwException):

• interpreter/Interpreter.h:

(JSC::StackFrame::toString):

• jsc.cpp:

(GlobalObject::finishCreation):
(functionJSCStack):

• parser/Parser.h:

(JSC::Parser::parse):

• runtime/CommonIdentifiers.h:
• runtime/Error.cpp:

(JSC::addErrorInfo):

• runtime/Error.h:

LayoutTests:

Unit tests that contain both normal and special cases for stack trace
generation.

• fast/js/exception-properties-expected.txt:
• fast/js/script-tests/exception-properties.js:
• fast/js/script-tests/stack-trace.js: Added.

(printStack):
(hostThrower):
(callbacker):
(outer):
(inner):
(evaler):
(normalOuter):
(normalInner):
(scripterInner):
(scripterOuter):

• fast/js/stack-trace-expected.txt: Added.
• fast/js/stack-trace.html: Added.
• platform/chromium/test_expectations.txt:

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/fast/js/exception-properties-expected.txt (modified) (1 diff)
• LayoutTests/fast/js/script-tests/exception-properties.js (modified) (1 diff)
• LayoutTests/fast/js/script-tests/stack-trace.js (added)
• LayoutTests/fast/js/stack-trace-expected.txt (added)
• LayoutTests/fast/js/stack-trace.html (added)
• LayoutTests/platform/chromium/test_expectations.txt (modified) (1 diff)
• Source/JavaScriptCore/ChangeLog (modified) (1 diff)
• Source/JavaScriptCore/JavaScriptCore.exp (modified) (1 diff)
• Source/JavaScriptCore/JavaScriptCore.vcproj/JavaScriptCore/JavaScriptCore.def (modified) (1 diff)
• Source/JavaScriptCore/interpreter/Interpreter.cpp (modified) (3 diffs)
• Source/JavaScriptCore/interpreter/Interpreter.h (modified) (4 diffs)
• Source/JavaScriptCore/jsc.cpp (modified) (4 diffs)
• Source/JavaScriptCore/parser/Parser.h (modified) (1 diff)
• Source/JavaScriptCore/runtime/CommonIdentifiers.h (modified) (1 diff)
• Source/JavaScriptCore/runtime/Error.cpp (modified) (3 diffs)
• Source/JavaScriptCore/runtime/Error.h (modified) (2 diffs)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2011-09-27  Juan Carlos Montemayor Elosua  <j.mont@me.com>
+
+        Implement Error.stack
+        https://bugs.webkit.org/show_bug.cgi?id=66994
+
+        Reviewed by Oliver Hunt.
+
+        Unit tests that contain both normal and special cases for stack trace
+        generation.
+
+        * fast/js/exception-properties-expected.txt:
+        * fast/js/script-tests/exception-properties.js:
+        * fast/js/script-tests/stack-trace.js: Added.
+        (printStack):
+        (hostThrower):
+        (callbacker):
+        (outer):
+        (inner):
+        (evaler):
+        (normalOuter):
+        (normalInner):
+        (scripterInner):
+        (scripterOuter):
+        * fast/js/stack-trace-expected.txt: Added.
+        * fast/js/stack-trace.html: Added.
+        * platform/chromium/test_expectations.txt:
+
 2011-09-27  Adrienne Walker  <enne@google.com>
 

trunk/LayoutTests/fast/js/exception-properties-expected.txt

@@ -5 +5 @@
 
 PASS enumerableProperties(error) is []
-PASS enumerableProperties(nativeError) is ["line", "sourceId", "sourceURL"]
+PASS enumerableProperties(nativeError) is ["line", "sourceId", "sourceURL", "jscStack"]
 PASS Object.getPrototypeOf(nativeError).name is "RangeError"
 PASS Object.getPrototypeOf(nativeError).message is ""

trunk/LayoutTests/fast/js/script-tests/exception-properties.js

@@ -17 +17 @@
 
     shouldBe('enumerableProperties(error)', '[]');
-    shouldBe('enumerableProperties(nativeError)', '["line", "sourceId", "sourceURL"]');
+    shouldBe('enumerableProperties(nativeError)', '["line", "sourceId", "sourceURL", "jscStack"]');
 
     shouldBe('Object.getPrototypeOf(nativeError).name', '"RangeError"');

trunk/LayoutTests/platform/chromium/test_expectations.txt

@@ -489 +489 @@
 // throw.  V8 follows the spec.
 WONTFIX SKIP : fast/js/reparsing-semicolon-insertion.html = FAIL
+
+// This tests stack-traces that are generated by JSC. This test should
+// fail since it is specific to jsc.
+WONTFIX SKIP : fast/js/stack-trace.html = FAIL
 
 // Rubber-banding is currently a CG only feature.

trunk/Source/JavaScriptCore/ChangeLog

@@ +1 @@
+2011-09-27  Juan Carlos Montemayor Elosua  <j.mont@me.com>
+
+        Implement Error.stack
+        https://bugs.webkit.org/show_bug.cgi?id=66994
+
+        Reviewed by Oliver Hunt.
+
+        This patch utilizes topCallFrame to create a stack trace when
+        an error is thrown. Users will also be able to use the stack()
+        command in jsc to get arrays with stack trace information.
+
+        * JavaScriptCore.exp:
+        * JavaScriptCore.vcproj/JavaScriptCore/JavaScriptCore.def:
+        * interpreter/Interpreter.cpp:
+        (JSC::getCallerLine):
+        (JSC::getSourceURLFromCallFrame):
+        (JSC::getStackFrameCodeType):
+        (JSC::Interpreter::getStackTrace):
+        (JSC::Interpreter::throwException):
+        * interpreter/Interpreter.h:
+        (JSC::StackFrame::toString):
+        * jsc.cpp:
+        (GlobalObject::finishCreation):
+        (functionJSCStack):
+        * parser/Parser.h:
+        (JSC::Parser::parse):
+        * runtime/CommonIdentifiers.h:
+        * runtime/Error.cpp:
+        (JSC::addErrorInfo):
+        * runtime/Error.h:
+
 2011-09-27  Carlos Garcia Campos  <cgarcia@igalia.com>
 

trunk/Source/JavaScriptCore/JavaScriptCore.exp

@@ -115 +115 @@
 __ZN3JSC10throwErrorEPNS_9ExecStateENS_7JSValueE
 __ZN3JSC10throwErrorEPNS_9ExecStateEPNS_8JSObjectE
+__ZN3JSC11Interpreter13getStackTraceEPNS_12JSGlobalDataEiRN3WTF6VectorINS_10StackFrameELm0EEE
 __ZN3JSC11JSByteArray13s_defaultInfoE
 __ZN3JSC11JSByteArray15createStructureERNS_12JSGlobalDataEPNS_14JSGlobalObjectENS_7JSValueEPKNS_9ClassInfoE

trunk/Source/JavaScriptCore/JavaScriptCore.vcproj/JavaScriptCore/JavaScriptCore.def

@@ -212 +212 @@
     ?getPropertyNames@JSObject@JSC@@UAEXPAVExecState@2@AAVPropertyNameArray@2@W4EnumerationMode@2@@Z
     ?getSlice@ArgList@JSC@@QBEXHAAV12@@Z
+    ?getStackTrace@Interpreter@JSC@@SAXPAVJSGlobalData@2@HAAV?$Vector@UStackFrame@JSC@@$0A@@WTF@@@Z
     ?getString@JSCell@JSC@@QBE?AVUString@2@PAVExecState@2@@Z
     ?getString@JSCell@JSC@@QBE_NPAVExecState@2@AAVUString@2@@Z

trunk/Source/JavaScriptCore/interpreter/Interpreter.cpp

@@ -46 +46 @@
 #include "JSArray.h"
 #include "JSByteArray.h"
-#include "JSFunction.h"
 #include "JSNotAnObject.h"
 #include "JSPropertyNameIterator.h"
@@ -688 +687 @@
 }
 
+static void getCallerLine(JSGlobalData* globalData, CallFrame* callFrame, int& lineNumber)
+{
+    (void)globalData;
+    unsigned bytecodeOffset;
+    lineNumber = -1;
+    callFrame = callFrame->removeHostCallFrameFlag();
+
+    if (callFrame->callerFrame() == CallFrame::noCaller() || callFrame->callerFrame()->hasHostCallFrameFlag())
+        return;
+
+    CodeBlock* callerCodeBlock = callFrame->callerFrame()->removeHostCallFrameFlag()->codeBlock();
+
+#if ENABLE(INTERPRETER)
+    if (!globalData->canUseJIT())
+        bytecodeOffset = callerCodeBlock->bytecodeOffset(callFrame->returnVPC());
+#if ENABLE(JIT)
+    else
+        bytecodeOffset = callerCodeBlock->bytecodeOffset(callFrame->returnPC());
+#endif
+#else
+    bytecodeOffset = callerCodeBlock->bytecodeOffset(callFrame->returnPC());
+#endif
+
+    lineNumber = callerCodeBlock->lineNumberForBytecodeOffset(bytecodeOffset - 1);
+}
+
+static ALWAYS_INLINE const UString getSourceURLFromCallFrame(CallFrame* callFrame) 
+{
+    if (callFrame->hasHostCallFrameFlag())
+        return UString();
+#if ENABLE(INTERPRETER)
+    if (!callFrame->globalData().canUseJIT())
+        return callFrame->codeBlock()->source()->url();
+#if ENABLE(JIT)
+    return callFrame->codeBlock()->ownerExecutable()->sourceURL();
+#endif
+#else
+    return callFrame->codeBlock()->ownerExecutable()->sourceURL();
+#endif
+}
+
+static StackFrameCodeType getStackFrameCodeType(CallFrame* callFrame)
+{
+    if (callFrame->hasHostCallFrameFlag()) 
+        return StackFrameNativeCode;
+
+    switch (callFrame->codeBlock()->codeType()) {
+    case EvalCode:
+        return StackFrameEvalCode;
+    case FunctionCode:
+        return StackFrameFunctionCode;
+    case GlobalCode:
+        return StackFrameGlobalCode;
+    }
+    ASSERT_NOT_REACHED();
+    return StackFrameGlobalCode;
+}
+
+void Interpreter::getStackTrace(JSGlobalData* globalData, int line, Vector<StackFrame>& results)
+{
+    int stackLimit = 15;
+    CallFrame* callFrame = globalData->topCallFrame->removeHostCallFrameFlag();
+    if (!callFrame || callFrame == CallFrame::noCaller() || !callFrame->codeBlock()) 
+        return;
+    UString sourceURL;
+    UString traceLevel;
+
+    for (int i = 0; i < stackLimit; ++i) {
+        if (!callFrame || callFrame == CallFrame::noCaller())
+            break;
+        if (callFrame->codeBlock()) {
+            sourceURL = getSourceURLFromCallFrame(callFrame);
+
+            StackFrame s = { Strong<JSObject>(*globalData, callFrame->callee()), Strong<CallFrame>(*globalData, callFrame), getStackFrameCodeType(callFrame), Strong<ExecutableBase>(*globalData, callFrame->codeBlock()->ownerExecutable()), line, sourceURL};
+
+            results.append(s);
+        }
+        getCallerLine(globalData, callFrame, line);
+        callFrame = callFrame->callerFrame()->removeHostCallFrameFlag();
+    }
+}
+
 NEVER_INLINE HandlerInfo* Interpreter::throwException(CallFrame*& callFrame, JSValue& exceptionValue, unsigned bytecodeOffset)
 {
@@ -706 +787 @@
             // FIXME: should only really be adding these properties to VM generated exceptions,
             // but the inspector currently requires these for all thrown objects.
-            addErrorInfo(callFrame, exception, codeBlock->lineNumberForBytecodeOffset(bytecodeOffset), codeBlock->ownerExecutable()->source());
+            Vector<StackFrame> stackTrace;
+            getStackTrace(&callFrame->globalData(), codeBlock->lineNumberForBytecodeOffset(bytecodeOffset), stackTrace);
+            addErrorInfo(callFrame, exception, codeBlock->lineNumberForBytecodeOffset(bytecodeOffset), codeBlock->ownerExecutable()->source(), stackTrace);
         }
 

trunk/Source/JavaScriptCore/interpreter/Interpreter.h

@@ -32 +32 @@
 #include "ArgList.h"
 #include "JSCell.h"
+#include "JSFunction.h"
 #include "JSValue.h"
 #include "JSObject.h"
@@ -43 +44 @@
     class CodeBlock;
     class EvalExecutable;
+    class ExecutableBase;
     class FunctionExecutable;
-    class JSFunction;
     class JSGlobalObject;
     class ProgramExecutable;
@@ -63 +64 @@
     };
 
+    enum StackFrameCodeType {
+        StackFrameGlobalCode,
+        StackFrameEvalCode,
+        StackFrameFunctionCode,
+        StackFrameNativeCode
+    };
+
+    struct StackFrame {
+        Strong<JSObject> callee;
+        Strong<CallFrame> callFrame;
+        StackFrameCodeType codeType;
+        Strong<ExecutableBase> executable;
+        int line;
+        UString sourceURL;
+        UString toString() const
+        {
+            bool hasSourceURLInfo = !sourceURL.isNull() && !sourceURL.isEmpty();
+            bool hasLineInfo = line > -1;
+            String traceLine;
+            JSObject* stackFrameCallee = callee.get();
+
+            switch (codeType) {
+            case StackFrameEvalCode:
+                if (hasSourceURLInfo) 
+                    traceLine = hasLineInfo ? String::format("eval at %s:%d", sourceURL.ascii().data(), line) 
+                                            : String::format("eval at %s", sourceURL.ascii().data());
+                else
+                    traceLine = String::format("eval");
+                break;
+            case StackFrameNativeCode:
+                traceLine = "Native code";
+                break;
+            case StackFrameFunctionCode:
+                if (stackFrameCallee && stackFrameCallee->inherits(&JSFunction::s_info)) {
+                    UString functionName = asFunction(stackFrameCallee)->name(callFrame.get());
+                    if (hasSourceURLInfo) 
+                        traceLine = hasLineInfo ? String::format("%s at %s:%d", functionName.ascii().data(), sourceURL.ascii().data(), line)
+                                                : String::format("%s at %s", functionName.ascii().data(), sourceURL.ascii().data());
+                    else
+                        traceLine = String::format("%s\n", functionName.ascii().data());
+                    break;
+                }
+            case StackFrameGlobalCode:
+                traceLine = hasLineInfo ? String::format("at %s:%d", sourceURL.ascii().data(), line)
+                                        : String::format("at %s", sourceURL.ascii().data());
+            }
+            return traceLine.impl();
+        }
+    };
+
     class TopCallFrameSetter {
     public:
@@ -129 +180 @@
         NEVER_INLINE HandlerInfo* throwException(CallFrame*&, JSValue&, unsigned bytecodeOffset);
         NEVER_INLINE void debug(CallFrame*, DebugHookID, int firstLine, int lastLine);
+        static const UString getTraceLine(CallFrame*, StackFrameCodeType, const UString&, int);
+        static void getStackTrace(JSGlobalData*, int line, Vector<StackFrame>& results);
 
         void dumpSampleData(ExecState* exec);

trunk/Source/JavaScriptCore/jsc.cpp

@@ -28 +28 @@
 #include "ExceptionHelpers.h"
 #include "InitializeThreading.h"
+#include "Interpreter.h"
 #include "JSArray.h"
 #include "JSFunction.h"
@@ -74 +75 @@
 static EncodedJSValue JSC_HOST_CALL functionPrint(ExecState*);
 static EncodedJSValue JSC_HOST_CALL functionDebug(ExecState*);
+static EncodedJSValue JSC_HOST_CALL functionJSCStack(ExecState*);
 static EncodedJSValue JSC_HOST_CALL functionGC(ExecState*);
 #ifndef NDEBUG
@@ -175 +177 @@
         addFunction(globalData, "load", functionLoad, 1);
         addFunction(globalData, "checkSyntax", functionCheckSyntax, 1);
+        addFunction(globalData, "jscStack", functionJSCStack, 1);
         addFunction(globalData, "readline", functionReadline, 0);
         addFunction(globalData, "preciseTime", functionPreciseTime, 0);
@@ -219 +222 @@
 {
     fprintf(stderr, "--> %s\n", exec->argument(0).toString(exec).utf8().data());
+    return JSValue::encode(jsUndefined());
+}
+
+EncodedJSValue JSC_HOST_CALL functionJSCStack(ExecState* exec)
+{
+    String trace = "--> Stack trace:\n";
+    Vector<StackFrame> stackTrace;
+    Interpreter::getStackTrace(&exec->globalData(), -1, stackTrace);
+    int i = 0;
+
+    for (Vector<StackFrame>::iterator iter = stackTrace.begin(); iter < stackTrace.end(); iter++) {
+        StackFrame level = *iter;
+        trace += String::format("    %i   %s\n", i, level.toString().utf8().data());
+        i++;
+    }
+    fprintf(stderr, "%s", trace.utf8().data());
     return JSValue::encode(jsUndefined());
 }

trunk/Source/JavaScriptCore/parser/Parser.h

@@ -115 +115 @@
                 *exception = createSyntaxError(lexicalGlobalObject, errMsg);
             else
-                *exception = addErrorInfo(&lexicalGlobalObject->globalData(), createSyntaxError(lexicalGlobalObject, errMsg), errLine, source);
+                *exception = addErrorInfo(&lexicalGlobalObject->globalData(), createSyntaxError(lexicalGlobalObject, errMsg), errLine, source, Vector<StackFrame>());
         }
 

trunk/Source/JavaScriptCore/runtime/CommonIdentifiers.h

@@ -53 +53 @@
     macro(isArray) \
     macro(isPrototypeOf) \
+    macro(jscStack) \
     macro(length) \
     macro(message) \

trunk/Source/JavaScriptCore/runtime/Error.cpp

@@ -27 +27 @@
 #include "ConstructData.h"
 #include "ErrorConstructor.h"
+#include "JSArray.h"
 #include "JSFunction.h"
 #include "JSGlobalObject.h"
@@ -117 +118 @@
 }
 
-JSObject* addErrorInfo(JSGlobalData* globalData, JSObject* error, int line, const SourceCode& source)
+JSObject* addErrorInfo(JSGlobalData* globalData, JSObject* error, int line, const SourceCode& source, const Vector<StackFrame>& stackTrace)
 {
     intptr_t sourceID = source.provider()->asID();
@@ -128 +129 @@
     if (!sourceURL.isNull())
         error->putWithAttributes(globalData, Identifier(globalData, sourceURLPropertyName), jsString(globalData, sourceURL), ReadOnly | DontDelete);
+    if (!stackTrace.isEmpty()) {
+        JSArray* stackTraceArray = JSArray::create(*globalData, globalData->dynamicGlobalObject->arrayStructure());
+        for (unsigned i = 0; i < stackTrace.size(); i++) {
+            UString stackLevel =  stackTrace[i].toString();
+            stackTraceArray->push(globalData->topCallFrame, jsString(globalData, stackLevel)); 
+        }
+        error->putWithAttributes(globalData, globalData->propertyNames->jscStack, stackTraceArray, ReadOnly | DontDelete);
+    }
 
     return error;
 }
 
-JSObject* addErrorInfo(ExecState* exec, JSObject* error, int line, const SourceCode& source)
-{
-    return addErrorInfo(&exec->globalData(), error, line, source);
+JSObject* addErrorInfo(ExecState* exec, JSObject* error, int line, const SourceCode& source, const Vector<StackFrame>& stackTrace)
+{
+    return addErrorInfo(&exec->globalData(), error, line, source, stackTrace);
 }
 

trunk/Source/JavaScriptCore/runtime/Error.h

@@ -24 +24 @@
 #define Error_h
 
+#include "Interpreter.h"
 #include "JSObject.h"
 #include <stdint.h>
@@ -56 +57 @@
     // Methods to add 
     bool hasErrorInfo(ExecState*, JSObject* error);
-    JSObject* addErrorInfo(JSGlobalData*, JSObject* error, int line, const SourceCode&);
+    JSObject* addErrorInfo(JSGlobalData*, JSObject* error, int line, const SourceCode&, const Vector<StackFrame>&);
     // ExecState wrappers.
-    JSObject* addErrorInfo(ExecState*, JSObject* error, int line, const SourceCode&);
+    JSObject* addErrorInfo(ExecState*, JSObject* error, int line, const SourceCode&, const Vector<StackFrame>&);
 
     // Methods to throw Errors.