こちらは「内部実装から理解する Swift Concurrency」シリーズの第2回の記事です。

前回の記事では、async 関数のコンパイル時に生成される Swift Intermediate Language (SIL) を読み解き、async 関数の実行・再開時に hop_to_executor という SIL 命令によって実行スレッドが切り替わることを確認しました。

今回は、SIL の hop_to_executor 命令を含む async 関数が LLVM IR へと変換される際に使用される「LLVM のコルーチン」について、LLVM の公式ドキュメントを噛み砕きながら解説します。

この記事から学べること

LLVM のコルーチンの概要が分かる。
Swift の async 関数が、LLVM IR でどのように表現されるかが分かる。

LLVM のコルーチンとは

SIL の hop_to_executor 命令を含む async 関数は、IRGen によって、LLVM のコルーチンを利用する LLVM IR へと変換されます。
したがって、hop_to_executor 命令の内部実装を理解する上では、前提知識として、LLVM のコルーチンについて理解する必要があります。
そこで本記事では、LLVM のコルーチンの概要を解説します。

LLVM に関連する用語の説明

ここからの説明の前提知識として、LLVM に関連する用語をいくつか補足します。

Intrinsic^[1]

LLVM の組み込み関数です。名称はすべて llvm. から始まります。

Lowering

高レベルな LLVM IR を、より低レベルな LLVM IR へと変換することを指します。

コルーチンの概要

LLVM の公式ドキュメント「Coroutines in LLVM」から抜粋・補足しつつ、コルーチンの概要を説明します^[2]。

LLVM のコルーチンとは、一つ以上の suspend point（中断地点）を持つ関数です。

suspend point に達すると、コルーチンの実行が中断され、呼び出し元に制御が戻されます。
中断されたコルーチンは、中断地点から再開させることが可能です。あるいは、中断された後に、破棄されることもあります。

コルーチンの実行中に存在する「関数のスタックフレーム」に加えて、中断されたコルーチンの状態を保持するための追加のストレージ領域が必要となります。
このストレージ領域は、「コルーチンフレーム」と呼ばれます。
コルーチンフレームは、コルーチンが呼ばれた際に作成され、コルーチンが完了ないし破棄された際に併せて破棄されます。

LLVM のコルーチンは、初期段階では、通常の LLVM 関数として表現されます。
この関数は、コルーチン用の Intrinsic への呼び出しを含み、それによってコルーチンの構造が定義されます。
最終的には、この関数は Lowering によって「ramp 関数」へと書き換えられます。
ramp 関数とは、コルーチンの初期実行時のエントリーポイントで、1 つ目の suspend point に達するまでの処理を含みます。
そして、後続の処理は、別々の「resume 関数」へと切り分けられます。
中断前後で保持されるべき状態は、先述した コルーチンフレーム に格納されます。

Lowering の方式

コルーチン用の Intrinsic を含む LLVM IR は、Lowering によって、より低レベルな命令セットを使った LLVM IR へと変換されます。

この Lowering の方式には、いくつか種類が存在します:

Switched-Resume Lowering^[3]
Returned-Continuation Lowering^[4]
Async Lowering^[5]

このうち、現在の Swift コンパイラは、3. の Async Lowering により、hop_to_executor を含む async 関数を LLVM IR へと変換します。この Async Lowering について、より詳しく説明します。

Async Lowering とは

Async Lowering についても、LLVM の公式ドキュメントから抜粋・補足しつつ解説します。

Async Lowering を行うことを示すためには、llvm.coro.id.async という Intrinsic が使用されます。
Async Lowering においては、フロントエンド側（ここでは Swift コンパイラ側）で、制御フローを明示的にハンドリングする必要があります。

LLVM Developers Meeting 2021 の講演^[7]から画像を引用すると、以下のサンプルコードのように、コルーチン関数内で llvm.coro.id.async が呼ばれます。

llvm.coro.id.async はコルーチンを識別するトークンを返します^[8]。
このトークンは、コルーチンの開始をマークするための llvm.coro.begin^[9] およびコルーチンの終了をマークするための llvm.coro.end.async^[10] に、引数として渡されます。

Async Lowering において、コルーチンの関数は、現在の「async context」を引数の一つとして取ります。
async context は、コルーチンの引数や返り値の受け渡しを行うための媒体として使用されます。
コルーチンの関数自体は void を返します。

define swiftcc void @async_coroutine(ptr %async.ctxt, ptr, ptr) {
}

---

`llvm.coro.suspend.async`によって、suspend point (すなわちコルーチンが中断され、呼び出し元に制御が返されるポイント) がマークされます^[`llvm.coro.suspend.async’`: https://llvm.org/docs/Coroutines.html#llvm-coro-suspend-async-intrinsic]。

```cpp
// For example:
struct async_context {
  struct async_context *caller_context;
  ...
}

%resume_func_ptr = call ptr @llvm.coro.async.resume()
call {ptr, ptr, ptr} (ptr, ptr, ...) @llvm.coro.suspend.async(
                 ptr %resume_func_ptr,
                 ptr %context_projection_function,
                 ptr %suspend_function,
                 ptr %arg1, ptr %arg2, i8 %arg3)

llvm.coro.suspend.asyncは、1つ目の引数として「resume関数」を受け取ります。
resume関数のポインタはllvm.coro.async.resumeの結果として取得されます。
llvm.coro.async.resumeの部分は、Loweringによって、このsuspend pointにおけるresume関数 (このsuspend pointの続きの処理を行う関数) へと置き換えられます。

ここまでの説明を元に、以下のSwiftコードがLLVM IRに変換される流れを擬似コードで示します。

@MainActor
public func simpleMainAsyncFunc() async -> Int {
    let a = await getIntAsync(x: 1)
    let b = await getIntAsync(x: 2)
    return a + b
}

まず、以下のようなLLVMのコルーチンのIntrinsicを使ったLLVM IRへと変換されます。

define @simpleMainAsyncFunc(...) {
entry:
  %id    = call @llvm.coro.id.async(...)
  %frame = call @llvm.coro.begin(%id, ...)

  ; await #1
  %resume1 = call @llvm.coro.async.resume(...)
  call @llvm.coro.suspend.async(%resume1, ...)

  ; await #2
  %resume2 = call @llvm.coro.async.resume(...)
  call @llvm.coro.suspend.async(%resume2, ...)

  call @llvm.coro.end.async(%id, ...)
}

このLLVM IRは、Async Loweringによって、以下のようにramp関数とresume関数へと分解されます。
疑似コードからは省いていますが、関数を跨いだ変数や返り値の保持は、Async Contextを使って行われます。

; ramp関数
define @simpleMainAsyncFunc(...) {
entry:
  ; ... await #1 まで実行 ...
  call @getIntAsync(..., continuation = @simpleMainAsyncFunc.resume1)
  ret ...
}

; resume関数①
; await #1 から await #2 までを実行する
define void @simpleMainAsyncFunc.resume1(...) {
  call @getIntAsync(..., continuation = @simpleMainAsyncFunc.resume2)
  ret
}

; resume関数②
; await #2 から return までを実行するresume関数
define void @simpleMainAsyncFunc.resume2(...) {
  ; ... a+b 計算して終了 ...
  ret
}

以上、LLVMにおけるコルーチンの概要、そしてSwift Concurrencyで利用されているAsync Loweringについて解説しました。
次の記事では、SILのhop_to_executor命令が、今回説明したLLVMのコルーチンへと実際に変換される仕組みを解読していきます。

参考資料

2018 LLVM Developers’ Meeting: J. McCall “Coroutine Representations and ABIs in LLVM”

Swift言語の開発者が、LLVMにおいてコルーチンがどのように実装されるのかを解説しています。

2021 LLVM Dev Mtg “Asynchronous Functions in Swift”

Swiftにおけるasync関数の実現のために、LLVMのどのような機能が利用されているかを解説しています。

脚注

Intrinsic Functions: https://llvm.org/docs/LangRef.html#intrinsic-functions ↩︎
Coroutines in LLVM: https://llvm.org/docs/Coroutines.html ↩︎
Switched-Resume Lowering: https://llvm.org/docs/Coroutines.html#switched-resume-lowering ↩︎
Returned-Continuation Lowering: https://llvm.org/docs/Coroutines.html#returned-continuation-lowering ↩︎
Async Lowering: https://llvm.org/docs/Coroutines.html#async-lowering ↩︎
内部実装から理解するKotlin Coroutines：suspend関数・Continuation編: https://zenn.dev/kaseken/articles/a50fd3f5e6e2ba ↩︎
2021 LLVM Dev Mtg “Asynchronous Functions in Swift”: https://youtu.be/H_K-us4-K7s?si=ERcNxr_8mJbqYv-L&t=1203 ↩︎
llvm.coro.id.async Intrinsic: https://llvm.org/docs/Coroutines.html#llvm-coro-id-async-intrinsic ↩︎
llvm.coro.begin: https://llvm.org/docs/Coroutines.html#llvm-coro-begin-intrinsic ↩︎
llvm.coro.end.async: https://llvm.org/docs/Coroutines.html#llvm-coro-end-async-intrinsic ↩︎

Discussion