PixelFinder のフリーズと VLCKit のデッドロック

PixelFinder(macOS の画像・動画ビューア)がたまに固まる不具合を調べていたら、原因は VLCKit が libVLC に当てているパッチにありました。直したパッチと、それでビルドした VLCKit を公開しています。↓
VideoLAN の公式のものではなく、手元の Mac でビルドした非公式版です。
症状
PixelFinder 1.5.3 で、画像と動画の多いフォルダを開いてサムネイル一覧を触っていると、たまにレインボーカーソルのまま戻らなくなります。数分待っても戻らず、強制終了してもハングレポートが残りません。
一覧では、動画のサムネイルにマウスを乗せると VLCKit で再生します(ホバー再生)。プレイヤーごとに VLCMediaPlayer(options:) で libVLC のインスタンスを作っています。
止まっている場所を見る
推測で直す前に、止まっている最中に sample でスタックを取りました。
sample PixelFinder 10 -file <出力先>
メインスレッドはここで止まっていました。
mouseEntered
→ プレイヤーの生成
→ -[VLCLibrary initWithOptions:]
→ config_GetInt (core.c:108)
→ __psynch_rw_rdlock
ほかの十数本のスレッドも、config_GetInt・config_GetPsz・config_AutoSaveConfigFile で読み取りロックを、config_PutPsz で書き込みロックを、同じ rwlock で待っていて、どれも進んでいません。VLCMediaPlayer は約 50 個生きていて、メモリは 2.6GB でした。
書かれるはずのない vlcrc
アプリのサンドボックスを見ると、libVLC の設定ファイル vlcrc(88KB)が書かれていました。中身で意味があるのは auhal-audio-device=0 の 1 行だけ。書きかけの一時ファイル vlcrc.<番号> も 6 個残っていました。
--ignore-config を付けても vlcrc は書かれ続けます。Xcode で config_SaveConfigFile と config_AutoSaveConfigFile にブレークポイントを置くと、worker_thread(media_player.c:1221)から呼ばれていました。ところが、本家の libVLC 3.0.23 の media_player.c には worker_thread がありません。
原因は VLCKit のパッチ
VLCKit は libVLC にパッチを当ててからビルドしています。そのパッチを読んで原因がわかりました。
0015-lib-save-configuration-after-playback-parse.patchが、入力を閉じるたび(再生の停止)と、解析済みのメディアを解放するたびにconfig_AutoSaveConfigFile()を呼びます。パッチの説明によると、アプリは libVLC のインスタンスを終了まで持ち続けて、強制終了などで後片付けできないことが多いので、再生や解析のたびに保存する、とのことです。- この呼び出しは
ignore-configを見ていません。本家の保存は libvlc.c:422 でignore-configを確かめてから保存します(ignore-configの既定は true)。 0024-lib-media_player-add-stop-set_media-async-support.patch(停止を別スレッドで行う。VLC 4 の機能のバックポート)が、0015 の呼び出しをworker_threadなどに入れ直しています。
これだけなら無駄に保存するだけなのですが、ロックの取り方と組み合わさって止まります。
config_AutoSaveConfigFile()(src/config/file.c:531)は、プロセス共通のconfig_lockの読み取りロックを取ったままconfig_SaveConfigFile()を呼び、その中(380 行目)でもう一度読み取りロックを取ります。ソースには「Note: this will get the read lock recursively. Ok.」とコメントがあります。- 書き込み側は
config_PutPsz()です。音声出力の auhal は、閉じるたびにauhal-audio-deviceを書きます(auhal.c:1689)。libVLC 3 はプレイヤーを作った時点で音声出力を開く(media_player.c:748)ので、プレイヤーを作って捨てるたびに書き込みが起きます。 - macOS の pthread の rwlock は、書き込みを待つスレッドがいると、後から来た読み取りを待たせます。1 回目と 2 回目の読み取りロックの間に書き込み待ちが入ると、2 回目が取れません。書き込み側は 1 回目の読み取りロックが外れるのを待っているので、どちらも進まず、設定を読む全員が止まります。
ホバー再生でプレイヤーを次々に作っては止めるので、保存(読み取りの二重取り)と書き込みが同時に走りやすかったわけです。
上流の VLCKit にも、同じ症状の issue が 2022 年から開いています(原因の指摘はまだありません)。↓
テストで再現させる
XCTest で、次の 4 つをそれぞれ別のスレッドで 20 秒回し、5 秒進まないスレッドがあればデッドロックとみなす試験を書きました。
- 再生の停止(同期・非同期)
- 解析済みメディアの解放
config_PutPsz(書き込み)config_GetInt(読み取り)
libVLC の関数は、VLCKit から dlsym で取り出して呼んでいます。動画ファイルは無くても再現しました。入力スレッドが作られて閉じられれば十分なようです。
- 公式の VLCKit 3.7.3: 停止・解析と書き込みを同時に回すと 3〜5 秒で止まる。書き込みなし、または停止・解析なしなら止まらない。
- 修正版: 止まらない。20 秒で同期停止が各約 740 回、非同期停止が各約 750 回、解析が各約 2700 回、書き込みが各約 236 万回進んだ。
同じ内容を C の試験プログラムでも書いて、公式の 3.7.3 と 3.6.0 は 3 回ともデッドロック、修正版は 3 回とも止まらないのを確かめました。
1.5.2 まで使っていた vlckit-spm 版の VLCKit 3.6.0(libVLC 3.0.21)でも、同じように止まります。src/config/file.c は 3.0.21 と 3.0.23 で同じです。「1.5.3 から起きるようになった気がする」のですが、条件自体は前からあって、1.5.3 で起きやすくなった理由はまだわかっていません。
直し方
パッチ 9001-lib-do-not-auto-save-the-configuration-after-playback.patch で、VLCKit のパッチが入れた config_AutoSaveConfigFile の呼び出し 3 か所(lib/media.c に 1 か所、lib/media_player.c に 2 か所)を消しました。本家の終了時の保存は残りますが、既定では動かないので、vlcrc も書かれなくなります。
config_AutoSaveConfigFile で読み取りロックを外してから保存する、という直し方も考えました。ただ、上流には出さないつもりなので、保存ごと消して vlcrc の無駄な書き込みも止めるほうにしました。
ビルド
fork はせず、VLCKit 3.7.3 のタグを clone して libvlc/patches/ に自前のパッチを足し、公式の buildVLCKit.sh でビルドしています。パッチはファイル名の順に git am されるので、9001- にしておけば公式の 0001〜0047 のあとに当たります。0015 を消すだけだと 0024 が当たらなくなる(0024 が 0015 の行を前提にしている)ので、打ち消すパッチを足す形にしました。
ビルドは初回が約 16 分(libVLC と依存ライブラリをすべてソースからビルド。作業場所は約 10GB)、2 回目からは約 4 分でした。
リポジトリに Package.swift を置いて、Release に xcframework の zip(約 125MB)を置いてあるので、SwiftPM でそのまま使えます。
.package(url: "https://github.com/cathandnya/vlckit-macos-patched.git", exact: "3.7.3-patched.1")
PixelFinder のほう
PixelFinder は 1.5.4 でこの VLCKit に切り替えて、固まる不具合は直りました。↓