Support OPFS on the main thread with JSPI. #19063
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brendandahl
commented
Mar 24, 2023
sbc100
reviewed
Mar 24, 2023
sbc100
reviewed
Mar 24, 2023
tlively
reviewed
Mar 27, 2023
sbc100
approved these changes
Mar 28, 2023
tlively
reviewed
Mar 28, 2023
kripken
reviewed
Mar 30, 2023
The OPFS backend will now use async reaad/writes when used on the main thread. The ProxyWorker is stubbed out and calls are directly dispatched into JS. The JS side uses a new FileSystemASyncAccessHandle class that matches the sync version of the class, but has async read/writes. Hopefully, we can one day replace that with something from the platform.
tlively
approved these changes
Apr 5, 2023
src/library_wasmfs_opfs.js
Outdated
| '$wasmfsOPFSAccessHandles'], | ||
| '$wasmfsOPFSAccessHandles', '$wasmfsOPFSProxyFinish', | ||
| #if !USE_PTHREADS | ||
| '$wasmfsOPFSCreateASyncAccessHandle' |
There was a problem hiding this comment.
Suggested change
| '$wasmfsOPFSCreateASyncAccessHandle' | |
| '$wasmfsOPFSCreateAsyncAccessHandle' |
src/library_wasmfs_opfs.js
Outdated
| // TODO: Remove this once the Access Handles API has settled. | ||
| if (FileSystemFileHandle.prototype.createSyncAccessHandle.length == 0) { | ||
| accessHandle = await fileHandle.createSyncAccessHandle(); | ||
| } else { | ||
| accessHandle = await fileHandle.createSyncAccessHandle( | ||
| {mode: "in-place"}); | ||
| } | ||
| #else | ||
| accessHandle = await wasmfsOPFSCreateASyncAccessHandle(fileHandle); |
There was a problem hiding this comment.
Suggested change
| accessHandle = await wasmfsOPFSCreateASyncAccessHandle(fileHandle); | |
| accessHandle = await wasmfsOPFSCreateAsyncAccessHandle(fileHandle); |
src/library_wasmfs_opfs.js
Outdated
| }, | ||
|
|
||
| $wasmfsOPFSCreateASyncAccessHandle__deps: ['$FileSystemAsyncAccessHandle'], | ||
| $wasmfsOPFSCreateASyncAccessHandle: function(fileHandle) { |
There was a problem hiding this comment.
Suggested change
| $wasmfsOPFSCreateASyncAccessHandle: function(fileHandle) { | |
| $wasmfsOPFSCreateAsyncAccessHandle: function(fileHandle) { |
| // can be directly executed since they are all async. | ||
| template <typename T> | ||
| void operator()(T func) { | ||
| if constexpr (std::is_invocable<T&, ProxyingQueue::ProxyingCtx>::value) { |
There was a problem hiding this comment.
Very slightly simpler:
Suggested change
| if constexpr (std::is_invocable<T&, ProxyingQueue::ProxyingCtx>::value) { | |
| if constexpr (std::is_invocable_v<T&, ProxyingQueue::ProxyingCtx>) { |
In debug builds the same assert as before will trigger: |
|
Makes sense. I guess if we add a new constructor that returns a promise (and is therefore usable on the main thread even without JSPI), we have to have a similar assertion to avoid trying to execute any async file operations when neither JSPI nor threads are enabled? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The OPFS backend will now use async reaad/writes when used on the main thread. The ProxyWorker is stubbed out and calls are directly dispatched into JS. The JS side uses a new FileSystemASyncAccessHandle class that matches the sync version of the class, but has async read/writes. Hopefully, we can one day replace that with something from the platform.