LLDBへのFortranサポート追加 (GSoC 2026)
Adding Fortran Support to LLDB (GSoC 2026) (blog.llvm.org)
要約
このプロジェクトは、LLVMデバッガであるLLDBにFortranのネイティブサポートを追加するGoogle Summer of Code (GSoC) の成果を報告しています。これにより、Fortranのプリミティブ型、配列、ポインタ、関数などのデバッグが可能になり、開発ツールのエコシステムが拡充されます。記事では、実装の詳細、アーキテクチャ、RFCプロセス、テスト、そしてプロジェクトを通じて得られた学びについて詳述しています。
全文翻訳
GSoC 2026 - LLDBへのFortranサポート追加
GSoC 2026 - LLDBへのFortranサポート追加 (LLVM)
Flangは成熟してきましたが、その周辺の開発ツールは遅れをとっていました。特に、専用のデバッガが欠けていました。LLDBはネイティブなFortranサポートを欠いており、生のラインテーブルを通じて基本的なブレークポイントしか解決できませんでした。このプロジェクトは、LLDBにFortranサポートを追加し、完全に機能するFlangバックエンドデバッガを構築するための基盤を築きます。
具体的には、この作業は以下のネイティブサポートを導入します。
- プリミティブ型 (
INTEGER,REAL,LOGICAL,COMPLEX) - 配列
- ポインタ
- 関数
現在の状況とコードの実行
この規模のプロジェクトのアップストリームプロセスは進行中であるため、すべての機能がまだLLVMのメインブランチにマージされていません。しかし、動作する実装が誰でもテストできるようになっています。変更点の全セットを表示し、コードをクローンして、個人のブランチから自分でコンパイルすることができます。
このプロジェクトの継続的な統合について最新情報を入手するには、トラッキングイシューをフォローしてください。
ハイレベルアーキテクチャ
LLDBに新しい言語を追加するには、コンパイルされたバイナリから値を取得、表現、表示する方法を教える必要があります。これは3つのコアコンポーネントに依存します。
DWARFASTParser: コンパイラによって生成されたDWARFデバッグ情報を解析し、生の型メタデータ(シンボル名、バイトサイズ、レイアウトなど)を抽出します。TypeSystem: LLDB内で言語の内部型モデルを表現します。DWARFから解析されたメタデータを受け取り、ネイティブなLLDB型表現を構築します。Language Plugin: LLDBにFortranを登録し、言語固有のプリティプリンター、値フォーマッタ、合成子プロバイダーを提供します。
LLDBに新しい言語を追加する方法の詳細については、公式のドキュメントを参照してください。
RFCプロセス
LLVMへの大幅な変更を提案する際には、まずRFCプロセスを経る必要があります。簡単に言うと、変更の概要、その動機、変更される全体的なアーキテクチャ、および未解決の質問を提供する提案書が作成されます。その後、フィードバックを受け取り、合意が得られれば、変更は受け入れられ、アップストリームにマージされます。
私のRFCでの合意形成には、メジャーな新機能であったため約2ヶ月かかりましたが、アイデアを伝え、他の開発者と交流する方法について多くのことを学びました。
RFCで到達した最も重要な決定は以下の通りです。
- テストがどこでどのように実行されるかを決定し、ビットローテーションを防ぐためのビルドボット(x86_64 / AArch64)の設定を含めました。
- 式評価は最終的にFlangを使用してサポートされますが、プロジェクトの後半で、GSoCの範囲外となります。
- Flangの要求するビルド要件が高いため、現段階ではLLDBはFlangに直接リンクしません。現時点では、テストを実行するにはFortranコンパイラのみが必要です。
- 配列サポートは、LLDBのコアインフラストラクチャへの侵襲的な変更を行うのではなく、合成子を使用して追加されます。
- Fortranのケースインセンシティブのような言語固有の詳細は、コアLLDBを汚染することなく、DWARF属性(
DW_AT_identifier_case)を介してプラグイン内で処理されます。
テストとアップストリーム
GSoCの大部分では、RFCに関するコミュニティの合意を待つ間、開発は私の個人のLLVMフォークで行われました。合意が得られた後、作業を小さく、段階的にテスト可能なプルリクエストに分割し、メンテナーがレビューしやすいようにすることに焦点を移しました。
回帰なしの長期的な安定性を確保するために、実装は2つの異なるレベルでLLDBのlitベースのテストインフラストラクチャを活用しています。
- 単体テスト (C++): 3つのテストスイートを追加して、コアコンポーネントを個別にテストしました。
TypeSystemFortranTests:TypeSystemFortranがFortran型を正しくインスタンス化、構築、クエリできることを検証します。DWARFASTParserFortranTests: 生のDWARFデバッグ情報が内部型に正確に解析されることをテストします。FortranLanguageTests: 言語プラグインの登録と合成子プロバイダーのフックを検証します。
- APIテスト (Python / SB API): LLDBのスクリプティングブリッジAPIを使用したエンドツーエンドの統合テストです。これらはサンプルFortranプログラムをコンパイルし、デバッグセッションを起動し、プラグイン、DWARFパーサー、型システムが変数を検査し、出力を印刷するために正しく通信していることを検証します。
LLDBのテスト標準の詳細については、公式のテストドキュメントを参照してください。
追加された機能
1. 基盤の構築
APIテストのために、LLDBはサンプルFortranプログラムをコンパイルする必要があります。このパッチは、LLDBのテストランナーを更新して、インストールされているFortranコンパイラを自動的に検出し、Fortranテストスイートを条件付きで有効にします。PR #208298
実際の言語機能を追加する前に、LLDBは内部インターフェース、特に多数のスタブメソッドを必要とするTypeSystemを満たすためにかなりのボイラープレートを必要とします。パッチを段階的でレビューしやすいものにするために、この初期の足場は、アクティブな機能ロジックを含まない3つの最小限のPRに分割されました(言語プラグイン自体の登録を除く)。
- 言語プラグイン登録: LLDB内でFortranをサポートされる言語として登録します。
PR #218014 - TypeSystemスタブ (
TypeSystemFortran): クラスのスケルトンと必要なインターフェースオーバーライドを追加します。
PR #218016 - DWARFパーサースタブ (
DWARFASTParserFortran): DWARF型解析の準備としてパーサースケルトンを追加します。
PR #218024
2. プリミティブ型
Fortranのプリミティブ型は、INTEGER、REAL、LOGICAL、COMPLEX型で構成されており、これらはすべてDW_TAG_base_type DWARFタグによって記述されます。
型システムの実装
TypeSystemFortranは、LLDB内のすべてのFortran型のライフサイクルと表現を管理します。
- メモリ管理と重複排除: リークのないメモリ管理のために、型はベクター内のユニークなポインタとして格納されます。冗長な割り当てを避けるために、LLVMの
FoldingSetは型をユニーク化し、一致する型が要求されたときに既存のインスタンスが再利用されるようにします。 - プリミティブ型の表現: 基本的なプリミティブ型(
INTEGER、REAL、LOGICAL、COMPLEX)を表現するために、型システムは3つの重要なプロパティを追跡します。- 型名
- バイトサイズ
- 型の種類
Add support for basic types in TypeSystemFortran PR #218269
DWARFASTParserの実装
DWARFASTParserFortranは、コンパイラによって生成された生のデバッグシンボルとLLDBの内部型システムをブリッジします。
- タグ認識:
DW_TAG_base_typeとその子を解析し、型に関する情報を収集します。 - スコープ抽出: 型のスコープ/コンテキストを計算します。
- 型構築: 抽出された情報を
TypeSystemFortranに転送して、対応する型をインスタンス化してキャッシュします。
3. 関数とサブルーチン
型システムの実装(関数とサブルーチン)
Fortranの関数とサブルーチンを表現するために、TypeSystemFortranは3つの主要な要素を追跡します。
- パラメータ: 各パラメータの名前と型を格納します。これらは関数シグネチャの構築と実行時の引数検査の解決に使用されます。
- 名前: DWARFパーサーからベース識別子を受け取り、完全なFortranシグネチャ(例:
INTEGER sample(INTEGER arg1))をフォーマットします。 - 戻り値の型: 関数(またはサブルーチンの場合はその不在)の戻り値の型を追跡し、シグネチャを構築して正確な型情報を提供します。
DWARFASTParserの実装(関数とサブルーチン)
Fortranの関数またはサブルーチンに遭遇したとき、DWARFASTParserFortranは2つの主要なタスクを処理します。
- サブプログラム情報の解析:
DW_TAG_subprogram(およびFortranサブルーチン)を識別し、シンボル名、パラメータメタデータ、戻り値の型を抽出し、これらをTypeSystemFortranに渡して関数型をインスタンス化します。 - フレーム境界の計算: サブプログラムの開始および終了メモリアドレス(low/high PC)を決定します。このアドレス範囲は、スタックフレームのアンワインディングに不可欠であり、
frame variableが現在のスコープのローカル変数を正しく見つけて表示できるようにします。
4. 変数の表示
変数の値が正しく表示されるためには、TypeSystemはエンコーディングやフォーマットなど、どのように表示されるべきかの情報を提供し、DumpTypeValueを実装して値をストリームにフォーマットしてダンプします。
この追加により、frame variableは予測可能な方法で変数を表示できます。
(lldb) frame variable num_real
(REAL) num_real = 2.71828175
(lldb) frame variable num_int
(INTEGER) num_int = 152
(lldb) frame variable num_logical
(LOGICAL) num_logical = true
(lldb) frame variable z1
# TypeSystemFortranはFortranでの表示方法に合わせて、complexを(real, imaginary)としてフォーマットします
(COMPLEX(KIND=8)) z1 = (3, 4)
この追加により、出力が以前はテストできなかったため、APIテストも追加されました。
5. ポインタ
非配列型に関連付けられたポインタは、C言語のような言語に似ています。したがって、それらを処理するにはポインタ先型が必要です。
型システムの実装
TypeSystemは、ポインタ先型からポインタ型を作成します。また、ポインタ型からポインタ先型、またはその逆を提供することもできます。
DWARFASTParserの実装
DW_TAG_pointer_typeはポインタ先の型への参照を子として持つため、ポインタ先の型は再帰的にこの参照を使用して解析され、TypeSystemに転送されます。
出力
(lldb) frame variable target_val
(INTEGER) _QFEtarget_val = 42
(lldb) frame variable int_ptr
(INTEGER *) _QFEint_ptr = 0x000055555563d1e8
(lldb) frame variable &target_val
(INTEGER *) &_QFEtarget_val = 0x000055555563d1e8
(lldb) frame variable func_ptr
(INTEGER <unnamed function>(INTEGER * ) *) _QFEfunc_ptr = 0x0000555555556740
(lldb) image lookup -a 0x0000555555556740
Address: pointers[0x0000000000002740] (pointers.PT_LOAD[1]..text + 896)
Summary: pointers`square at pointers.f90:24
出力に関する注意: LLDBはFlangのデマンガーにアクセスできないため、変数はマングリングされた名前で表示されます。
6. 明示的な配列
Fortranの配列はカスタムの境界(例: 1ではなく-1から始まるインデックス)やカスタムのバイトストライド(例: 2要素おきにスライスを作成するなど)を持つことができます。さらに、Fortran配列はC/C++とは異なり、列優先です。例えば、2次元配列では、各列の要素が連続したメモリ位置に格納されるのに対し、C/C++では各行の要素が連続しています。さらに、Fortranでは、C言語でサブ配列へのポインタを生成するのとは異なり、多次元配列の1つの次元のみにインデックスを付けるような部分的なサブスクリプティングは無効です。
配列型の構造
以下は、配列がTypeSystemにどのように格納されるかの表現です。
+-----------------------------------------------------------+
| ArrayType |
| - Element Type : CompilerType (e.g., INTEGER) |
| - Metadata : Flags, Rank |
| - Dimensions : vector<ArrayShape> |
+-----------------------------------------------------------+
|
v (Per Dimension)
+-----------------------------------------------------------+
| ArrayShape |
| - Byte Stride : Memory step between elements |
| - Element Count : Extent of this dimension |
| - Lower Bound : ArrayBound |
| - Upper Bound : ArrayBound |
+-----------------------------------------------------------+
|
v
+-----------------------------------------------------------+
| ArrayBound |
| - Kind : Explicit | Star (*) | Colon(:) |
| - Value : Bound index |
+-----------------------------------------------------------+
注意: Starは仮定サイズ配列を、Colonはallocatable配列を表します。
TypeSystemの実装
frame variableを配列に対して実行すると、LLDBはサブスクリプトを反復的に解決します。まずベース配列を解決し、最初のサブスクリプトを処理し、前の結果に基づいて後続のサブスクリプトを解決します。その結果、ユーザーが多次元配列に対してarr[1]をクエリした場合、LLDBはエラーではなく有効なサブ配列を返す必要があります。Fortran配列は列優先であるため、このサブ配列の要素はメモリ内で連続していませんが、バイトストライドで区切られています。これを処理するために、新しいサブ配列型が作成され、外側の次元が剥がされ、バイトストライドが剥がされた次元の範囲とストライドに基づいてスケーリングされます。この中間型が返され、LLDBがスライスを表示したり、連鎖サブスクリプトのために次元を剥がし続けたりできるようになります。
以下の図は、この解決プロセスを示しています。
論理的な2次元Fortran配列: A(1:3, 1:2)
列 1 列 2
+--------+ +--------+
行 1| A(1,1) | | A(1,2) |
行 2| A(2,1) | | A(2,2) | <-- ユーザーは中間スライス: A[2] をクエリ
行 3| A(3,1) | | A(3,2) |
+--------+ +--------+
物理メモリレイアウト (列優先):
オフセット: 0x00 0x04 0x08 0x0C 0x10 0x14
バイト: [ A(1,1) | A(2,1) | A(3,1) ] [ A(1,2) | A(2,2) | A(3,2) ]
^
|
+------ ストライド = 3 * 4B ------+
(12バイト)
A[2]の中間サブ配列型をLLDBが作成:
- ベースオフセット : 0x04 (idx * sizeof(elem))
- ストライド : 12 B (count(dim 1) * sizeof(elem))
- 要素 : [ A(2,1), A(2,2) ]
仮定サイズ配列(*)
仮定サイズ配列は、最後の次元の最大境界にアスタリスク(*)を使用し、デバッグメタデータ内の総要素数を不明のままにします。処理は標準パスに従いますが、2つの点で異なります。
-
無制限インデックス: 最大境界チェックはバイパスされ、直接要素アクセス(例:
arr[10])が不明な範囲で失敗することなく可能になります。 -
末尾サブ配列表示なし: 最後の次元には既知の要素数がないため、LLDBは子境界を計算できず、中間スライスが後続のサブ配列をリストまたは表示できません。
-
注意: Fortranソース構文は多次元インデックス付けに括弧を使用しますが(例:
A(row, col))、LLDBのframe variable式パスパーサーは現在、Cスタイルのブラケット表記(A[row][col])のみをサポートしています。
DWARFASTParserの実装
DWARFではDW_TAG_array_typeタグが発行され、その子には要素型と、各サブレンジのDW_TAG_subrange_typeタグ(1つ以上)が含まれます。これらには以下の情報が含まれる場合があります。
- 最小および最大境界
- 要素数
- バイトストライド
この情報は収集され、TypeSystemFortranに転送されて配列型が作成されます。
出力
(lldb) frame variable a
(INTEGER(2, 2)) a = {
[1] = ([1] = 1, [2] = 3)
[2] = ([1] = 2, [2] = 4)
}
(lldb) frame variable a[1]
(INTEGER(2)) a[1] = ([1] = 1, [2] = 3)
(lldb) frame variable a[1][2]
(INTEGER) a[1][2] = 3
(lldb) frame variable arr
(INTEGER(3, *)) arr =
(lldb) frame variable arr[1]
(INTEGER(*)) arr[1] =
(lldb) frame variable arr[1][2]
(INTEGER) arr[1][2] = 12
7. 動的配列
Fortranの動的配列は配列ディスクリプタによって記述され、バイトストライド、最小/最大境界、および各サブレンジの要素数に関する情報が格納されます。この情報は実行時に変更される可能性があるため、検査時に動的に評価する必要があります。
Fortranコンパイラは、DWARF式を発行することでこのメタデータを公開します。これはターゲットメモリの状態を評価して、各属性の実行時アドレスと値を計算します。
主なアーキテクチャ上の課題は、LLDB全体が配列ジオメトリを静的であると想定していることでした。ValueObjectやTypeSystemのようなルート構造は、配列要素の値は実行時に変化しても、配列の構造(境界や要素数など)は変化しないと想定しており、もし変化してもその構造が何であるかを知る方法はありません。このモデルはC言語では機能しますが、Fortranでは配列の実際の形状と要素数が実行中に変化し、デバッガはその配列の構造を知ることができるため、破綻します。
コアLLDBインターフェースに侵襲的な変更を加えるのではなく、合成子プロバイダーが使用されました。そのジョブは、ターゲットメモリ内の実行時ディスクリプタを読み取り、アクティブな境界とストライドを含む新しい具体的な型をインスタンス化することです。これにより、TypeSystemを実行時状態から分離したまま、Fortranの動的なレイアウトをきれいに収容できます。
自動配列
実行時変数(例: 関数引数によって決定される境界)に依存する配列のプロパティについては、コンパイラは必要な値を含む隠し変数をDWARFメタデータに発行します。この情報は実行時メモリに resideするため、配列ディスクリプタと同じメカニズムを使用して合成子プロバイダーによって解決されます。
仮定ランク配列
これらの配列は関数に表示され、呼び出し元は同じルーチンに異なる次元の配列を渡すことができます。これらの配列の場合、コンパイラは次元ごとのサブレンジタグの代わりに単一のDW_TAG_generic_subrangeとランク属性(DW_AT_rank)を発行し、実際のランクを提供します。汎用サブレンジの子にあるDWARF式を使用して、各次元の実行時プロパティが決定されます。この解決は合成子プロバイダーによって処理されます。
TypeSystemの実装
必要なDWARF式は配列型内に直接格納され、TypeSystemが実行時情報を含む配列を処理しないようにします。frame variable評価中に、LLDBはまずTypeSystemから子を取得しようとします。静的型が提供できない場合、要求は合成子プロバイダーにフォールバックします。プロバイダーは実行時メタデータを具体的な型に解決し、その解決された型を標準処理のためにTypeSystemに渡します。
DWARFASTParserの実装
配列のDWARF情報は、DWARF式、変数への参照、または数値のいずれかです。DWARFASTParserは配列の型を特定し、適切なフラグをアクティブにする必要があります。そのジョブは、TypeSystemに何を期待するかを通知し、すべての情報を転送することです。
8. 大文字小文字の区別なし
Fortranは大文字小文字を区別しない言語であり、LLDBは大文字小文字を区別しないルックアップを実行するサポートがありませんでした。コンパイラは、大文字小文字に関する情報を提供するDW_AT_identifier_case属性を発行します。この属性を使用して、LLDBは適切な大文字小文字を設定します。一方の大文字小文字を区別しない言語とそうでない言語がある混合言語実行可能ファイルの場合、LLDBは大文字小文字を区別する方にデフォルト設定されます。
次のステップ
残念ながら、配列は当初予想していたよりもはるかに複雑で時間がかかったため、プロジェクトのスコープが変更されました。以下の機能は将来実装されます。
- 文字列
- 派生型
RFCで議論されたように、このプロジェクトの理想的な終着点は、frame variableコマンド(DILと呼ばれる言語に依存しないパーサーを使用)にのみ依存するのではなく、Flangを使用した式評価器を持つことです。
最大の苦労
これは私の最初のプロのプロジェクトであり、多くの人と協力するのも初めてでした。私にとって最も難しかったのは、効果的なコミュニケーション方法を学び、大勢のコミュニティの中で自分の声を見つけることでした。幸いなことに、私のメンターはこの点で大いに助けてくれ、グループディスカッションでより自信を持てるようになりました。
学び
大規模なコードベースをナビゲートする方法について多くを学びました。プロジェクトの終わりまでには、タスクをより速く完了し、情報をより簡単に見つけられるようになりました。同様に重要なのは、大規模なプロジェクトにおける明確なコミュニケーションの重要性と、協力的で役立つコミュニティがどれだけ違いを生むことができるかを実感したことです。
謝辞
メンターであるShivam GuptaとTarun Prabhuに心から感謝したいと思います。彼らはこのプロジェクト全体を通して非常に協力的で、多くのことを教えてくれました。また、LLVMコミュニティ、特にLLDBチームにも感謝したいと思います。彼らはこのプロジェクトのRFCにフィードバックをくれたり、道中で助けてくれたりする時間を割いてくれました。