SwiftUI 導入で LLVM のドキュメント読む羽目になった話

**Update: 続編を書きました**
**[【続編】SwiftUI 導入で LLVM のドキュメント読む羽目になった話](https://qiita.com/AkkeyLab/items/4dea648b67b6998c5019)**

# はじめに
この記事は [CyberAgent Developers Advent Calendar 2019](https://adventar.org/calendars/3981) 9日目の記事になります。
今回は、コンパイラ周りの話も入ってくるので、日頃そこら辺に触れない方でも読んでいただけるようにスライドを多用した記事にしてみました。最後まで読んでいただけると嬉しいです！

# SwiftUI 導入してます！
![xcode-previews-and-llvm.005.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/7b6771b9-71e9-cc31-8e4f-e0a1b2edb048.png)
弊社が運用する恋活サービス「[タップル誕生](https://tapple.me)」iOS 版では SwiftUI を一部で導入しています。
ただ、導入は簡単ではありませんでした。タイトルの通り、 LLVM のドキュメントを読む羽目になった経緯と問題の解決方法を紹介したいと思います。手っ取り早く **解決方法のみを知りたい！** という方は、ページの一番下までスクロールしてみてください！

# SwiftUI 導入方法
![xcode-previews-and-llvm.007.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/c3191a01-e9df-c332-55ea-b2d96b24585f.png)
SwiftUI と UIKit には互換性があるため、共存させることが可能です。なので、 UIKit で設計されたものを SwiftUI のようにプレビューさせることも可能になります。ここらへんに関しては、以前記事を書いてますので参考にしてみてください。

[iOS12 以下をサポートするプロダクトで SwiftUI の恩恵を得る方法](https://qiita.com/AkkeyLab/items/7f8952718420e47b2a77)
参考：[AkkeyLab/AutoPreviewable](https://github.com/AkkeyLab/AutoPreviewable)
参考：[AkkeyLab/XcodePreviewsTemplate](https://github.com/AkkeyLab/XcodePreviewsTemplate)

# 地獄の始まり
![xcode-previews-and-llvm.010.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/d142deb5-3332-6409-11a3-7251f4a04c01.png)
サンプルプロジェクトを作って SwiftUI を試していた私は完全に油断していました。実際のプロダクトで Xcode Preview が動かないんです（※）。しかも、1行の長々とした不親切なエラーを出力するだけ（内容的には、「〜が読み込めませんでした」という感じでした）。

※ SwiftUI を用いた設計・実行等は可能です

![xcode-previews-and-llvm.019.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/ae0a60ab-4deb-fe40-9fbe-a2b48c89c48d.png)
先程のエラーの一部で検索を試みますが、 Flutter や Xamarin の記事ばかりで肝心の SwiftUI に関連するのもにはたどり着けませんでした。
この情報不足感は Swift 発表当初を思い出しますね。だからといって、諦めるわけにはいかないのですが、日頃の業務の空き時間等にちょこちょこ SwiftUI への対応を進めていたので、一旦ここで調査を中断しました。

![xcode-previews-and-llvm-neo.006.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/ba0afa95-c6dc-64a8-fb99-e779e2d6edbf.png)
**（解釈ミスを修正したスライドに差し替えました）**
そして、休日に個人で開発を行っている動画視聴アプリ「[AkkeyTV](https://apps.apple.com/jp/app/akkeytv/id1453406882)」の SwiftUI 対応を試みました。なんとなくわかっていましたが、同じく Xcode Preview に失敗しました。（スクショは、リポジトリの issue に貼り付けたエラーコード）
ただ、このエラーコードが問題解決に大きく貢献することになります。

![xcode-previews-and-llvm.028.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/5c03b306-90b8-2971-6916-bcb3f36992b6.png)
先程のエラーをもとに調査を進めたところ、 SwiftUI で同様の問題に直面している記事にたどり着きました。そこに書かれていたことをざっくりとまとめると「カバレッジを有効にした状態でプレビューできない」というものでした。
実際にカバレッジを無効にしてみると [tapple](https://tapple.me) でも [AkkeyTV](https://apps.apple.com/jp/app/akkeytv/id1453406882) でも Xcode Preview が正常に動作するようになりました！しかし、テストを書きながら開発を進めているため、この解決方法はボツにしました。

引用元：[Undefined symbols \___llvm\_profile\_runtime](https://stackoverflow.com/questions/58127940/undefined-symbols-llvm-profile-runtime)

![xcode-previews-and-llvm.032.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/6432d7ee-fc30-eac1-d2d6-3539cdd8bae8.png)
更に調査を進めたところ、 SwiftUI 以外でも同様のエラーが出ることがあり、それは `static framework` に関係しているということがわかりました。そして、 Linker flags に `-fprofile-instr-generate` を追加するとうまく動作するという解決策にたどり着いたのです！
実際にフラグを追加してみると [tapple](https://tapple.me) でも [AkkeyTV](https://apps.apple.com/jp/app/akkeytv/id1453406882) でも Xcode Preview が正常に動作するようになりました！

引用元：[ReactiveCocoa/ReactiveSwift > issue > Optimization Level configuration #552](https://github.com/ReactiveCocoa/ReactiveSwift/issues/552#issue-273165407)

# 状況整理
![xcode-previews-and-llvm.044.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/3a79f8f9-2f06-f1b1-b422-953f1995218b.png)
ここで一旦、状況を整理します。
問題の解決はできたものの、「 `-fprofile-instr-generate` というフラグが一体何者なのか」という新たな疑問が生まれてきました。このフラグが原因でアプリが正常に動作しなくなったり、開発効率が低下するようなことがあってはいけないため、このフラグに対する調査も引き続き行っていきます。

# 問題解決の裏側
![xcode-previews-and-llvm.047.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/53602109-6e75-4c5c-8a58-eee564e8c667.png)
まず、「このフラグが何者なのか」この疑問に対する答えがこれです。 clang を使ってソースコードのカバレッジも出力したいときに付加させるフラグだということがわかります。

![xcode-previews-and-llvm.051.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/48741f48-de62-295a-659d-0bba0322972d.png)
さて、先程の説明文に出てきた見慣れない用語についても触れておきましょう。
これで、 `-fprofile-instr-generate` というフラグに関してはある程度わかったと思います。

![xcode-previews-and-llvm.055.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/c8bf32e3-2d49-6f82-cc62-038990a71c40.png)
ここで、少し前のスライドにフラグに関することも追加してみます。この解釈だと、矛盾が生じているように見えます。
そこで、もう少し視野を広げて、 Xcode のビルド方法について見ていくことにします。

![xcode-previews-and-llvm.058.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/0f564c6b-d632-d3a4-a5d3-581adc4776b0.png)
iOS は Objective-C と Swift を1つのプロジェクトで利用できることからもわかるように C 系のコンパイラである `clang` と Swift コンパイラである `swiftc` によってビルドが行われています。
ここで、 `Linker` については [こちら](https://en.wikipedia.org/wiki/Linker_(computing)) を参考にしてください。

内部的に Xcode は各コンパイラに対して引数を渡してコマンドを叩いているだけなので、そのコマンド引数に渡されるオプションについて調べてみることにします。

![xcode-previews-and-llvm.060.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/f57cb9dc-7207-4c1f-a523-28a973dcc06c.png)
プロジェクトの設定ファイルなどに記載された各種設定項目から、コマンド引数に渡すオプションに変換するルールブックのようなものが Xcode の奥深くに置かれています。
これは `clang` の場合になりますが、 `xcspec` という拡張子のファイルに記述されており、カバレッジが有効であるときに2つのフラグをコマンド引数に設定するように記述されていることが確認できます。つまり、カバレッジを有効にした時点で `-fprofile-instr-generate` というフラグはコマンド引数に渡されていたということです。

では、 Linker flags に `-fprofile-instr-generate` を追加することと、カバレッジを有効にすることにはどのような違いがあるのでしょうか。→【Xcode Build System】

![xcode-previews-and-llvm.064.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/7c909cf0-81ca-bfa0-a3cd-d30e184a93a0.png)
`swiftc` に対する `xcspec` も同様の処理が記述されています。

![xcode-previews-and-llvm.065.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/926c6194-c0e6-fc84-154e-1818945de752.png)
同様のファイルは `Linker` に対しても存在していますが、カバレッジに関する処理はありませんでした。

![xcode-previews-and-llvm.068.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/f22c58dc-8687-69c6-ca21-70265ff71d4d.png)
ここで、もう少し深く見てみようと思います。
我々が記述するソースコードが機械語に変換されてアプリとして起動するまでを図にまとめてみました。

![xcode-previews-and-llvm.071.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/d280e0ec-5317-e656-af09-ac6da0bdf59c.png)
各種コンパイラと Linker の存在を図に挿入し、渡されるフラグに関しても追記してみました。
ここでわかってくるのは、カバレッジを有効にすることでフラグが渡される対象と、 Linker flags のフラグが渡される対象が異なっているということです。

# 考察
![xcode-previews-and-llvm.075.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128344/d7d7e79d-2b45-8c8e-43b8-1d58ce59e923.png)
今後、引き続き調査と勉強を継続していきます。
そのため、この記事には解釈の間違い等が含まれている可能性があります。間違いにお気づきの際は、コメント等いただけると嬉しいです。

# さいごに
タイトルに「読む羽目になった」と書きましたが、実際に原因を探り、コンパイラ等の技術について学ぶ時間はとても有意義な時間でした。（記事を読んで伝わったのではないかとは思いますが）嫌々ドキュメントを読んでいたわけではないのでご安心ください！

最後までご覧いただき、ありがとうございました！