OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2025-12-06 12:20:27 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

src: print more information in C++ assertions

Browse Source 
This patch:

- Introduce an internal GetCurrentStackTrace() utility to get the
  current JavaScript stack trace with best effort.
- Indent the assertion message so that is separated from the native
  stack trace for redability
- Print the JS stack trace when it's available

Previoiusly the abort message looks like this:

```
out/Release/node[24458]: ../../src/node_file.cc:2008:void node::fs::Ope
n(const FunctionCallbackInfo<v8::Value> &): Assertion `(argc) >= (3)' f
ailed.
 1: 0x1043fb9a4 node::Abort() [node]
 2: 0x1043fb6e4 node::PrintCaughtException(v8::Isolate*, v8::Local<v8::
Context>, v8::TryCatch const&) [node]
 3: 0x104407708 node::fs::Open(v8::FunctionCallbackInfo<v8::Value> cons
t&) [node]
 4: 0x104611e74 v8::internal::MaybeHandle<v8::internal::Object> v8::int
ernal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::
Isolate*, v8::internal::Handle<v8::internal::HeapObject
>, v8::internal::Handle<v8::internal::FunctionTemplateInfo>, v8::intern
al::Handle<v8::internal::Object>, unsigned long*, int) [node
]
 5: 0x1046116c8 v8::internal::Builtin_HandleApiCall(int, unsigned long*
, v8::internal::Isolate*) [node]
 6: 0x104e9cb24 Builtins_CEntry_Return1_ArgvOnStack_BuiltinExit [node]
 7: 0x104e143e4 Builtins_InterpreterEntryTrampoline [node]
 8: 0x104e1250c Builtins_JSEntryTrampoline [node]
 9: 0x104e121f4 Builtins_JSEntry [node]
10: 0x1046ed54c v8::internal::(anonymous namespace)::Invoke(v8::interna
l::Isolate*, v8::internal::(anonymous namespace)::InvokeParams const&)
[node]
11: 0x1046edb60 v8::internal::Execution::CallScript(v8::internal::Isola
te*, v8::internal::Handle<v8::internal::JSFunction>, v8::internal::Hand
le<v8::internal::Object>, v8::internal::Handle<v8::in
ternal::Object>) [node]
12: 0x1045a9fa0 v8::Script::Run(v8::Local<v8::Context>, v8::Local<v8::D
ata>) [node]
13: 0x1043efb68 node::contextify::ContextifyScript::EvalMachine(v8::Loc
al<v8::Context>, node::Environment*, long long, bool, bool, bool, v8::M
icrotaskQueue*, v8::FunctionCallbackInfo<v8::Value> const&) [node
]
14: 0x1043ef3e0 node::contextify::ContextifyScript::RunInContext(v8::Fu
nctionCallbackInfo<v8::Value> const&) [node]
15: 0x104611e74 v8::internal::MaybeHandle<v8::internal::Object> v8::int
ernal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::
Isolate*, v8::internal::Handle<v8::internal::HeapObject>
, v8::internal::Handle<v8::internal::FunctionTemplateInfo>, v8::interna
l::Handle<v8::internal::Object>, unsigned long*, int) [node
]
16: 0x1046116c8 v8::internal::Builtin_HandleApiCall(int, unsigned long*
, v8::internal::Isolate*) [node]
17: 0x104e9cb24 Builtins_CEntry_Return1_ArgvOnStack_BuiltinExit [node]
18: 0x104e143e4 Builtins_InterpreterEntryTrampoline [node]
19: 0x104e143e4 Builtins_InterpreterEntryTrampoline [node]
20: 0x104e143e4 Builtins_InterpreterEntryTrampoline [node]
21: 0x104e143e4 Builtins_InterpreterEntryTrampoline [node]
22: 0x104e143e4 Builtins_InterpreterEntryTrampoline [node]
23: 0x104e143e4 Builtins_InterpreterEntryTrampoline [node]
24: 0x104e143e4 Builtins_InterpreterEntryTrampoline [node]
25: 0x104e1250c Builtins_JSEntryTrampoline [node]
26: 0x104e121f4 Builtins_JSEntry [node]
27: 0x1046ed54c v8::internal::(anonymous namespace)::Invoke(v8::interna
l::Isolate*, v8::internal::(anonymous namespace)::InvokeParams const&)
[node]
28: 0x1046ecdc8 v8::internal::Execution::Call(v8::internal::Isolate*, v
8::internal::Handle<v8::internal::Object>, v8::internal::Handle<v8::int
ernal::Object>, int, v8::internal::Handle<v
8::internal::Object>*) [node]
29: 0x1045be23c v8::Function::Call(v8::Local<v8::Context>, v8::Local<v8
::Value>, int, v8::Local<v8::Value>*) [node]
30: 0x1043df704 node::builtins::BuiltinLoader::CompileAndCall(v8::Local
<v8::Context>, char const*, node::Realm*) [node]
31: 0x10446f2d4 node::Realm::ExecuteBootstrapper(char const*) [node]
32: 0x1043c3378 node::StartExecution(node::Environment*, std::__1::func
tion<v8::MaybeLocal<v8::Value> (node::StartExecutionCallbackInfo const&
)>) [node]
33: 0x10432dc28 node::LoadEnvironment(node::Environment*, std::__1::fun
ction<v8::MaybeLocal<v8::Value> (node::StartExecutionCallbackInfo const
&)>) [node]
34: 0x10443d1f4 node::NodeMainInstance::Run(node::ExitCode*, node::Envi
ronment*) [node]
35: 0x10443cfd0 node::NodeMainInstance::Run() [node]
36: 0x1043c5d18 node::Start(int, char**) [node]
37: 0x19a027f28 start [/usr/lib/dyld]
[1]    24458 abort      out/Release/node -p "process.binding('fs').open
()"
```

Now it looks like this:

```
  #  out/Release/node[24856]: void node::fs::Open(const FunctionCallbac
kInfo<v8::Value> &) at ../../src/node_file.cc:2008
  #  Assertion failed: (argc) >= (3)

----- Native stack trace -----

 1: 0x1001efe64 node::Abort() [node]
 2: 0x1001efba4 node::PrintCaughtException(v8::Isolate*, v8::Local<v8::
Context>, v8::TryCatch const&) [node]
 3: 0x1001fb868 node::fs::Open(v8::FunctionCallbackInfo<v8::Value> cons
t&) [node]
 4: 0x100405fd4 v8::internal::MaybeHandle<v8::internal::Object> v8::int
ernal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::
Isolate*, v8::internal::Handle<v8::internal::HeapObject
>, v8::internal::Handle<v8::internal::FunctionTemplateInfo>, v8::intern
al::Handle<v8::internal::Object>, unsigned long*, int) [node
]
 5: 0x100405828 v8::internal::Builtin_HandleApiCall(int, unsigned long*
, v8::internal::Isolate*) [node]
 6: 0x100c90b24 Builtins_CEntry_Return1_ArgvOnStack_BuiltinExit [node]
 7: 0x100c083e4 Builtins_InterpreterEntryTrampoline [node]
 8: 0x100c0650c Builtins_JSEntryTrampoline [node]
 9: 0x100c061f4 Builtins_JSEntry [node]
10: 0x1004e16ac v8::internal::(anonymous namespace)::Invoke(v8::interna
l::Isolate*, v8::internal::(anonymous namespace)::InvokeParams const&)
[node]
11: 0x1004e1cc0 v8::internal::Execution::CallScript(v8::internal::Isola
te*, v8::internal::Handle<v8::internal::JSFunction>, v8::internal::Hand
le<v8::internal::Object>, v8::internal::Handle<v8::in
ternal::Object>) [node]
12: 0x10039e100 v8::Script::Run(v8::Local<v8::Context>, v8::Local<v8::D
ata>) [node]
13: 0x1001e4028 node::contextify::ContextifyScript::EvalMachine(v8::Loc
al<v8::Context>, node::Environment*, long long, bool, bool, bool, v8::M
icrotaskQueue*, v8::FunctionCallbackInfo<v8::Value> const&) [node
]
14: 0x1001e38a0 node::contextify::ContextifyScript::RunInContext(v8::Fu
nctionCallbackInfo<v8::Value> const&) [node]
15: 0x100405fd4 v8::internal::MaybeHandle<v8::internal::Object> v8::int
ernal::(anonymous namespace)::HandleApiCallHelper<false>(v8::internal::
Isolate*, v8::internal::Handle<v8::internal::HeapObject>
, v8::internal::Handle<v8::internal::FunctionTemplateInfo>, v8::interna
l::Handle<v8::internal::Object>, unsigned long*, int) [node
]
16: 0x100405828 v8::internal::Builtin_HandleApiCall(int, unsigned long*
, v8::internal::Isolate*) [node]
17: 0x100c90b24 Builtins_CEntry_Return1_ArgvOnStack_BuiltinExit [node]
18: 0x100c083e4 Builtins_InterpreterEntryTrampoline [node]
19: 0x100c083e4 Builtins_InterpreterEntryTrampoline [node]
20: 0x100c083e4 Builtins_InterpreterEntryTrampoline [node]
21: 0x100c083e4 Builtins_InterpreterEntryTrampoline [node]
22: 0x100c083e4 Builtins_InterpreterEntryTrampoline [node]
23: 0x100c083e4 Builtins_InterpreterEntryTrampoline [node]
24: 0x100c083e4 Builtins_InterpreterEntryTrampoline [node]
25: 0x100c0650c Builtins_JSEntryTrampoline [node]
26: 0x100c061f4 Builtins_JSEntry [node]
27: 0x1004e16ac v8::internal::(anonymous namespace)::Invoke(v8::interna
l::Isolate*, v8::internal::(anonymous namespace)::InvokeParams const&)
[node]
28: 0x1004e0f28 v8::internal::Execution::Call(v8::internal::Isolate*, v
8::internal::Handle<v8::internal::Object>, v8::internal::Handle<v8::int
ernal::Object>, int, v8::internal::Handle<v
8::internal::Object>*) [node]
29: 0x1003b239c v8::Function::Call(v8::Local<v8::Context>, v8::Local<v8
::Value>, int, v8::Local<v8::Value>*) [node]
30: 0x1001d3bc4 node::builtins::BuiltinLoader::CompileAndCall(v8::Local
<v8::Context>, char const*, node::Realm*) [node]
31: 0x100263434 node::Realm::ExecuteBootstrapper(char const*) [node]
32: 0x1001b7838 node::StartExecution(node::Environment*, std::__1::func
tion<v8::MaybeLocal<v8::Value> (node::StartExecutionCallbackInfo const&
)>) [node]
33: 0x100121c28 node::LoadEnvironment(node::Environment*, std::__1::fun
ction<v8::MaybeLocal<v8::Value> (node::StartExecutionCallbackInfo const
&)>) [node]
34: 0x100231354 node::NodeMainInstance::Run(node::ExitCode*, node::Envi
ronment*) [node]
35: 0x100231130 node::NodeMainInstance::Run() [node]
36: 0x1001ba1d8 node::Start(int, char**) [node]
37: 0x19a027f28 start [/usr/lib/dyld]

----- JavaScript stack trace -----

1: [eval]:1:23
2: runScriptInThisContext (node:internal/vm:144:10)
3: node:internal/process/execution:109:14
4: [eval]-wrapper:6:24
5: runScript (node:internal/process/execution:92:62)
6: evalScript (node:internal/process/execution:123:10)
7: node:internal/main/eval_string:51:3

[1]    24856 abort      out/Release/node -p "process.binding('fs').open
()"
```

PR-URL: https://github.com/nodejs/node/pull/50242
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
This commit is contained in:
Joyee Cheung 2023-11-01 17:20:18 +01:00 committed by GitHub
parent a037b88561
commit 30950864d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 176 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/debug_utils.cc
View File

@ -59,6 +59,9 @@ namespace per_process {
EnabledDebugList enabled_debug_list; EnabledDebugList enabled_debug_list;
} }
using v8::Local;
using v8::StackTrace;
void EnabledDebugList::Parse(std::shared_ptr<KVStore> env_vars, void EnabledDebugList::Parse(std::shared_ptr<KVStore> env_vars,
v8::Isolate* isolate) { v8::Isolate* isolate) {
std::string cats; std::string cats;
@ -303,7 +306,8 @@ std::string NativeSymbolDebuggingContext::SymbolInfo::Display() const {
return oss.str(); return oss.str();
} }
void DumpBacktrace(FILE* fp) { void DumpNativeBacktrace(FILE* fp) {
fprintf(fp, "----- Native stack trace -----\n\n");
auto sym_ctx = NativeSymbolDebuggingContext::New(); auto sym_ctx = NativeSymbolDebuggingContext::New();
void* frames[256]; void* frames[256];
const int size = sym_ctx->GetStackTrace(frames, arraysize(frames)); const int size = sym_ctx->GetStackTrace(frames, arraysize(frames));
@ -314,6 +318,22 @@ void DumpBacktrace(FILE* fp) {
} }
} }
void DumpJavaScriptBacktrace(FILE* fp) {
v8::Isolate* isolate = v8::Isolate::GetCurrent();
if (isolate == nullptr) {
return;
}
Local<StackTrace> stack;
if (!GetCurrentStackTrace(isolate).ToLocal(&stack)) {
return;
}
fprintf(fp, "\n----- JavaScript stack trace -----\n\n");
PrintStackTrace(isolate, stack, StackTracePrefix::kNumber);
fprintf(fp, "\n");
}
void CheckedUvLoopClose(uv_loop_t* loop) { void CheckedUvLoopClose(uv_loop_t* loop) {
if (uv_loop_close(loop) == 0) return; if (uv_loop_close(loop) == 0) return;
@ -514,5 +534,6 @@ void FWrite(FILE* file, const std::string& str) {
} // namespace node } // namespace node
extern "C" void __DumpBacktrace(FILE* fp) { extern "C" void __DumpBacktrace(FILE* fp) {
node::DumpBacktrace(fp); node::DumpNativeBacktrace(fp);
node::DumpJavaScriptBacktrace(fp);
} }

3
src/env.cc
View File

@ -1662,7 +1662,8 @@ void AsyncHooks::FailWithCorruptedAsyncStack(double expected_async_id) {
"actual: %.f, expected: %.f)\n", "actual: %.f, expected: %.f)\n",
async_id_fields_.GetValue(kExecutionAsyncId), async_id_fields_.GetValue(kExecutionAsyncId),
expected_async_id); expected_async_id);
DumpBacktrace(stderr); DumpNativeBacktrace(stderr);
DumpJavaScriptBacktrace(stderr);
fflush(stderr); fflush(stderr);
// TODO(joyeecheung): should this exit code be more specific? // TODO(joyeecheung): should this exit code be more specific?
if (!env()->abort_on_uncaught_exception()) Exit(ExitCode::kGenericUserError); if (!env()->abort_on_uncaught_exception()) Exit(ExitCode::kGenericUserError);

81
src/node_errors.cc
View File

@ -1,5 +1,6 @@
#include <cerrno> #include <cerrno>
#include <cstdarg> #include <cstdarg>
#include <sstream>
#include "debug_utils-inl.h" #include "debug_utils-inl.h"
#include "node_errors.h" #include "node_errors.h"
@ -15,6 +16,7 @@ namespace node {
using errors::TryCatchScope; using errors::TryCatchScope;
using v8::Boolean; using v8::Boolean;
using v8::Context; using v8::Context;
using v8::EscapableHandleScope;
using v8::Exception; using v8::Exception;
using v8::Function; using v8::Function;
using v8::FunctionCallbackInfo; using v8::FunctionCallbackInfo;
@ -185,7 +187,46 @@ static std::string GetErrorSource(Isolate* isolate,
return buf + std::string(underline_buf, off); return buf + std::string(underline_buf, off);
} }
static std::string FormatStackTrace(Isolate* isolate, Local<StackTrace> stack) { static std::atomic<bool> is_in_oom{false};
static std::atomic<bool> is_retrieving_js_stacktrace{false};
MaybeLocal<StackTrace> GetCurrentStackTrace(Isolate* isolate, int frame_count) {
if (isolate == nullptr) {
return MaybeLocal<StackTrace>();
}
// Generating JavaScript stack trace can result in V8 fatal error,
// which can re-enter this function.
if (is_retrieving_js_stacktrace.load()) {
return MaybeLocal<StackTrace>();
}
// Can not capture the stacktrace when the isolate is in a OOM state or no
// context is entered.
if (is_in_oom.load() || !isolate->InContext()) {
return MaybeLocal<StackTrace>();
}
constexpr StackTrace::StackTraceOptions options =
static_cast<StackTrace::StackTraceOptions>(
StackTrace::kDetailed |
StackTrace::kExposeFramesAcrossSecurityOrigins);
is_retrieving_js_stacktrace.store(true);
EscapableHandleScope scope(isolate);
Local<StackTrace> stack =
StackTrace::CurrentStackTrace(isolate, frame_count, options);
is_retrieving_js_stacktrace.store(false);
if (stack->GetFrameCount() == 0) {
return MaybeLocal<StackTrace>();
}
return scope.Escape(stack);
}
static std::string FormatStackTrace(
Isolate* isolate,
Local<StackTrace> stack,
StackTracePrefix prefix = StackTracePrefix::kAt) {
std::string result; std::string result;
for (int i = 0; i < stack->GetFrameCount(); i++) { for (int i = 0; i < stack->GetFrameCount(); i++) {
Local<StackFrame> stack_frame = stack->GetFrame(isolate, i); Local<StackFrame> stack_frame = stack->GetFrame(isolate, i);
@ -193,15 +234,18 @@ static std::string FormatStackTrace(Isolate* isolate, Local<StackTrace> stack) {
node::Utf8Value script_name(isolate, stack_frame->GetScriptName()); node::Utf8Value script_name(isolate, stack_frame->GetScriptName());
const int line_number = stack_frame->GetLineNumber(); const int line_number = stack_frame->GetLineNumber();
const int column = stack_frame->GetColumn(); const int column = stack_frame->GetColumn();
std::string prefix_str = prefix == StackTracePrefix::kAt
? " at "
: std::to_string(i + 1) + ": ";
if (stack_frame->IsEval()) { if (stack_frame->IsEval()) {
if (stack_frame->GetScriptId() == Message::kNoScriptIdInfo) { if (stack_frame->GetScriptId() == Message::kNoScriptIdInfo) {
result += SPrintF(" at [eval]:%i:%i\n", line_number, column); result += SPrintF("%s[eval]:%i:%i\n", prefix_str, line_number, column);
} else { } else {
std::vector<char> buf(script_name.length() + 64); std::vector<char> buf(script_name.length() + 64);
snprintf(buf.data(), snprintf(buf.data(),
buf.size(), buf.size(),
" at [eval] (%s:%i:%i)\n", "%s[eval] (%s:%i:%i)\n",
prefix_str.c_str(),
*script_name, *script_name,
line_number, line_number,
column); column);
@ -214,7 +258,8 @@ static std::string FormatStackTrace(Isolate* isolate, Local<StackTrace> stack) {
std::vector<char> buf(script_name.length() + 64); std::vector<char> buf(script_name.length() + 64);
snprintf(buf.data(), snprintf(buf.data(),
buf.size(), buf.size(),
" at %s:%i:%i\n", "%s%s:%i:%i\n",
prefix_str.c_str(),
*script_name, *script_name,
line_number, line_number,
column); column);
@ -223,7 +268,8 @@ static std::string FormatStackTrace(Isolate* isolate, Local<StackTrace> stack) {
std::vector<char> buf(fn_name_s.length() + script_name.length() + 64); std::vector<char> buf(fn_name_s.length() + script_name.length() + 64);
snprintf(buf.data(), snprintf(buf.data(),
buf.size(), buf.size(),
" at %s (%s:%i:%i)\n", "%s%s (%s:%i:%i)\n",
prefix_str.c_str(),
*fn_name_s, *fn_name_s,
*script_name, *script_name,
line_number, line_number,
@ -239,8 +285,10 @@ static void PrintToStderrAndFlush(const std::string& str) {
fflush(stderr); fflush(stderr);
} }
void PrintStackTrace(Isolate* isolate, Local<StackTrace> stack) { void PrintStackTrace(Isolate* isolate,
PrintToStderrAndFlush(FormatStackTrace(isolate, stack)); Local<StackTrace> stack,
StackTracePrefix prefix) {
PrintToStderrAndFlush(FormatStackTrace(isolate, stack, prefix));
} }
std::string FormatCaughtException(Isolate* isolate, std::string FormatCaughtException(Isolate* isolate,
@ -329,7 +377,8 @@ void AppendExceptionLine(Environment* env,
} }
[[noreturn]] void Abort() { [[noreturn]] void Abort() {
DumpBacktrace(stderr); DumpNativeBacktrace(stderr);
DumpJavaScriptBacktrace(stderr);
fflush(stderr); fflush(stderr);
ABORT_NO_BACKTRACE(); ABORT_NO_BACKTRACE();
} }
@ -338,14 +387,15 @@ void AppendExceptionLine(Environment* env,
std::string name = GetHumanReadableProcessName(); std::string name = GetHumanReadableProcessName();
fprintf(stderr, fprintf(stderr,
"%s: %s:%s%s Assertion `%s' failed.\n", "\n"
" # %s: %s at %s\n"
" # Assertion failed: %s\n\n",
name.c_str(), name.c_str(),
info.file_line, info.function ? info.function : "(unknown function)",
info.function, info.file_line ? info.file_line : "(unknown source location)",
*info.function ? ":" : "",
info.message); info.message);
fflush(stderr);
fflush(stderr);
Abort(); Abort();
} }
@ -528,6 +578,9 @@ static void ReportFatalException(Environment* env,
[[noreturn]] void OOMErrorHandler(const char* location, [[noreturn]] void OOMErrorHandler(const char* location,
const v8::OOMDetails& details) { const v8::OOMDetails& details) {
// We should never recover from this handler so once it's true it's always
// true.
is_in_oom.store(true);
const char* message = const char* message =
details.is_heap_oom ? "Allocation failed - JavaScript heap out of memory" details.is_heap_oom ? "Allocation failed - JavaScript heap out of memory"
: "Allocation failed - process out of memory"; : "Allocation failed - process out of memory";

12
src/node_internals.h
View File

@ -79,7 +79,17 @@ void GetSockOrPeerName(const v8::FunctionCallbackInfo<v8::Value>& args) {
args.GetReturnValue().Set(err); args.GetReturnValue().Set(err);
} }
void PrintStackTrace(v8::Isolate* isolate, v8::Local<v8::StackTrace> stack); constexpr int kMaxFrameCountForLogging = 10;
v8::MaybeLocal<v8::StackTrace> GetCurrentStackTrace(
v8::Isolate* isolate, int frame_count = kMaxFrameCountForLogging);
enum class StackTracePrefix {
kAt, // " at "
kNumber
};
void PrintStackTrace(v8::Isolate* isolate,
v8::Local<v8::StackTrace> stack,
StackTracePrefix prefix = StackTracePrefix::kAt);
void PrintCaughtException(v8::Isolate* isolate, void PrintCaughtException(v8::Isolate* isolate,
v8::Local<v8::Context> context, v8::Local<v8::Context> context,
const v8::TryCatch& try_catch); const v8::TryCatch& try_catch);

2
src/node_platform.cc
View File

@ -560,7 +560,7 @@ v8::TracingController* NodePlatform::GetTracingController() {
Platform::StackTracePrinter NodePlatform::GetStackTracePrinter() { Platform::StackTracePrinter NodePlatform::GetStackTracePrinter() {
return []() { return []() {
fprintf(stderr, "\n"); fprintf(stderr, "\n");
DumpBacktrace(stderr); DumpNativeBacktrace(stderr);
fflush(stderr); fflush(stderr);
}; };
} }

21
src/node_report.cc
View File

@ -27,7 +27,7 @@
constexpr int NODE_REPORT_VERSION = 3; constexpr int NODE_REPORT_VERSION = 3;
constexpr int NANOS_PER_SEC = 1000 * 1000 * 1000; constexpr int NANOS_PER_SEC = 1000 * 1000 * 1000;
constexpr double SEC_PER_MICROS = 1e-6; constexpr double SEC_PER_MICROS = 1e-6;
constexpr int MAX_FRAME_COUNT = 10; constexpr int MAX_FRAME_COUNT = node::kMaxFrameCountForLogging;
namespace node { namespace node {
using node::worker::Worker; using node::worker::Worker;
@ -458,14 +458,13 @@ static void PrintEmptyJavaScriptStack(JSONWriter* writer) {
static void PrintJavaScriptStack(JSONWriter* writer, static void PrintJavaScriptStack(JSONWriter* writer,
Isolate* isolate, Isolate* isolate,
const char* trigger) { const char* trigger) {
// Can not capture the stacktrace when the isolate is in a OOM state or no HandleScope scope(isolate);
// context is entered. Local<v8::StackTrace> stack;
if (!strcmp(trigger, "OOMError") || !isolate->InContext()) { if (!GetCurrentStackTrace(isolate, MAX_FRAME_COUNT).ToLocal(&stack)) {
PrintEmptyJavaScriptStack(writer); PrintEmptyJavaScriptStack(writer);
return; return;
} }
HandleScope scope(isolate);
RegisterState state; RegisterState state;
state.pc = nullptr; state.pc = nullptr;
state.fp = &state; state.fp = &state;
@ -476,18 +475,6 @@ static void PrintJavaScriptStack(JSONWriter* writer,
void* samples[MAX_FRAME_COUNT]; void* samples[MAX_FRAME_COUNT];
isolate->GetStackSample(state, samples, MAX_FRAME_COUNT, &info); isolate->GetStackSample(state, samples, MAX_FRAME_COUNT, &info);
constexpr StackTrace::StackTraceOptions stack_trace_options =
static_cast<StackTrace::StackTraceOptions>(
StackTrace::kDetailed |
StackTrace::kExposeFramesAcrossSecurityOrigins);
Local<StackTrace> stack = StackTrace::CurrentStackTrace(
isolate, MAX_FRAME_COUNT, stack_trace_options);
if (stack->GetFrameCount() == 0) {
PrintEmptyJavaScriptStack(writer);
return;
}
writer->json_keyvalue("message", trigger); writer->json_keyvalue("message", trigger);
writer->json_arraystart("stack"); writer->json_arraystart("stack");
for (int i = 0; i < stack->GetFrameCount(); i++) { for (int i = 0; i < stack->GetFrameCount(); i++) {

3
src/util.h
View File

@ -115,7 +115,8 @@ struct AssertionInfo {
}; };
[[noreturn]] void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info); [[noreturn]] void NODE_EXTERN_PRIVATE Assert(const AssertionInfo& info);
[[noreturn]] void NODE_EXTERN_PRIVATE Abort(); [[noreturn]] void NODE_EXTERN_PRIVATE Abort();
void DumpBacktrace(FILE* fp); void DumpNativeBacktrace(FILE* fp);
void DumpJavaScriptBacktrace(FILE* fp);
// Windows 8+ does not like abort() in Release mode // Windows 8+ does not like abort() in Release mode
#ifdef _WIN32 #ifdef _WIN32

25
test/abort/test-abort-backtrace.js
View File

@ -10,19 +10,22 @@ if (process.argv[2] === 'child') {
const stderr = child.stderr.toString(); const stderr = child.stderr.toString();
assert.strictEqual(child.stdout.toString(), ''); assert.strictEqual(child.stdout.toString(), '');
// Stderr will be empty for systems that don't support backtraces. const { nativeStack, jsStack } = common.getPrintedStackTrace(stderr);
if (stderr !== '') {
const frames = stderr.trimRight().split('\n').map((s) => s.trim());
if (!frames.every((frame, index) => frame.startsWith(`${index + 1}:`))) { if (!nativeStack.every((frame, index) => frame.startsWith(`${index + 1}:`))) {
assert.fail(`Each frame should start with a frame number:\n${stderr}`); assert.fail(`Each frame should start with a frame number:\n${stderr}`);
} }
if (!common.isWindows) { // For systems that don't support backtraces, the native stack is
const { getBinaryPath } = require('../common/shared-lib-util'); // going to be empty.
if (!frames.some((frame) => frame.includes(`[${getBinaryPath()}]`))) { if (!common.isWindows && nativeStack.length > 0) {
assert.fail(`Some frames should include the binary name:\n${stderr}`); const { getBinaryPath } = require('../common/shared-lib-util');
} if (!nativeStack.some((frame) => frame.includes(`[${getBinaryPath()}]`))) {
assert.fail(`Some native stack frame include the binary name:\n${stderr}`);
} }
} }
if (jsStack.length > 0) {
assert(jsStack.some((frame) => frame.includes(__filename)));
}
} }

7
test/abort/test-abort-fatal-error.js
View File

@ -38,10 +38,5 @@ exec(cmdline, function(err, stdout, stderr) {
assert(false, 'this test should fail'); assert(false, 'this test should fail');
} }
if (err.code !== 134 && err.signal !== 'SIGABRT') { assert(common.nodeProcessAborted(err.code, err.signal));
console.log(stdout);
console.log(stderr);
console.log(err);
assert(false, err);
}
}); });

11
test/abort/test-addon-uv-handle-leak.js
View File

@ -88,6 +88,9 @@ if (process.argv[2] === 'child') {
while (lines.length > 0) { while (lines.length > 0) {
const line = lines.shift().trim(); const line = lines.shift().trim();
if (line.length === 0) {
continue; // Skip empty lines.
}
switch (state) { switch (state) {
case 'initial': case 'initial':
@ -96,7 +99,7 @@ if (process.argv[2] === 'child') {
break; break;
case 'handle-start': case 'handle-start':
if (/^uv loop at \[.+\] has \d+ open handles in total$/.test(line)) { if (/^uv loop at \[.+\] has \d+ open handles in total$/.test(line)) {
state = 'assertion-failure'; state = 'source-line';
break; break;
} }
assert.match(line, /^\[.+\] timer( \(active\))?$/); assert.match(line, /^\[.+\] timer( \(active\))?$/);
@ -116,8 +119,12 @@ if (process.argv[2] === 'child') {
} }
state = 'handle-start'; state = 'handle-start';
break; break;
case 'source-line':
assert.match(line, /CheckedUvLoopClose/);
state = 'assertion-failure';
break;
case 'assertion-failure': case 'assertion-failure':
assert.match(line, /Assertion .+ failed/); assert.match(line, /Assertion failed:/);
state = 'done'; state = 'done';
break; break;
case 'done': case 'done':

40
test/common/index.js
View File

@ -906,6 +906,45 @@ function spawnPromisified(...args) {
}); });
} }
function getPrintedStackTrace(stderr) {
const lines = stderr.split('\n');
let state = 'initial';
const result = {
message: [],
nativeStack: [],
jsStack: [],
};
for (let i = 0; i < lines.length; ++i) {
const line = lines[i].trim();
if (line.length === 0) {
continue; // Skip empty lines.
}
switch (state) {
case 'initial':
result.message.push(line);
if (line.includes('Native stack trace')) {
state = 'native-stack';
} else {
result.message.push(line);
}
break;
case 'native-stack':
if (line.includes('JavaScript stack trace')) {
state = 'js-stack';
} else {
result.nativeStack.push(line);
}
break;
case 'js-stack':
result.jsStack.push(line);
break;
}
}
return result;
}
const common = { const common = {
allowGlobals, allowGlobals,
buildType, buildType,
@ -919,6 +958,7 @@ const common = {
getArrayBufferViews, getArrayBufferViews,
getBufferSources, getBufferSources,
getCallSite, getCallSite,
getPrintedStackTrace,
getTTYfd, getTTYfd,
hasIntl, hasIntl,
hasCrypto, hasCrypto,

2
test/js-native-api/test_finalizer/test_fatal_finalize.js
View File

@ -27,5 +27,5 @@ const { spawnSync } = require('child_process');
const child = spawnSync(process.execPath, [ const child = spawnSync(process.execPath, [
'--expose-gc', __filename, 'child', '--expose-gc', __filename, 'child',
]); ]);
assert.strictEqual(child.signal, common.isWindows ? null : 'SIGABRT'); assert(common.nodeProcessAborted(child.status, child.signal));
assert.match(child.stderr.toString(), /Finalizer is calling a function that may affect GC state/); assert.match(child.stderr.toString(), /Finalizer is calling a function that may affect GC state/);

2
test/node-api/test_fatal/test_threads.js
View File

@ -18,4 +18,4 @@ const p = child_process.spawnSync(
assert.ifError(p.error); assert.ifError(p.error);
assert.ok(p.stderr.toString().includes( assert.ok(p.stderr.toString().includes(
'FATAL ERROR: work_thread foobar')); 'FATAL ERROR: work_thread foobar'));
assert.ok(p.status === 134 || p.signal === 'SIGABRT'); assert(common.nodeProcessAborted(p.status, p.signal));