GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — Add `JSObject.transfer` and `JSObject.receive` APIs · t089/JavaScriptKit@28d5ec0

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

Runtime/src
- index.ts
- types.ts
Sources
- JavaScriptEventLoop
  - JSObject+Transferring.swift
- JavaScriptKit
  - FundamentalObjects
    - JSObject.swift
  - Runtime
    - index.js
    - index.mjs
- _CJavaScriptKit
  - _CJavaScriptKit.c
  - include
    - _CJavaScriptKit.h

Expand file treeCollapse file tree

Open diff view settings

Collapse file

`‎Runtime/src/index.ts‎`

Copy file name to clipboardExpand all lines: Runtime/src/index.ts

+137-10Lines changed: 137 additions & 10 deletions

Original file line number	Diff line number	Diff line change
`@@ -6,18 +6,45 @@ import {`
`6`	`6`	`pointer,`
`7`	`7`	`TypedArray,`
`8`	`8`	`ImportedFunctions,`
	`9`	`+ MAIN_THREAD_TID,`
`9`	`10`	`} from "./types.js";`
`10`	`11`	`import * as JSValue from "./js-value.js";`
`11`	`12`	`import { Memory } from "./memory.js";`
`12`	`13`
	`14`	`+type TransferMessage = {`
	`15`	`+ type: "transfer";`
	`16`	`+ data: {`
	`17`	`+ object: any;`
	`18`	`+ transferring: pointer;`
	`19`	`+ destinationTid: number;`
	`20`	`+ };`
	`21`	`+};`
	`22`	`+`
	`23`	`+type RequestTransferMessage = {`
	`24`	`+ type: "requestTransfer";`
	`25`	`+ data: {`
	`26`	`+ objectRef: ref;`
	`27`	`+ objectSourceTid: number;`
	`28`	`+ transferring: pointer;`
	`29`	`+ destinationTid: number;`
	`30`	`+ };`
	`31`	`+};`
	`32`	`+`
	`33`	`+type TransferErrorMessage = {`
	`34`	`+ type: "transferError";`
	`35`	`+ data: {`
	`36`	`+ error: string;`
	`37`	`+ };`
	`38`	`+};`
	`39`	`+`
`13`	`40`	`type MainToWorkerMessage = {`
`14`	`41`	`type: "wake";`
`15`		`-};`
	`42`	`+} \| RequestTransferMessage \| TransferMessage \| TransferErrorMessage;`
`16`	`43`
`17`	`44`	`type WorkerToMainMessage = {`
`18`	`45`	`type: "job";`
`19`	`46`	`data: number;`
`20`		`-};`
	`47`	`+} \| RequestTransferMessage \| TransferMessage \| TransferErrorMessage;`
`21`	`48`
`22`	`49`	`/**`
`23`	`50`	`* A thread channel is a set of functions that are used to communicate between`
`@@ -60,8 +87,9 @@ export type SwiftRuntimeThreadChannel =`
`60`	`87`	`* This function is used to send messages from the worker thread to the main thread.`
`61`	`88`	* The message submitted by this function is expected to be listened by `listenMessageFromWorkerThread`.
`62`	`89`	`* @param message The message to be sent to the main thread.`
	`90`	`+ * @param transfer The array of objects to be transferred to the main thread.`
`63`	`91`	`*/`
`64`		`- postMessageToMainThread: (message: WorkerToMainMessage) => void;`
	`92`	`+ postMessageToMainThread: (message: WorkerToMainMessage, transfer: any[]) => void;`
`65`	`93`	`/**`
`66`	`94`	`* This function is expected to be set in the worker thread and should listen`
`67`	`95`	* to messages from the main thread sent by `postMessageToWorkerThread`.
`@@ -75,8 +103,9 @@ export type SwiftRuntimeThreadChannel =`
`75`	`103`	* The message submitted by this function is expected to be listened by `listenMessageFromMainThread`.
`76`	`104`	`* @param tid The thread ID of the worker thread.`
`77`	`105`	`* @param message The message to be sent to the worker thread.`
	`106`	`+ * @param transfer The array of objects to be transferred to the worker thread.`
`78`	`107`	`*/`
`79`		`- postMessageToWorkerThread: (tid: number, message: MainToWorkerMessage) => void;`
	`108`	`+ postMessageToWorkerThread: (tid: number, message: MainToWorkerMessage, transfer: any[]) => void;`
`80`	`109`	`/**`
`81`	`110`	`* This function is expected to be set in the main thread and should listen`
`82`	`111`	* to messages sent by `postMessageToMainThread` from the worker thread.
`@@ -610,8 +639,37 @@ export class SwiftRuntime {`
`610`	`639`	`case "wake":`
`611`	`640`	`this.exports.swjs_wake_worker_thread();`
`612`	`641`	`break;`
	`642`	`+ case "requestTransfer": {`
	`643`	`+ const object = this.memory.getObject(message.data.objectRef);`
	`644`	`+ const messageToMainThread: TransferMessage = {`
	`645`	`+ type: "transfer",`
	`646`	`+ data: {`
	`647`	`+ object,`
	`648`	`+ destinationTid: message.data.destinationTid,`
	`649`	`+ transferring: message.data.transferring,`
	`650`	`+ },`
	`651`	`+ };`
	`652`	`+ try {`
	`653`	`+ this.postMessageToMainThread(messageToMainThread, [object]);`
	`654`	`+ } catch (error) {`
	`655`	`+ this.postMessageToMainThread({`
	`656`	`+ type: "transferError",`
	`657`	`+ data: { error: String(error) },`
	`658`	`+ });`
	`659`	`+ }`
	`660`	`+ break;`
	`661`	`+ }`
	`662`	`+ case "transfer": {`
	`663`	`+ const objectRef = this.memory.retain(message.data.object);`
	`664`	`+ this.exports.swjs_receive_object(objectRef, message.data.transferring);`
	`665`	`+ break;`
	`666`	`+ }`
	`667`	`+ case "transferError": {`
	`668`	`+ console.error(message.data.error); // TODO: Handle the error`
	`669`	`+ break;`
	`670`	`+ }`
`613`	`671`	`default:`
`614`		`- const unknownMessage: never = message.type;`
	`672`	`+ const unknownMessage: never = message;`
`615`	`673`	throw new Error(`Unknown message type: ${unknownMessage}`);
`616`	`674`	`}`
`617`	`675`	`});`
`@@ -632,8 +690,57 @@ export class SwiftRuntime {`
`632`	`690`	`case "job":`
`633`	`691`	`this.exports.swjs_enqueue_main_job_from_worker(message.data);`
`634`	`692`	`break;`
	`693`	`+ case "requestTransfer": {`
	`694`	`+ if (message.data.objectSourceTid == MAIN_THREAD_TID) {`
	`695`	`+ const object = this.memory.getObject(message.data.objectRef);`
	`696`	`+ if (message.data.destinationTid != tid) {`
	`697`	`+ throw new Error("Invariant violation: The destination tid of the transfer request must be the same as the tid of the worker thread that received the request.");`
	`698`	`+ }`
	`699`	`+ this.postMessageToWorkerThread(message.data.destinationTid, {`
	`700`	`+ type: "transfer",`
	`701`	`+ data: {`
	`702`	`+ object,`
	`703`	`+ transferring: message.data.transferring,`
	`704`	`+ destinationTid: message.data.destinationTid,`
	`705`	`+ },`
	`706`	`+ }, [object]);`
	`707`	`+ } else {`
	`708`	`+ // Proxy the transfer request to the worker thread that owns the object`
	`709`	`+ this.postMessageToWorkerThread(message.data.objectSourceTid, {`
	`710`	`+ type: "requestTransfer",`
	`711`	`+ data: {`
	`712`	`+ objectRef: message.data.objectRef,`
	`713`	`+ objectSourceTid: tid,`
	`714`	`+ transferring: message.data.transferring,`
	`715`	`+ destinationTid: message.data.destinationTid,`
	`716`	`+ },`
	`717`	`+ });`
	`718`	`+ }`
	`719`	`+ break;`
	`720`	`+ }`
	`721`	`+ case "transfer": {`
	`722`	`+ if (message.data.destinationTid == MAIN_THREAD_TID) {`
	`723`	`+ const objectRef = this.memory.retain(message.data.object);`
	`724`	`+ this.exports.swjs_receive_object(objectRef, message.data.transferring);`
	`725`	`+ } else {`
	`726`	`+ // Proxy the transfer response to the destination worker thread`
	`727`	`+ this.postMessageToWorkerThread(message.data.destinationTid, {`
	`728`	`+ type: "transfer",`
	`729`	`+ data: {`
	`730`	`+ object: message.data.object,`
	`731`	`+ transferring: message.data.transferring,`
	`732`	`+ destinationTid: message.data.destinationTid,`
	`733`	`+ },`
	`734`	`+ }, [message.data.object]);`
	`735`	`+ }`
	`736`	`+ break;`
	`737`	`+ }`
	`738`	`+ case "transferError": {`
	`739`	`+ console.error(message.data.error); // TODO: Handle the error`
	`740`	`+ break;`
	`741`	`+ }`
`635`	`742`	`default:`
`636`		`- const unknownMessage: never = message.type;`
	`743`	`+ const unknownMessage: never = message;`
`637`	`744`	throw new Error(`Unknown message type: ${unknownMessage}`);
`638`	`745`	`}`
`639`	`746`	`},`
`@@ -649,27 +756,47 @@ export class SwiftRuntime {`
`649`	`756`	`// Main thread's tid is always -1`
`650`	`757`	`return this.tid \|\| -1;`
`651`	`758`	`},`
	`759`	`+ swjs_request_transferring_object: (`
	`760`	`+ object_ref: ref,`
	`761`	`+ object_source_tid: number,`
	`762`	`+ transferring: pointer,`
	`763`	`+ ) => {`
	`764`	`+ if (this.tid == object_source_tid) {`
	`765`	`+ // Fast path: The object is already in the same thread`
	`766`	`+ this.exports.swjs_receive_object(object_ref, transferring);`
	`767`	`+ return;`
	`768`	`+ }`
	`769`	`+ this.postMessageToMainThread({`
	`770`	`+ type: "requestTransfer",`
	`771`	`+ data: {`
	`772`	`+ objectRef: object_ref,`
	`773`	`+ objectSourceTid: object_source_tid,`
	`774`	`+ transferring,`
	`775`	`+ destinationTid: this.tid ?? MAIN_THREAD_TID,`
	`776`	`+ },`
	`777`	`+ });`
	`778`	`+ },`
`652`	`779`	`};`
`653`	`780`	`}`
`654`	`781`
`655`		`- private postMessageToMainThread(message: WorkerToMainMessage) {`
	`782`	`+ private postMessageToMainThread(message: WorkerToMainMessage, transfer: any[] = []) {`
`656`	`783`	`const threadChannel = this.options.threadChannel;`
`657`	`784`	`if (!(threadChannel && "postMessageToMainThread" in threadChannel)) {`
`658`	`785`	`throw new Error(`
`659`	`786`	`"postMessageToMainThread is not set in options given to SwiftRuntime. Please set it to send messages to the main thread."`
`660`	`787`	`);`
`661`	`788`	`}`
`662`		`- threadChannel.postMessageToMainThread(message);`
	`789`	`+ threadChannel.postMessageToMainThread(message, transfer);`
`663`	`790`	`}`
`664`	`791`
`665`		`- private postMessageToWorkerThread(tid: number, message: MainToWorkerMessage) {`
	`792`	`+ private postMessageToWorkerThread(tid: number, message: MainToWorkerMessage, transfer: any[] = []) {`
`666`	`793`	`const threadChannel = this.options.threadChannel;`
`667`	`794`	`if (!(threadChannel && "postMessageToWorkerThread" in threadChannel)) {`
`668`	`795`	`throw new Error(`
`669`	`796`	`"postMessageToWorkerThread is not set in options given to SwiftRuntime. Please set it to send messages to worker threads."`
`670`	`797`	`);`
`671`	`798`	`}`
`672`		`- threadChannel.postMessageToWorkerThread(tid, message);`
	`799`	`+ threadChannel.postMessageToWorkerThread(tid, message, transfer);`
`673`	`800`	`}`
`674`	`801`	`}`
`675`	`802`

Collapse file

`‎Runtime/src/types.ts‎`

Copy file name to clipboardExpand all lines: Runtime/src/types.ts

+8Lines changed: 8 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ export interface ExportedFunctions {`
`22`	`22`
`23`	`23`	`swjs_enqueue_main_job_from_worker(unowned_job: number): void;`
`24`	`24`	`swjs_wake_worker_thread(): void;`
	`25`	`+ swjs_receive_object(object: ref, transferring: pointer): void;`
`25`	`26`	`}`
`26`	`27`
`27`	`28`	`export interface ImportedFunctions {`
`@@ -112,6 +113,11 @@ export interface ImportedFunctions {`
`112`	`113`	`swjs_listen_message_from_worker_thread: (tid: number) => void;`
`113`	`114`	`swjs_terminate_worker_thread: (tid: number) => void;`
`114`	`115`	`swjs_get_worker_thread_id: () => number;`
	`116`	`+ swjs_request_transferring_object: (`
	`117`	`+ object_ref: ref,`
	`118`	`+ object_source_tid: number,`
	`119`	`+ transferring: pointer,`
	`120`	`+ ) => void;`
`115`	`121`	`}`
`116`	`122`
`117`	`123`	`export const enum LibraryFeatures {`
`@@ -133,3 +139,5 @@ export type TypedArray =`
`133`	`139`	`export function assertNever(x: never, message: string) {`
`134`	`140`	`throw new Error(message);`
`135`	`141`	`}`
	`142`	`+`
	`143`	`+export const MAIN_THREAD_TID = -1;`

Collapse file

`‎Sources/JavaScriptEventLoop/JSObject+Transferring.swift‎`

Copy file name to clipboard

+60Lines changed: 60 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,60 @@`
	`1`	`+@_spi(JSObject_id) import JavaScriptKit`
	`2`	`+import _CJavaScriptKit`
	`3`	`+`
	`4`	`+extension JSObject {`
	`5`	`+ public class Transferring: @unchecked Sendable {`
	`6`	`+ fileprivate let sourceTid: Int32`
	`7`	`+ fileprivate let idInSource: JavaScriptObjectRef`
	`8`	`+ fileprivate var continuation: CheckedContinuation<JSObject, Error>? = nil`
	`9`	`+`
	`10`	`+ init(sourceTid: Int32, id: JavaScriptObjectRef) {`
	`11`	`+ self.sourceTid = sourceTid`
	`12`	`+ self.idInSource = id`
	`13`	`+ }`
	`14`	`+`
	`15`	`+ func receive(isolation: isolated (any Actor)?) async throws -> JSObject {`
	`16`	`+ #if compiler(>=6.1) && _runtime(_multithreaded)`
	`17`	`+ swjs_request_transferring_object(`
	`18`	`+ idInSource,`
	`19`	`+ sourceTid,`
	`20`	`+ Unmanaged.passRetained(self).toOpaque()`
	`21`	`+ )`
	`22`	`+ return try await withCheckedThrowingContinuation { continuation in`
	`23`	`+ self.continuation = continuation`
	`24`	`+ }`
	`25`	`+ #else`
	`26`	`+ return JSObject(id: idInSource)`
	`27`	`+ #endif`
	`28`	`+ }`
	`29`	`+ }`
	`30`	`+`
	`31`	+ /// Transfers the ownership of a `JSObject` to be sent to another Worker.
	`32`	`+ ///`
	`33`	+ /// - Parameter object: The `JSObject` to be transferred.
	`34`	+ /// - Returns: A `JSTransferring` instance that can be shared across worker threads.
	`35`	+ /// - Note: The original `JSObject` should not be accessed after calling this method.
	`36`	`+ public static func transfer(_ object: JSObject) -> Transferring {`
	`37`	`+ #if compiler(>=6.1) && _runtime(_multithreaded)`
	`38`	`+ Transferring(sourceTid: object.ownerTid, id: object.id)`
	`39`	`+ #else`
	`40`	`+ Transferring(sourceTid: -1, id: object.id)`
	`41`	`+ #endif`
	`42`	`+ }`
	`43`	`+`
	`44`	+ /// Receives a transferred `JSObject` from a Worker.
	`45`	`+ ///`
	`46`	+ /// - Parameter transferring: The `JSTransferring` instance received from other worker threads.
	`47`	+ /// - Returns: The reconstructed `JSObject` that can be used in the receiving Worker.
	`48`	`+ public static func receive(_ transferring: Transferring, isolation: isolated (any Actor)? = #isolation) async throws -> JSObject {`
	`49`	`+ try await transferring.receive(isolation: isolation)`
	`50`	`+ }`
	`51`	`+}`
	`52`	`+`
	`53`	`+#if compiler(>=6.1) // @_expose and @_extern are only available in Swift 6.1+`
	`54`	`+@_expose(wasm, "swjs_receive_object")`
	`55`	`+@_cdecl("swjs_receive_object")`
	`56`	`+#endif`
	`57`	`+func _swjs_receive_object(_ object: JavaScriptObjectRef, _ transferring: UnsafeRawPointer) {`
	`58`	`+ let transferring = Unmanaged<JSObject.Transferring>.fromOpaque(transferring).takeRetainedValue()`
	`59`	`+ transferring.continuation?.resume(returning: JSObject(id: object))`
	`60`	`+}`

Collapse file

`‎Sources/JavaScriptKit/FundamentalObjects/JSObject.swift‎`

Copy file name to clipboardExpand all lines: Sources/JavaScriptKit/FundamentalObjects/JSObject.swift

+4-12Lines changed: 4 additions & 12 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,5 @@`
`1`	`1`	`import _CJavaScriptKit`
`2`	`2`
`3`		`-#if arch(wasm32)`
`4`		`- #if canImport(wasi_pthread)`
`5`		`- import wasi_pthread`
`6`		`- #endif`
`7`		`-#else`
`8`		`- import Foundation // for pthread_t on non-wasi platforms`
`9`		`-#endif`
`10`		`-`
`11`	`3`	/// `JSObject` represents an object in JavaScript and supports dynamic member lookup.
`12`	`4`	/// Any member access like `object.foo` will dynamically request the JavaScript and Swift
`13`	`5`	`/// runtime bridge library for a member with the specified name in this object.`
`@@ -31,14 +23,14 @@ public class JSObject: Equatable {`
`31`	`23`	`public var id: JavaScriptObjectRef`
`32`	`24`
`33`	`25`	`#if compiler(>=6.1) && _runtime(_multithreaded)`
`34`		`- private let ownerThread: pthread_t`
	`26`	`+ package let ownerTid: Int32`
`35`	`27`	`#endif`
`36`	`28`
`37`	`29`	`@_spi(JSObject_id)`
`38`	`30`	`public init(id: JavaScriptObjectRef) {`
`39`	`31`	`self.id = id`
`40`	`32`	`#if compiler(>=6.1) && _runtime(_multithreaded)`
`41`		`- self.ownerThread = pthread_self()`
	`33`	`+ self.ownerTid = swjs_get_worker_thread_id_cached()`
`42`	`34`	`#endif`
`43`	`35`	`}`
`44`	`36`
`@@ -51,14 +43,14 @@ public class JSObject: Equatable {`
`51`	`43`	`/// object spaces are not shared across threads backed by Web Workers.`
`52`	`44`	`private func assertOnOwnerThread(hint: @autoclosure () -> String) {`
`53`	`45`	`#if compiler(>=6.1) && _runtime(_multithreaded)`
`54`		`- precondition(pthread_equal(ownerThread, pthread_self()) != 0, "JSObject is being accessed from a thread other than the owner thread: \(hint())")`
	`46`	`+ precondition(ownerTid == swjs_get_worker_thread_id_cached(), "JSObject is being accessed from a thread other than the owner thread: \(hint())")`
`55`	`47`	`#endif`
`56`	`48`	`}`
`57`	`49`
`58`	`50`	`/// Asserts that the two objects being compared are owned by the same thread.`
`59`	`51`	`private static func assertSameOwnerThread(lhs: JSObject, rhs: JSObject, hint: @autoclosure () -> String) {`
`60`	`52`	`#if compiler(>=6.1) && _runtime(_multithreaded)`
`61`		`- precondition(pthread_equal(lhs.ownerThread, rhs.ownerThread) != 0, "JSObject is being accessed from a thread other than the owner thread: \(hint())")`
	`53`	`+ precondition(lhs.ownerTid == rhs.ownerTid, "JSObject is being accessed from a thread other than the owner thread: \(hint())")`
`62`	`54`	`#endif`
`63`	`55`	`}`
`64`	`56`

0 commit comments

Comments

0 (0)

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.