Design: 提案：非同期/待機JS API

この提案は、 @ fmccabe 、 @ thibaudmichaud 、 @ lukewagner 、および@kripkenと

この提案の目的は、JavaScriptのpromiseとWebAssemblyの間に比較的効率的で比較的人間味のある相互運用を提供することですが、変更はJS APIのみであり、コアwasmではないという制約の下で機能します。
スタックスイッチングプロポーザルは、最終的にコアWebAssemblyを拡張して、このプロポーザルで提供する操作をWebAssembly内で直接実装する機能と、他の多くの貴重なスタックスイッチング操作を実装することが期待されますが、
詳細については、2021年6月28日のスタックサブグループ会議のメモとスライドを参照してください。この

更新：StacksサブグループがTC39から受け取ったフィードバックに続いて、この提案ではWebAssemblyスタックの一時停止asycn /のサポートは間接的に有効になりません。 JavaScriptのawait 。

これは、 FunctionサブクラスとしてWebAssembly.Functionを導入するjs-typesの提案に（大まかに）依存します。

インターフェース

提案は、以下のインターフェース、コンストラクター、およびメソッドをJS APIに追加することであり、それらのセマンティクスの詳細を以下に示します。

interface Suspender {
   constructor();
   Function suspendOnReturnedPromise(Function func); // import wrapper
   // overloaded: WebAssembly.Function suspendOnReturnedPromise(WebAssembly.Function func);
   WebAssembly.Function returnPromiseOnSuspend(WebAssembly.Function func); // export wrapper
}

例

以下は、このAPIの使用方法の例です。
私たちの使用シナリオでは、WebAssemblyモジュールが「同期」および「非同期」のインポートとエクスポートを持っていると考えられると便利であることがわかりました。
現在のJSAPIは、「同期」インポートとエクスポートのみをサポートしています。
Suspenderインターフェースのメソッドは、「非同期」を作成するために関連するインポートとエクスポートをラップするために使用され、Suspenderオブジェクト自体がこれらのインポートとエクスポートを明示的に接続して、実装と構成の両方を容易にします。

WebAssembly（ demo.wasm ）：

(module
    (import "js" "init_state" (func $init_state (result f64)))
    (import "js" "compute_delta" (func $compute_delta (result f64)))
    (global $state f64)
    (func $init (global.set $state (call $init_state)))
    (start $init)
    (func $get_state (export "get_state") (result f64) (global.get $state))
    (func $update_state (export "update_state") (result f64)
      (global.set (f64.add (global.get $state) (call $compute_delta)))
      (global.get $state)
    )
)

テキスト（ data.txt ）：

19827.987

JavaScript：

var suspender = new Suspender();
var init_state = () => 2.71;
var compute_delta = () => fetch('data.txt').then(res => res.text()).then(txt => parseFloat(txt));
var importObj = {js: {
    init_state: init_state,
    compute_delta: suspender.suspendOnReturnedPromise(compute_delta)
}};

fetch('demo.wasm').then(response =>
    response.arrayBuffer()
).then(buffer =>
    WebAssembly.instantiate(buffer, importObj)
).then(({module, instance}) => {
    var get_state = instance.exports.get_state;
    var update_state = suspender.returnPromiseOnSuspend(instance.exports.update_state);
    ...
});

この例では、非常に単純なステートマシンであるWebAssemblyモジュールがあります。状態を更新するたびに、インポートを呼び出してデルタを計算し、状態に追加します。
ただし、JavaScript側では、デルタの計算に使用する関数を非同期で実行する必要があることがわかりました。 つまり、数値自体ではなく、数値の約束を返します。

新しいJSAPIを使用することで、この同期のギャップを埋めることができます。
この例では、WebAssemblyモジュールのインポートはsuspender.suspendOnReturnedPromiseを使用してラップされ、エクスポートはsuspender.returnPromiseOnSuspendを使用してラップされ、どちらも同じsuspenderます。
そのsuspenderは2つに一緒に接続します。
これにより、（ラップされていない）インポートがPromiseを返す場合、（ラップされた）エクスポートはPromiseを返し、その間のすべての計算は、インポートのPromiseが解決されるまで「一時停止」されます。
エクスポートのラッピングは基本的にasyncマーカーを追加し、インポートのラッピングは基本的にawaitマーカーを追加しますが、JavaScriptとは異なり、 asyncを明示的にスレッド化する必要はありません。 awaitすべての中間WebAssembly関数を介して！

一方、初期化中にinit_stateに対して行われた呼び出しは、必ず中断せずに返され、エクスポートget_state呼び出しも常に中断せずに返されるため、プロポーザルは既存の「同期」インポートおよびエクスポートを引き続きサポートします。 WebAssemblyエコシステムは今日使用しています。
もちろん、同期エクスポートが非同期インポートを呼び出す場合、インポートが一時停止しようとするとプログラムがトラップするという事実など、多くの詳細がざっと見られています。
以下に、より詳細な仕様といくつかの実装戦略を示します。

仕様

Suspenderは、次のいずれかの状態にあります。

• 非アクティブ-現在使用されていません
• アクティブ[ caller ]-コントロールはSuspenderにあり、 callerはSuspenderを呼び出し、 externref期待している関数です。返される
• 一時停止-現在、解決の約束を待っています

メソッドsuspender.returnPromiseOnSuspend(func) 、 funcが[ti*] -> [to]の形式の関数型のWebAssembly.Functionであることを表明し、関数型のWebAssembly.Functionを返します。 [ti*] -> [externref]は、引数args呼び出されると、次のことを行います。

1. suspenderの状態が非アクティブでない場合にトラップします
2. suspenderの状態をアクティブ[ caller ]に変更します（ここで、 callerは現在の呼び出し元です）
3. resultをfunc(args) （またはトラップまたはスローされた例外）を呼び出した結果とします。
4. suspenderの状態がいくつかのcaller'アクティブ[ caller' ]であることを表明します（呼び出し元が変更された可能性がありますが、保証されているはずです）
5. suspenderの状態を非アクティブに変更します
6. resultをcaller'返す（または再スローする）

メソッドsuspender.suspendOnReturnedPromise(func)

• funcがWebAssembly.Function場合、その関数型は[t*] -> [externref]の形式であると主張し、関数型[t*] -> [externref] WebAssembly.Functionを返します。 ;
• それ以外の場合は、 funcがFunctionと主張し、 Functionを返します。

いずれの場合も、 suspender.suspendOnReturnedPromise(func)によって返される関数は、引数argsを指定して呼び出されると、次のようになります。

1. resultをfunc(args) （またはトラップまたはスローされた例外）を呼び出した結果とします。
2. resultが返されたPromiseでない場合は、 result返します（または再スローします）。
3. suspenderの状態がアクティブでない場合にトラップ[ caller ]一部のcaller
4. caller以降、 framesスタックフレームとします。
5. frames一時停止不可能な関数のフレームがある場合はトラップします
6. suspenderの状態を一時停止に変更します
7. 次の関数onFulfilledおよびonRejectedを使用してresult.then(onFulfilled, onRejected)の結果を返します。
   
   
   
   1. suspenderの状態が一時停止されていることを表明します（保証する必要があります）
   
   
   2. suspenderの状態をアクティブ[ caller' ]に変更します。ここで、 caller'はonFulfilled / onRejectedの呼び出し元です。
   
   
   3. 
      
      
      • onFulfilled場合、指定された値をexternrefに変換し、それをframes返します。
      
      
      
      • onRejected場合、例外処理プロポーザルのJS APIに従って、指定された値を例外としてframesまでスローします。
      
      
      
   
   

だった場合、関数は一時停止可能です

• WebAssemblyモジュールによって定義され、
• suspendOnReturnedPromiseによって返される、
• returnPromiseOnSuspendによって返される、
• またはサスペンド可能な関数のホスト関数を

重要なことには、JavaScriptで記述された機能は、メンバーからのフィードバックに適合し、懸濁ないTC39エンジンの保守からのフィードバックに準拠し、（上記の数を除いて）、およびホスト機能懸濁されていません。

実装

以下は、この提案の実装戦略です。
これは、スタックスイッチングのエンジンサポートを前提としています。もちろん、これが主な実装上の課題です。

スタックには、ホスト（およびJavaScript）スタックとWebAssemblyスタックの2種類があります。 すべてのWebAssemblyスタックには、 suspenderというサスペンダーフィールドがあります。 すべてのスレッドにはホストスタックがあります。

すべてのSuspenderは、2つのスタック参照フィールドがあります。1つはcallerと呼ばれ、もう1つはsuspendedと呼ばれます。

• 非アクティブ状態では、両方のフィールドがnullです。
• アクティブ状態では、 callerフィールドは呼び出し元の（一時停止された）スタックを参照し、 suspendedフィールドはnullです。
• Suspended状態では、 suspendedフィールドは現在サスペンダーに関連付けられている（サスペンドされた）WebAssemblyスタックを参照し、 callerフィールドはnullです。

suspender.returnPromiseOnSuspend(func)(args)はによって実装されます

1. suspender.callerとsuspended.suspendedがnullであることを確認します（それ以外の場合はトラップします）
2. stackをsuspender関連付けられた新しく割り当てられたWebAssemblyスタックとします
3. stack切り替えて、前のスタックをsuspender.caller保存します
4. resultをfunc(args) （またはトラップまたはスローされた例外）の結果とします。
5. suspender.caller切り替えてnullに設定
6. stack解放する
7. result返す（または再スローする）

suspender.suspendOnReturnedPromise(func)(args)はによって実装されます

1. func(args)呼び出し、トラップまたはスローされた例外をキャッチします
2. resultが返されたPromiseでない場合、 result返す（または再スローする）
3. suspender.callerがnullでないことを確認します（それ以外の場合はトラップします）
4. stack現在のスタックとします
5. stackはsuspender関連付けられたWebAssemblyスタックではありませんが：
   
   
   
   • stackがWebAssemblyスタックであることを確認します（それ以外の場合はトラップします）
   
   
   • stackをstack.suspender.caller更新します
   
   
6. suspender.callerに切り替え、nullに設定し、前のスタックをsuspender.suspended格納します
7. によって実装された関数onFulfilledおよびonRejectedを使用してresult.then(onFulfilled, onRejected)の結果を返す
   
   
   
   1. suspender.suspendedに切り替え、nullに設定し、前のスタックをsuspender.caller格納します
   
   
   2. 
      
      
      • onFulfilled場合、指定された値をexternrefに変換して返します
      
      
      
      • onRejected場合、指定された値を再スローします
      
      
      
   
   

サスペンド可能な関数のホスト関数を