From f55b3ed3fe646eb3ab054625228b2c67bec0057f Mon Sep 17 00:00:00 2001 From: pluris Date: Tue, 24 Oct 2023 12:41:35 +0900 Subject: [PATCH] fs: improve error performance for `writeSync` --- benchmark/fs/bench-writeSync.js | 54 +++++++++++++++++++++++++++++++++ lib/fs.js | 8 ++--- src/node_file.cc | 36 ++++++++++++++-------- typings/internalBinding/fs.d.ts | 4 +-- 4 files changed, 81 insertions(+), 21 deletions(-) create mode 100644 benchmark/fs/bench-writeSync.js diff --git a/benchmark/fs/bench-writeSync.js b/benchmark/fs/bench-writeSync.js new file mode 100644 index 00000000000000..4edef0babca724 --- /dev/null +++ b/benchmark/fs/bench-writeSync.js @@ -0,0 +1,54 @@ +'use strict'; + +const common = require('../common'); +const fs = require('fs'); +const assert = require('assert'); +const tmpdir = require('../../test/common/tmpdir'); +tmpdir.refresh(); + +const path = tmpdir.resolve(`new-file-${process.pid}`); +const parameters = [Buffer.from('Benchmark data'), + 0, + Buffer.byteLength('Benchmark data')]; +const bench = common.createBenchmark(main, { + type: ['valid', 'invalid'], + n: [1e5], +}); + +function main({ n, type }) { + let fd; + let result; + + switch (type) { + case 'valid': + fd = fs.openSync(path, 'w'); + + bench.start(); + for (let i = 0; i < n; i++) { + result = fs.writeSync(fd, ...parameters); + } + + bench.end(n); + assert(result); + fs.closeSync(fd); + break; + case 'invalid': { + fd = 1 << 30; + let hasError = false; + bench.start(); + for (let i = 0; i < n; i++) { + try { + result = fs.writeSync(fd, ...parameters); + } catch { + hasError = true; + } + } + + bench.end(n); + assert(hasError); + break; + } + default: + throw new Error('Invalid type'); + } +} diff --git a/lib/fs.js b/lib/fs.js index 53885d9478017f..fd6df149bcf071 100644 --- a/lib/fs.js +++ b/lib/fs.js @@ -899,7 +899,6 @@ ObjectDefineProperty(write, kCustomPromisifyArgsSymbol, */ function writeSync(fd, buffer, offsetOrOptions, length, position) { fd = getValidatedFd(fd); - const ctx = {}; let result; let offset = offsetOrOptions; @@ -921,18 +920,15 @@ function writeSync(fd, buffer, offsetOrOptions, length, position) { if (typeof length !== 'number') length = buffer.byteLength - offset; validateOffsetLengthWrite(offset, length, buffer.byteLength); - result = binding.writeBuffer(fd, buffer, offset, length, position, - undefined, ctx); + result = binding.writeBuffer(fd, buffer, offset, length, position); } else { validateStringAfterArrayBufferView(buffer, 'buffer'); validateEncoding(buffer, length); if (offset === undefined) offset = null; - result = binding.writeString(fd, buffer, offset, length, - undefined, ctx); + result = binding.writeString(fd, buffer, offset, length); } - handleErrorFromBinding(ctx); return result; } diff --git a/src/node_file.cc b/src/node_file.cc index bda1774c012e7b..075452ac9da158 100644 --- a/src/node_file.cc +++ b/src/node_file.cc @@ -2098,7 +2098,7 @@ static void WriteBuffer(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); const int argc = args.Length(); - CHECK_GE(argc, 4); + CHECK_GE(argc, 5); CHECK(args[0]->IsInt32()); const int fd = args[0].As()->Value(); @@ -2125,18 +2125,23 @@ static void WriteBuffer(const FunctionCallbackInfo& args) { char* buf = buffer_data + off; uv_buf_t uvbuf = uv_buf_init(buf, len); - FSReqBase* req_wrap_async = GetReqWrap(args, 5); - if (req_wrap_async != nullptr) { // write(fd, buffer, off, len, pos, req) + if (argc > 5) { // write(fd, buffer, off, len, pos, req) + FSReqBase* req_wrap_async = GetReqWrap(args, 5); + CHECK_NOT_NULL(req_wrap_async); FS_ASYNC_TRACE_BEGIN0(UV_FS_WRITE, req_wrap_async) AsyncCall(env, req_wrap_async, args, "write", UTF8, AfterInteger, uv_fs_write, fd, &uvbuf, 1, pos); - } else { // write(fd, buffer, off, len, pos, undefined, ctx) - CHECK_EQ(argc, 7); - FSReqWrapSync req_wrap_sync; + } else { // write(fd, buffer, off, len, pos) + FSReqWrapSync req_wrap_sync("write"); FS_SYNC_TRACE_BEGIN(write); - int bytesWritten = SyncCall(env, args[6], &req_wrap_sync, "write", - uv_fs_write, fd, &uvbuf, 1, pos); + int bytesWritten = SyncCallAndThrowOnError(env, &req_wrap_sync, uv_fs_write, + fd, &uvbuf, 1, pos); FS_SYNC_TRACE_END(write, "bytesWritten", bytesWritten); + + if (is_uv_error(bytesWritten)) { + return; + } + args.GetReturnValue().Set(bytesWritten); } } @@ -2273,9 +2278,9 @@ static void WriteString(const FunctionCallbackInfo& args) { } else { req_wrap_async->SetReturnValue(args); } - } else { // write(fd, string, pos, enc, undefined, ctx) - CHECK_EQ(argc, 6); - FSReqWrapSync req_wrap_sync; + } else { // write(fd, string, pos, enc) + CHECK_EQ(argc, 4); + FSReqWrapSync req_wrap_sync("write"); FSReqBase::FSReqBuffer stack_buffer; if (buf == nullptr) { if (!StringBytes::StorageSize(isolate, value, enc).To(&len)) @@ -2290,9 +2295,14 @@ static void WriteString(const FunctionCallbackInfo& args) { } uv_buf_t uvbuf = uv_buf_init(buf, len); FS_SYNC_TRACE_BEGIN(write); - int bytesWritten = SyncCall(env, args[5], &req_wrap_sync, "write", - uv_fs_write, fd, &uvbuf, 1, pos); + int bytesWritten = SyncCallAndThrowOnError(env, &req_wrap_sync, uv_fs_write, + fd, &uvbuf, 1, pos); FS_SYNC_TRACE_END(write, "bytesWritten", bytesWritten); + + if (is_uv_error(bytesWritten)) { + return; + } + args.GetReturnValue().Set(bytesWritten); } } diff --git a/typings/internalBinding/fs.d.ts b/typings/internalBinding/fs.d.ts index 77f20e9550e30a..92838708a0659c 100644 --- a/typings/internalBinding/fs.d.ts +++ b/typings/internalBinding/fs.d.ts @@ -219,7 +219,7 @@ declare namespace InternalFSBinding { function utimes(path: string, atime: number, mtime: number, usePromises: typeof kUsePromises): Promise; function writeBuffer(fd: number, buffer: ArrayBufferView, offset: number, length: number, position: number | null, req: FSReqCallback): void; - function writeBuffer(fd: number, buffer: ArrayBufferView, offset: number, length: number, position: number | null, req: undefined, ctx: FSSyncContext): number; + function writeBuffer(fd: number, buffer: ArrayBufferView, offset: number, length: number, position: number | null): number; function writeBuffer(fd: number, buffer: ArrayBufferView, offset: number, length: number, position: number | null, usePromises: typeof kUsePromises): Promise; function writeBuffers(fd: number, buffers: ArrayBufferView[], position: number, req: FSReqCallback): void; @@ -227,7 +227,7 @@ declare namespace InternalFSBinding { function writeBuffers(fd: number, buffers: ArrayBufferView[], position: number, usePromises: typeof kUsePromises): Promise; function writeString(fd: number, value: string, pos: unknown, encoding: unknown, req: FSReqCallback): void; - function writeString(fd: number, value: string, pos: unknown, encoding: unknown, req: undefined, ctx: FSSyncContext): number; + function writeString(fd: number, value: string, pos: unknown, encoding: unknown): number; function writeString(fd: number, value: string, pos: unknown, encoding: unknown, usePromises: typeof kUsePromises): Promise; function getFormatOfExtensionlessFile(url: string): ConstantsBinding['fs'];