Add an API function to get a debugger stack trace from an error handle.

runtime/vm/dart_api_impl_test.cc

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #include "bin/builtin.h"
 #include "include/dart_api.h"
 #include "include/dart_debugger_api.h"
 #include "include/dart_mirrors_api.h"
 #include "include/dart_native_api.h"
 #include "platform/assert.h"
@@ skipping 44 matching lines @@
   EXPECT(Dart_IsError(Dart_ErrorGetException(instance)));
   EXPECT(Dart_IsError(Dart_ErrorGetException(error)));
   EXPECT_VALID(Dart_ErrorGetException(exception));
 
   EXPECT(Dart_IsError(Dart_ErrorGetStacktrace(instance)));
   EXPECT(Dart_IsError(Dart_ErrorGetStacktrace(error)));
   EXPECT_VALID(Dart_ErrorGetStacktrace(exception));
 }
 
 
+TEST_CASE(StacktraceInfo) {
+  const char* kScriptChars =
+      "bar() => throw new Error();\n"
+      "foo() => bar();\n"
+      "testMain() => foo();\n";
+
+  Dart_Handle lib = TestCase::LoadTestScript(kScriptChars, NULL);
+  Dart_Handle error = Dart_Invoke(lib, NewString("testMain"), 0, NULL);
+
+  EXPECT(Dart_IsError(error));
+
+  Dart_StackTrace stacktrace;
+  Dart_Handle result = Dart_GetStackTraceFromError(error, &stacktrace);
+  EXPECT_VALID(result);
+
+  intptr_t frame_count = 0;
+  result = Dart_StackTraceLength(stacktrace, &frame_count);
+  EXPECT_VALID(result);
+  EXPECT_EQ(3, frame_count);
+
+  Dart_Handle function_name;
+  Dart_Handle script_url;
+  intptr_t line_number = 0;
+  intptr_t column_number = 0;
+  const char* cstr = "";
+
+  Dart_ActivationFrame frame;
+  result = Dart_GetActivationFrame(stacktrace, 0, &frame);
+  EXPECT_VALID(result);
+  result = Dart_ActivationFrameInfoWithColumn(
+      frame, &function_name, &script_url, &line_number, &column_number);
+  EXPECT_VALID(result);
+  Dart_StringToCString(function_name, &cstr);
+  EXPECT_STREQ("bar", cstr);
+  Dart_StringToCString(script_url, &cstr);
+  EXPECT_STREQ("dart:test-lib", cstr);
+  EXPECT_EQ(1, line_number);
+  EXPECT_EQ(10, column_number);
+
+  result = Dart_GetActivationFrame(stacktrace, 1, &frame);
+  EXPECT_VALID(result);
+  result = Dart_ActivationFrameInfoWithColumn(
+      frame, &function_name, &script_url, &line_number, &column_number);
+  EXPECT_VALID(result);
+  Dart_StringToCString(function_name, &cstr);
+  EXPECT_STREQ("foo", cstr);
+  Dart_StringToCString(script_url, &cstr);
+  EXPECT_STREQ("dart:test-lib", cstr);
+  EXPECT_EQ(2, line_number);
+  EXPECT_EQ(13, column_number);
+
+  result = Dart_GetActivationFrame(stacktrace, 2, &frame);
+  EXPECT_VALID(result);
+  result = Dart_ActivationFrameInfoWithColumn(
+      frame, &function_name, &script_url, &line_number, &column_number);
+  EXPECT_VALID(result);
+  Dart_StringToCString(function_name, &cstr);
+  EXPECT_STREQ("testMain", cstr);
+  Dart_StringToCString(script_url, &cstr);
+  EXPECT_STREQ("dart:test-lib", cstr);
+  EXPECT_EQ(3, line_number);
+  EXPECT_EQ(18, column_number);
+
+  // Out-of-bounds frames.
+  result = Dart_GetActivationFrame(stacktrace, frame_count, &frame);
+  EXPECT(Dart_IsError(result));
+  result = Dart_GetActivationFrame(stacktrace, -1, &frame);
+  EXPECT(Dart_IsError(result));
+}
+
+
+TEST_CASE(DeepStacktraceInfo) {
+  const char* kScriptChars =
+      "foo(n) => n == 1 ? throw new Error() : foo(n-1);\n"
+      "testMain() => foo(50);\n";
+
+  Dart_Handle lib = TestCase::LoadTestScript(kScriptChars, NULL);
+  Dart_Handle error = Dart_Invoke(lib, NewString("testMain"), 0, NULL);
+
+  EXPECT(Dart_IsError(error));
+
+  Dart_StackTrace stacktrace;
+  Dart_Handle result = Dart_GetStackTraceFromError(error, &stacktrace);
+  EXPECT_VALID(result);
+
+  intptr_t frame_count = 0;
+  result = Dart_StackTraceLength(stacktrace, &frame_count);
+  EXPECT_VALID(result);
+  EXPECT_EQ(51, frame_count);

[rmacnak, 2013/11/12 00:05:16]

Broken after refactoring to share with the debugger. Claims to have a stack
trace of length 0. Strange because the equivalent use in Dartium still works.

[siva, 2013/11/12 16:00:43]

If you print the stacktrace object returned what do you see?

[rmacnak, 2013/11/12 22:32:40]

Woops, this comment was supposed to be attached to the very similar
CurrentStacktraceInfo test below.
 
It's empty. Presumably the stack is unwound to hand the Error handle back to the
C++ code, so it shouldn't have worked in the earlier iteration. I've refactored
the test so it runs in a native called by the Dart code and the stack is still
live. This mimics its use in Dartium.

+  // Test something bigger than the preallocated size to verify nothing was
+  // truncated.
+  EXPECT(51 > Stacktrace::kPreallocatedStackdepth);
+
+  Dart_Handle function_name;
+  Dart_Handle script_url;
+  intptr_t line_number = 0;
+  intptr_t column_number = 0;
+  const char* cstr = "";
+
+  // Top frame at positioned at throw.
+  Dart_ActivationFrame frame;
+  result = Dart_GetActivationFrame(stacktrace, 0, &frame);
+  EXPECT_VALID(result);
+  result = Dart_ActivationFrameInfoWithColumn(
+      frame, &function_name, &script_url, &line_number, &column_number);
+  EXPECT_VALID(result);
+  Dart_StringToCString(function_name, &cstr);
+  EXPECT_STREQ("foo", cstr);
+  Dart_StringToCString(script_url, &cstr);
+  EXPECT_STREQ("dart:test-lib", cstr);
+  EXPECT_EQ(1, line_number);
+  EXPECT_EQ(20, column_number);
+
+  // Middle frames positioned at the recursive call.
+  for (intptr_t frame_index = 1;
+       frame_index < (frame_count - 1);
+       frame_index++) {
+    result = Dart_GetActivationFrame(stacktrace, frame_index, &frame);
+    EXPECT_VALID(result);
+    result = Dart_ActivationFrameInfoWithColumn(
+        frame, &function_name, &script_url, &line_number, &column_number);
+    EXPECT_VALID(result);
+    Dart_StringToCString(function_name, &cstr);
+    EXPECT_STREQ("foo", cstr);
+    Dart_StringToCString(script_url, &cstr);
+    EXPECT_STREQ("dart:test-lib", cstr);
+    EXPECT_EQ(1, line_number);
+    EXPECT_EQ(43, column_number);
+  }
+
+  // Bottom frame positioned at testMain().
+  result = Dart_GetActivationFrame(stacktrace, frame_count - 1, &frame);
+  EXPECT_VALID(result);
+  result = Dart_ActivationFrameInfoWithColumn(
+      frame, &function_name, &script_url, &line_number, &column_number);
+  EXPECT_VALID(result);
+  Dart_StringToCString(function_name, &cstr);
+  EXPECT_STREQ("testMain", cstr);
+  Dart_StringToCString(script_url, &cstr);
+  EXPECT_STREQ("dart:test-lib", cstr);
+  EXPECT_EQ(2, line_number);
+  EXPECT_EQ(18, column_number);
+
+  // Out-of-bounds frames.
+  result = Dart_GetActivationFrame(stacktrace, frame_count, &frame);
+  EXPECT(Dart_IsError(result));
+  result = Dart_GetActivationFrame(stacktrace, -1, &frame);
+  EXPECT(Dart_IsError(result));
+}
+
+
+TEST_CASE(StackOverflowStacktraceInfo) {
+  const char* kScriptChars =
+      "class C {\n"
+      "  static foo() => foo();\n"
+      "}\n"
+      "testMain() => C.foo();\n";
+
+  Dart_Handle lib = TestCase::LoadTestScript(kScriptChars, NULL);
+  Dart_Handle error = Dart_Invoke(lib, NewString("testMain"), 0, NULL);
+
+  EXPECT(Dart_IsError(error));
+
+  Dart_StackTrace stacktrace;
+  Dart_Handle result = Dart_GetStackTraceFromError(error, &stacktrace);
+  EXPECT_VALID(result);
+
+  intptr_t frame_count = 0;
+  result = Dart_StackTraceLength(stacktrace, &frame_count);
+  EXPECT_VALID(result);
+  EXPECT_EQ(Stacktrace::kPreallocatedStackdepth - 1, frame_count);
+
+  Dart_Handle function_name;
+  Dart_Handle script_url;
+  intptr_t line_number = 0;
+  intptr_t column_number = 0;
+  const char* cstr = "";
+
+  // Top frame at recursive call.
+  Dart_ActivationFrame frame;
+  result = Dart_GetActivationFrame(stacktrace, 0, &frame);
+  EXPECT_VALID(result);
+  result = Dart_ActivationFrameInfoWithColumn(
+      frame, &function_name, &script_url, &line_number, &column_number);
+  EXPECT_VALID(result);
+  Dart_StringToCString(function_name, &cstr);
+  EXPECT_STREQ("C.foo", cstr);
+  Dart_StringToCString(script_url, &cstr);
+  EXPECT_STREQ("dart:test-lib", cstr);
+  EXPECT_EQ(2, line_number);
+  EXPECT_EQ(3, column_number);
+
+  // Out-of-bounds frames.
+  result = Dart_GetActivationFrame(stacktrace, frame_count, &frame);
+  EXPECT(Dart_IsError(result));
+  result = Dart_GetActivationFrame(stacktrace, -1, &frame);
+  EXPECT(Dart_IsError(result));
+}
+
+
+TEST_CASE(OutOfMemoryStacktraceInfo) {
+  const char* kScriptChars =
+      "var number_of_ints = 134000000;\n"
+      "testMain() {\n"
+      "  new List<int>(number_of_ints)\n"
+      "}\n";
+
+  Dart_Handle lib = TestCase::LoadTestScript(kScriptChars, NULL);
+  Dart_Handle error = Dart_Invoke(lib, NewString("testMain"), 0, NULL);
+
+  EXPECT(Dart_IsError(error));
+
+  Dart_StackTrace stacktrace;
+  Dart_Handle result = Dart_GetStackTraceFromError(error, &stacktrace);
+  EXPECT(Dart_IsError(result));  // No Stacktrace for OutOfMemory.
+}
+
+
+TEST_CASE(CurrentStacktraceInfo) {
+  const char* kScriptChars =
+      "foo(n) => n == 1 ? throw new Error() : foo(n-1);\n"
+      "testMain() => foo(50);\n";
+
+  Dart_Handle lib = TestCase::LoadTestScript(kScriptChars, NULL);
+  Dart_Handle error = Dart_Invoke(lib, NewString("testMain"), 0, NULL);
+
+  EXPECT(Dart_IsError(error));
+
+  Dart_StackTrace stacktrace;
+  Dart_Handle result = Dart_GetStackTrace(&stacktrace);
+  EXPECT_VALID(result);
+
+  intptr_t frame_count = 0;
+  result = Dart_StackTraceLength(stacktrace, &frame_count);
+  EXPECT_VALID(result);
+  EXPECT_EQ(51, frame_count);
+  // Test something bigger than the preallocated size to verify nothing was
+  // truncated.
+  EXPECT(51 > Stacktrace::kPreallocatedStackdepth);
+
+  Dart_Handle function_name;
+  Dart_Handle script_url;
+  intptr_t line_number = 0;
+  intptr_t column_number = 0;
+  const char* cstr = "";
+
+  // Top frame at positioned at throw.
+  Dart_ActivationFrame frame;
+  result = Dart_GetActivationFrame(stacktrace, 0, &frame);
+  EXPECT_VALID(result);
+  result = Dart_ActivationFrameInfoWithColumn(
+      frame, &function_name, &script_url, &line_number, &column_number);
+  EXPECT_VALID(result);
+  Dart_StringToCString(function_name, &cstr);
+  EXPECT_STREQ("foo", cstr);
+  Dart_StringToCString(script_url, &cstr);
+  EXPECT_STREQ("dart:test-lib", cstr);
+  EXPECT_EQ(1, line_number);
+  EXPECT_EQ(20, column_number);
+
+  // Middle frames positioned at the recursive call.
+  for (intptr_t frame_index = 1;
+       frame_index < (frame_count - 1);
+       frame_index++) {
+    result = Dart_GetActivationFrame(stacktrace, frame_index, &frame);
+    EXPECT_VALID(result);
+    result = Dart_ActivationFrameInfoWithColumn(
+        frame, &function_name, &script_url, &line_number, &column_number);
+    EXPECT_VALID(result);
+    Dart_StringToCString(function_name, &cstr);
+    EXPECT_STREQ("foo", cstr);
+    Dart_StringToCString(script_url, &cstr);
+    EXPECT_STREQ("dart:test-lib", cstr);
+    EXPECT_EQ(1, line_number);
+    EXPECT_EQ(43, column_number);
+  }
+
+  // Bottom frame positioned at testMain().
+  result = Dart_GetActivationFrame(stacktrace, frame_count - 1, &frame);
+  EXPECT_VALID(result);
+  result = Dart_ActivationFrameInfoWithColumn(
+      frame, &function_name, &script_url, &line_number, &column_number);
+  EXPECT_VALID(result);
+  Dart_StringToCString(function_name, &cstr);
+  EXPECT_STREQ("testMain", cstr);
+  Dart_StringToCString(script_url, &cstr);
+  EXPECT_STREQ("dart:test-lib", cstr);
+  EXPECT_EQ(2, line_number);
+  EXPECT_EQ(18, column_number);
+
+  // Out-of-bounds frames.
+  result = Dart_GetActivationFrame(stacktrace, frame_count, &frame);
+  EXPECT(Dart_IsError(result));
+  result = Dart_GetActivationFrame(stacktrace, -1, &frame);
+  EXPECT(Dart_IsError(result));
+}
+
+
 TEST_CASE(ErrorHandleTypes) {
   Isolate* isolate = Isolate::Current();
   const String& compile_message = String::Handle(String::New("CompileError"));
   const String& fatal_message = String::Handle(String::New("FatalError"));
 
   Dart_Handle not_error = NewString("NotError");
   Dart_Handle api_error = Api::NewError("Api%s", "Error");
   Dart_Handle exception_error =
       Dart_NewUnhandledExceptionError(NewString("ExceptionError"));
   Dart_Handle compile_error =
@@ skipping 7354 matching lines @@
                                    NewString("main"),
                                    1,
                                    dart_args);
   int64_t value = 0;
   result = Dart_IntegerToInt64(result, &value);
   EXPECT_VALID(result);
   EXPECT_EQ(6, value);
 }
 
 }  // namespace dart