FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

src: show original file name in FileHandle GC close errors · nodejs/node@fbb3960 · GitHub

/ node Public

Commit fbb3960

Browse files
addaleax
authored and
aduh95
committed
src: show original file name in FileHandle GC close errors
Otherwise, it can be virtually impossible to debug where these types of errors originate from. PR-URL: #60593 Backport-PR-URL: #64675 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
1 parent 2cc54e1 commit fbb3960

3 files changed

Lines changed: 32 additions & 17 deletions

File tree

‎src/dataqueue/queue.cc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -916,6 +916,7 @@ class FdEntry final : public EntryImpl {
916916
fs::FileHandle::New(realm->GetBindingData<fs::BindingData>(),
917917
file,
918918
Local<Object>(),
919+
{},
919920
entry->start_,
920921
entry->end_ - entry->start_)),
921922
entry);

‎src/node_file.cc‎

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -222,9 +222,12 @@ void FSReqBase::MemoryInfo(MemoryTracker* tracker) const {
222222
// collection if necessary. If that happens, a process warning will be
223223
// emitted (or a fatal exception will occur if the fd cannot be closed.)
224224
FileHandle::FileHandle(BindingData* binding_data,
225-
Local<Object> obj, int fd)
225+
Local<Object> obj,
226+
int fd,
227+
std::string original_name)
226228
: AsyncWrap(binding_data->env(), obj, AsyncWrap::PROVIDER_FILEHANDLE),
227229
StreamBase(env()),
230+
original_name_(std::move(original_name)),
228231
fd_(fd),
229232
binding_data_(binding_data) {
230233
MakeWeak();
@@ -234,6 +237,7 @@ FileHandle::FileHandle(BindingData* binding_data,
234237
FileHandle* FileHandle::New(BindingData* binding_data,
235238
int fd,
236239
Local<Object> obj,
240+
std::string original_name,
237241
std::optional<int64_t> maybeOffset,
238242
std::optional<int64_t> maybeLength) {
239243
Environment* env = binding_data->env();
@@ -242,7 +246,7 @@ FileHandle* FileHandle::New(BindingData* binding_data,
242246
.ToLocal(&obj)) {
243247
return nullptr;
244248
}
245-
auto handle = new FileHandle(binding_data, obj, fd);
249+
auto handle = new FileHandle(binding_data, obj, fd, original_name);
246250
if (maybeOffset.has_value()) handle->read_offset_ = maybeOffset.value();
247251
if (maybeLength.has_value()) handle->read_length_ = maybeLength.value();
248252
return handle;
@@ -274,6 +278,7 @@ void FileHandle::New(const FunctionCallbackInfo<Value>& args) {
274278
FileHandle::New(binding_data,
275279
args[0].As<Int32>()->Value(),
276280
args.This(),
281+
{},
277282
maybeOffset,
278283
maybeLength);
279284
}
@@ -293,6 +298,7 @@ int FileHandle::DoWrite(WriteWrap* w,
293298

294299
void FileHandle::MemoryInfo(MemoryTracker* tracker) const {
295300
tracker->TrackField("current_read", current_read_);
301+
tracker->TrackField("original_name", original_name_);
296302
}
297303

298304
BaseObject::TransferMode FileHandle::GetTransferMode() const {
@@ -346,25 +352,28 @@ inline void FileHandle::Close() {
346352
FS_SYNC_TRACE_END(close);
347353
uv_fs_req_cleanup(&req);
348354

349-
struct err_detail { int ret; int fd; };
355+
struct err_detail {
356+
int ret;
357+
int fd;
358+
std::string name;
359+
};
350360

351-
err_detail detail { ret, fd_ };
361+
err_detail detail{ret, fd_, original_name_};
352362

353363
AfterClose();
354364

355365
if (ret < 0) {
356366
// Do not unref this
357367
env()->SetImmediate([detail](Environment* env) {
358-
char msg[70];
359-
snprintf(msg, arraysize(msg),
360-
"Closing file descriptor %d on garbage collection failed",
361-
detail.fd);
362-
// This exception will end up being fatal for the process because
363-
// it is being thrown from within the SetImmediate handler and
364-
// there is no JS stack to bubble it to. In other words, tearing
365-
// down the process is the only reasonable thing we can do here.
366368
HandleScope handle_scope(env->isolate());
367-
env->ThrowUVException(detail.ret, "close", msg);
369+
static constexpr std::string_view unknown_path = "<unknown path>";
370+
std::string_view filename =
371+
detail.name.empty() ? unknown_path : detail.name;
372+
auto formatted = SPrintF(
373+
"Closing file descriptor %d on garbage collection failed (%s)",
374+
detail.fd,
375+
filename);
376+
env->ThrowUVException(detail.ret, "close", formatted.c_str());
368377
});
369378
return;
370379
}
@@ -846,8 +855,8 @@ void AfterOpenFileHandle(uv_fs_t* req) {
846855
FS_ASYNC_TRACE_END1(
847856
req->fs_type, req_wrap, "result", static_cast<int>(req->result))
848857
if (after.Proceed()) {
849-
FileHandle* fd = FileHandle::New(req_wrap->binding_data(),
850-
static_cast<int>(req->result));
858+
FileHandle* fd = FileHandle::New(
859+
req_wrap->binding_data(), static_cast<int>(req->result), {}, req->path);
851860
if (fd == nullptr) return;
852861
req_wrap->Resolve(fd->object());
853862
}
@@ -2277,7 +2286,7 @@ static void OpenFileHandle(const FunctionCallbackInfo<Value>& args) {
22772286
if (result < 0) {
22782287
return; // syscall failed, no need to continue, error info is in ctx
22792288
}
2280-
FileHandle* fd = FileHandle::New(binding_data, result);
2289+
FileHandle* fd = FileHandle::New(binding_data, result, {}, path.ToString());
22812290
if (fd == nullptr) return;
22822291
args.GetReturnValue().Set(fd->object());
22832292
}

‎src/node_file.h‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,7 @@ class FileHandle final : public AsyncWrap, public StreamBase {
331331
static FileHandle* New(BindingData* binding_data,
332332
int fd,
333333
v8::Local<v8::Object> obj = v8::Local<v8::Object>(),
334+
std::string original_name = {},
334335
std::optional<int64_t> maybeOffset = std::nullopt,
335336
std::optional<int64_t> maybeLength = std::nullopt);
336337
~FileHandle() override;
@@ -397,7 +398,10 @@ class FileHandle final : public AsyncWrap, public StreamBase {
397398
int fd_;
398399
};
399400

400-
FileHandle(BindingData* binding_data, v8::Local<v8::Object> obj, int fd);
401+
FileHandle(BindingData* binding_data,
402+
v8::Local<v8::Object> obj,
403+
int fd,
404+
std::string original_name);
401405

402406
// Synchronous close that emits a warning
403407
void Close();
@@ -439,6 +443,7 @@ class FileHandle final : public AsyncWrap, public StreamBase {
439443
// Asynchronous close
440444
v8::MaybeLocal<v8::Promise> ClosePromise();
441445

446+
std::string original_name_;
442447
int fd_;
443448
bool closing_ = false;
444449
bool closed_ = false;

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL