Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fs: use fast api calls for existsSync #49893

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/node_external_reference.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ using CFunctionCallbackWithStrings =
const v8::FastOneByteString& base);
using CFunctionWithUint32 = uint32_t (*)(v8::Local<v8::Value>,
const uint32_t input);
using CFunctionCallbackWithStringOptions =
bool (*)(v8::Local<v8::Object>,
const v8::FastOneByteString& input,
// NOLINTNEXTLINE(runtime/references) This is V8 api.
v8::FastApiCallbackOptions& options);

// This class manages the external references from the V8 heap
// to the C++ addresses in Node.js.
Expand All @@ -41,6 +46,7 @@ class ExternalReferenceRegistry {
V(CFunctionCallbackWithInt64) \
V(CFunctionCallbackWithBool) \
V(CFunctionCallbackWithString) \
V(CFunctionCallbackWithStringOptions) \
V(CFunctionCallbackWithStrings) \
V(CFunctionWithUint32) \
V(const v8::CFunctionInfo*) \
Expand Down
49 changes: 48 additions & 1 deletion src/node_file.cc
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
#include "node_stat_watcher.h"
#include "permission/permission.h"
#include "util-inl.h"
#include "v8-fast-api-calls.h"

#include "tracing/trace_event.h"

Expand All @@ -57,8 +58,11 @@ namespace fs {

using v8::Array;
using v8::BigInt;
using v8::CFunction;
using v8::Context;
using v8::EscapableHandleScope;
using v8::FastApiCallbackOptions;
using v8::FastOneByteString;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
Expand Down Expand Up @@ -1095,6 +1099,46 @@ static void ExistsSync(const FunctionCallbackInfo<Value>& args) {
args.GetReturnValue().Set(err == 0);
}

bool FastExistsSync(v8::Local<v8::Object> recv,
const FastOneByteString& string,
// NOLINTNEXTLINE(runtime/references) This is V8 api.
FastApiCallbackOptions& options) {
Environment* env = Environment::GetCurrent(recv->GetCreationContextChecked());

MaybeStackBuffer<char> path;

path.AllocateSufficientStorage(string.length + 1);
memcpy(path.out(), string.data, string.length);
path.SetLengthAndZeroTerminate(string.length);

if (UNLIKELY(!env->permission()->is_granted(
permission::PermissionScope::kFileSystemRead, path.ToStringView()))) {
options.fallback = true;
return false;
}

uv_fs_t req;
auto make = OnScopeLeave([&req]() { uv_fs_req_cleanup(&req); });
FS_SYNC_TRACE_BEGIN(access);
int err = uv_fs_access(nullptr, &req, path.out(), 0, nullptr);
FS_SYNC_TRACE_END(access);

#ifdef _WIN32
// In case of an invalid symlink, `uv_fs_access` on win32
// will **not** return an error and is therefore not enough.
// Double check with `uv_fs_stat()`.
if (err == 0) {
FS_SYNC_TRACE_BEGIN(stat);
err = uv_fs_stat(nullptr, &req, path.out(), nullptr);
FS_SYNC_TRACE_END(stat);
}
#endif // _WIN32
Comment on lines +1120 to +1135
Copy link
Member

@joyeecheung joyeecheung Sep 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fs operation part can be wrapped in a helper and shared with the slow callback to avoid getting out of sync.


return err == 0;
}

CFunction fast_exists_sync_(CFunction::Make(FastExistsSync));

// Used to speed up module loading. Returns an array [string, boolean]
static void InternalModuleReadJSON(const FunctionCallbackInfo<Value>& args) {
Environment* env = Environment::GetCurrent(args);
Expand Down Expand Up @@ -3364,7 +3408,8 @@ static void CreatePerIsolateProperties(IsolateData* isolate_data,
SetMethodNoSideEffect(isolate, target, "accessSync", AccessSync);
SetMethod(isolate, target, "close", Close);
SetMethod(isolate, target, "closeSync", CloseSync);
SetMethodNoSideEffect(isolate, target, "existsSync", ExistsSync);
SetFastMethodNoSideEffect(
isolate, target, "existsSync", ExistsSync, &fast_exists_sync_);
SetMethod(isolate, target, "open", Open);
SetMethod(isolate, target, "openSync", OpenSync);
SetMethod(isolate, target, "openFileHandle", OpenFileHandle);
Expand Down Expand Up @@ -3490,6 +3535,8 @@ void RegisterExternalReferences(ExternalReferenceRegistry* registry) {
registry->Register(Close);
registry->Register(CloseSync);
registry->Register(ExistsSync);
registry->Register(FastExistsSync);
registry->Register(fast_exists_sync_.GetTypeInfo());
registry->Register(Open);
registry->Register(OpenSync);
registry->Register(OpenFileHandle);
Expand Down