1 |
|
|
#ifndef SRC_NODE_ERRORS_H_ |
2 |
|
|
#define SRC_NODE_ERRORS_H_ |
3 |
|
|
|
4 |
|
|
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS |
5 |
|
|
|
6 |
|
|
#include "node.h" |
7 |
|
|
#include "util.h" |
8 |
|
|
#include "env.h" |
9 |
|
|
#include "v8.h" |
10 |
|
|
|
11 |
|
|
// Use ostringstream to print exact-width integer types |
12 |
|
|
// because the format specifiers are not available on AIX. |
13 |
|
|
#include <sstream> |
14 |
|
|
|
15 |
|
|
namespace node { |
16 |
|
|
|
17 |
|
|
using v8::Local; |
18 |
|
|
using v8::Message; |
19 |
|
|
using v8::Value; |
20 |
|
|
|
21 |
|
|
enum ErrorHandlingMode { CONTEXTIFY_ERROR, FATAL_ERROR, MODULE_ERROR }; |
22 |
|
|
void AppendExceptionLine(Environment* env, |
23 |
|
|
Local<Value> er, |
24 |
|
|
Local<Message> message, |
25 |
|
|
enum ErrorHandlingMode mode); |
26 |
|
|
|
27 |
|
|
[[noreturn]] void FatalError(const char* location, const char* message); |
28 |
|
|
void OnFatalError(const char* location, const char* message); |
29 |
|
|
|
30 |
|
|
void PrintErrorString(const char* format, ...); |
31 |
|
|
|
32 |
|
|
// Helpers to construct errors similar to the ones provided by |
33 |
|
|
// lib/internal/errors.js. |
34 |
|
|
// Example: with `V(ERR_INVALID_ARG_TYPE, TypeError)`, there will be |
35 |
|
|
// `node::ERR_INVALID_ARG_TYPE(isolate, "message")` returning |
36 |
|
|
// a `Local<Value>` containing the TypeError with proper code and message |
37 |
|
|
|
38 |
|
|
#define ERRORS_WITH_CODE(V) \ |
39 |
|
|
V(ERR_BUFFER_CONTEXT_NOT_AVAILABLE, Error) \ |
40 |
|
|
V(ERR_BUFFER_OUT_OF_BOUNDS, RangeError) \ |
41 |
|
|
V(ERR_BUFFER_TOO_LARGE, Error) \ |
42 |
|
|
V(ERR_CONSTRUCT_CALL_REQUIRED, TypeError) \ |
43 |
|
|
V(ERR_CONSTRUCT_CALL_INVALID, TypeError) \ |
44 |
|
|
V(ERR_INVALID_ARG_VALUE, TypeError) \ |
45 |
|
|
V(ERR_OSSL_EVP_INVALID_DIGEST, Error) \ |
46 |
|
|
V(ERR_INVALID_ARG_TYPE, TypeError) \ |
47 |
|
|
V(ERR_INVALID_MODULE_SPECIFIER, TypeError) \ |
48 |
|
|
V(ERR_INVALID_PACKAGE_CONFIG, SyntaxError) \ |
49 |
|
|
V(ERR_INVALID_TRANSFER_OBJECT, TypeError) \ |
50 |
|
|
V(ERR_MEMORY_ALLOCATION_FAILED, Error) \ |
51 |
|
|
V(ERR_MISSING_ARGS, TypeError) \ |
52 |
|
|
V(ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST, TypeError) \ |
53 |
|
|
V(ERR_MISSING_PASSPHRASE, TypeError) \ |
54 |
|
|
V(ERR_MISSING_PLATFORM_FOR_WORKER, Error) \ |
55 |
|
|
V(ERR_MODULE_NOT_FOUND, Error) \ |
56 |
|
|
V(ERR_OUT_OF_RANGE, RangeError) \ |
57 |
|
|
V(ERR_SCRIPT_EXECUTION_INTERRUPTED, Error) \ |
58 |
|
|
V(ERR_SCRIPT_EXECUTION_TIMEOUT, Error) \ |
59 |
|
|
V(ERR_STRING_TOO_LONG, Error) \ |
60 |
|
|
V(ERR_TLS_INVALID_PROTOCOL_METHOD, TypeError) \ |
61 |
|
|
V(ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER, TypeError) \ |
62 |
|
|
|
63 |
|
|
#define V(code, type) \ |
64 |
|
|
inline v8::Local<v8::Value> code(v8::Isolate* isolate, \ |
65 |
|
|
const char* message) { \ |
66 |
|
|
v8::Local<v8::String> js_code = OneByteString(isolate, #code); \ |
67 |
|
|
v8::Local<v8::String> js_msg = OneByteString(isolate, message); \ |
68 |
|
|
v8::Local<v8::Object> e = \ |
69 |
|
|
v8::Exception::type(js_msg)->ToObject( \ |
70 |
|
|
isolate->GetCurrentContext()).ToLocalChecked(); \ |
71 |
|
|
e->Set(isolate->GetCurrentContext(), OneByteString(isolate, "code"), \ |
72 |
|
|
js_code).Check(); \ |
73 |
|
|
return e; \ |
74 |
|
|
} \ |
75 |
|
|
inline void THROW_ ## code(v8::Isolate* isolate, const char* message) { \ |
76 |
|
|
isolate->ThrowException(code(isolate, message)); \ |
77 |
|
|
} \ |
78 |
|
|
inline void THROW_ ## code(Environment* env, const char* message) { \ |
79 |
|
|
THROW_ ## code(env->isolate(), message); \ |
80 |
|
|
} |
81 |
|
6650 |
ERRORS_WITH_CODE(V) |
82 |
|
|
#undef V |
83 |
|
|
|
84 |
|
|
// Errors with predefined static messages |
85 |
|
|
|
86 |
|
|
#define PREDEFINED_ERROR_MESSAGES(V) \ |
87 |
|
|
V(ERR_BUFFER_CONTEXT_NOT_AVAILABLE, \ |
88 |
|
|
"Buffer is not available for the current Context") \ |
89 |
|
|
V(ERR_CONSTRUCT_CALL_INVALID, "Constructor cannot be called") \ |
90 |
|
|
V(ERR_CONSTRUCT_CALL_REQUIRED, "Cannot call constructor without `new`") \ |
91 |
|
|
V(ERR_INVALID_TRANSFER_OBJECT, "Found invalid object in transferList") \ |
92 |
|
|
V(ERR_MEMORY_ALLOCATION_FAILED, "Failed to allocate memory") \ |
93 |
|
|
V(ERR_OSSL_EVP_INVALID_DIGEST, "Invalid digest used") \ |
94 |
|
|
V(ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST, \ |
95 |
|
|
"MessagePort was found in message but not listed in transferList") \ |
96 |
|
|
V(ERR_MISSING_PLATFORM_FOR_WORKER, \ |
97 |
|
|
"The V8 platform used by this instance of Node does not support " \ |
98 |
|
|
"creating Workers") \ |
99 |
|
|
V(ERR_SCRIPT_EXECUTION_INTERRUPTED, \ |
100 |
|
|
"Script execution was interrupted by `SIGINT`") \ |
101 |
|
|
V(ERR_TRANSFERRING_EXTERNALIZED_SHAREDARRAYBUFFER, \ |
102 |
|
|
"Cannot serialize externalized SharedArrayBuffer") \ |
103 |
|
|
|
104 |
|
|
#define V(code, message) \ |
105 |
|
|
inline v8::Local<v8::Value> code(v8::Isolate* isolate) { \ |
106 |
|
|
return code(isolate, message); \ |
107 |
|
|
} \ |
108 |
|
|
inline void THROW_ ## code(v8::Isolate* isolate) { \ |
109 |
|
|
isolate->ThrowException(code(isolate, message)); \ |
110 |
|
|
} \ |
111 |
|
|
inline void THROW_ ## code(Environment* env) { \ |
112 |
|
|
THROW_ ## code(env->isolate()); \ |
113 |
|
|
} |
114 |
|
33 |
PREDEFINED_ERROR_MESSAGES(V) |
115 |
|
|
#undef V |
116 |
|
|
|
117 |
|
|
// Errors with predefined non-static messages |
118 |
|
511 |
inline void THROW_ERR_SCRIPT_EXECUTION_TIMEOUT(Environment* env, |
119 |
|
|
int64_t timeout) { |
120 |
|
511 |
std::ostringstream message; |
121 |
|
511 |
message << "Script execution timed out after "; |
122 |
|
511 |
message << timeout << "ms"; |
123 |
|
511 |
THROW_ERR_SCRIPT_EXECUTION_TIMEOUT(env, message.str().c_str()); |
124 |
|
511 |
} |
125 |
|
|
|
126 |
|
|
inline v8::Local<v8::Value> ERR_BUFFER_TOO_LARGE(v8::Isolate* isolate) { |
127 |
|
|
char message[128]; |
128 |
|
|
snprintf(message, sizeof(message), |
129 |
|
|
"Cannot create a Buffer larger than 0x%zx bytes", |
130 |
|
|
v8::TypedArray::kMaxLength); |
131 |
|
|
return ERR_BUFFER_TOO_LARGE(isolate, message); |
132 |
|
|
} |
133 |
|
|
|
134 |
|
8 |
inline v8::Local<v8::Value> ERR_STRING_TOO_LONG(v8::Isolate* isolate) { |
135 |
|
|
char message[128]; |
136 |
|
|
snprintf(message, sizeof(message), |
137 |
|
|
"Cannot create a string longer than 0x%x characters", |
138 |
|
8 |
v8::String::kMaxLength); |
139 |
|
8 |
return ERR_STRING_TOO_LONG(isolate, message); |
140 |
|
|
} |
141 |
|
|
|
142 |
|
|
#define THROW_AND_RETURN_IF_NOT_BUFFER(env, val, prefix) \ |
143 |
|
|
do { \ |
144 |
|
|
if (!Buffer::HasInstance(val)) \ |
145 |
|
|
return node::THROW_ERR_INVALID_ARG_TYPE(env, \ |
146 |
|
|
prefix " must be a buffer"); \ |
147 |
|
|
} while (0) |
148 |
|
|
|
149 |
|
|
#define THROW_AND_RETURN_IF_NOT_STRING(env, val, prefix) \ |
150 |
|
|
do { \ |
151 |
|
|
if (!val->IsString()) \ |
152 |
|
|
return node::THROW_ERR_INVALID_ARG_TYPE(env, \ |
153 |
|
|
prefix " must be a string"); \ |
154 |
|
|
} while (0) |
155 |
|
|
|
156 |
|
|
namespace errors { |
157 |
|
|
|
158 |
|
|
class TryCatchScope : public v8::TryCatch { |
159 |
|
|
public: |
160 |
|
|
enum class CatchMode { kNormal, kFatal }; |
161 |
|
|
|
162 |
|
230729 |
explicit TryCatchScope(Environment* env, CatchMode mode = CatchMode::kNormal) |
163 |
|
230729 |
: v8::TryCatch(env->isolate()), env_(env), mode_(mode) {} |
164 |
|
|
~TryCatchScope(); |
165 |
|
|
|
166 |
|
|
// Since the dtor is not virtual we need to make sure no one creates |
167 |
|
|
// object of it in the free store that might be held by polymorphic pointers. |
168 |
|
|
void* operator new(std::size_t count) = delete; |
169 |
|
|
void* operator new[](std::size_t count) = delete; |
170 |
|
|
TryCatchScope(TryCatchScope&) = delete; |
171 |
|
|
TryCatchScope(TryCatchScope&&) = delete; |
172 |
|
|
TryCatchScope operator=(TryCatchScope&) = delete; |
173 |
|
|
TryCatchScope operator=(TryCatchScope&&) = delete; |
174 |
|
|
|
175 |
|
|
private: |
176 |
|
|
Environment* env_; |
177 |
|
|
CatchMode mode_; |
178 |
|
|
}; |
179 |
|
|
|
180 |
|
|
// Trigger the global uncaught exception handler `process._fatalException` |
181 |
|
|
// in JS land (which emits the 'uncaughtException' event). If that returns |
182 |
|
|
// true, continue program execution, otherwise exit the process. |
183 |
|
|
void TriggerUncaughtException(v8::Isolate* isolate, |
184 |
|
|
const v8::TryCatch& try_catch); |
185 |
|
|
void TriggerUncaughtException(v8::Isolate* isolate, |
186 |
|
|
Local<Value> error, |
187 |
|
|
Local<Message> message, |
188 |
|
|
bool from_promise = false); |
189 |
|
|
|
190 |
|
|
const char* errno_string(int errorno); |
191 |
|
|
void PerIsolateMessageListener(v8::Local<v8::Message> message, |
192 |
|
|
v8::Local<v8::Value> error); |
193 |
|
|
|
194 |
|
|
void DecorateErrorStack(Environment* env, |
195 |
|
|
const errors::TryCatchScope& try_catch); |
196 |
|
|
} // namespace errors |
197 |
|
|
|
198 |
|
|
} // namespace node |
199 |
|
|
|
200 |
|
|
#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS |
201 |
|
|
|
202 |
|
|
#endif // SRC_NODE_ERRORS_H_ |