-
-
Notifications
You must be signed in to change notification settings - Fork 32.2k
fs: use fast api calls for existsSync
#49893
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
Changes from all commits
f413971
dd08af9
ac4be44
69736c2
176cbdc
8d331ed
7a37e48
e2e7341
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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" | ||
|
||
|
@@ -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; | ||
|
@@ -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 | ||
anonrig marked this conversation as resolved.
Show resolved
Hide resolved
Comment on lines
+1120
to
+1135
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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); | ||
|
@@ -3385,7 +3429,7 @@ static void CreatePerIsolateProperties(IsolateData* isolate_data, | |
SetMethod(isolate, target, "accessSync", AccessSync); | ||
SetMethod(isolate, target, "close", Close); | ||
SetMethod(isolate, target, "closeSync", CloseSync); | ||
SetMethod(isolate, target, "existsSync", ExistsSync); | ||
SetFastMethod(isolate, target, "existsSync", ExistsSync, &fast_exists_sync_); | ||
SetMethod(isolate, target, "open", Open); | ||
SetMethod(isolate, target, "openSync", OpenSync); | ||
SetMethod(isolate, target, "openFileHandle", OpenFileHandle); | ||
|
@@ -3512,6 +3556,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); | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -54,3 +54,12 @@ assert(!fs.existsSync(`${f}-NO`)); | |
assert(!fs.existsSync()); | ||
assert(!fs.existsSync({})); | ||
assert(!fs.existsSync(new URL('https://foo'))); | ||
|
||
{ | ||
// This test is to ensure that the v8 fast api works. | ||
const oneBytePath = 'hello.txt'; | ||
for (let i = 0; i < 1e5; i++) { | ||
assert(!fs.existsSync(oneBytePath)); | ||
anonrig marked this conversation as resolved.
Show resolved
Hide resolved
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This should be moved to There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can't we use V8 natives API like they do unit test fast calls? IIRC you need to There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, while I'm not good enough with C++ to suggest how to implement it, I think we can put something into place (maybe only in debug builds?). For example, the fast version, when called, increases some counter that we can get from JavaScript for an assertion. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we can keep an array of booleans for all fast APIs to see if they are called, and expose them to the JS land, toggling a boolean shouldn't be very expensive. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For this PR though doing |
||
assert(fs.existsSync(__filename)); | ||
} | ||
} |
Uh oh!
There was an error while loading. Please reload this page.