CatHand Blog

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

#VLCKit #libVLC #macOS #Swift #SwiftPM #PixelFinder #デッドロック #デバッグ #アプリ開発

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

PixelFinder(macOS の画像・動画ビューア)がたまに固まる不具合を調べていたら、原因は VLCKit が libVLC に当てているパッチにありました。直したパッチと、それでビルドした VLCKit を公開しています。↓

vlckit-macos-patched

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 にパッチを当ててからビルドしています。そのパッチを読んで原因がわかりました。

これだけなら無駄に保存するだけなのですが、ロックの取り方と組み合わさって止まります。

ホバー再生でプレイヤーを次々に作っては止めるので、保存(読み取りの二重取り)と書き込みが同時に走りやすかったわけです。

上流の VLCKit にも、同じ症状の issue が 2022 年から開いています(原因の指摘はまだありません)。↓

VLCKit #631

テストで再現させる

XCTest で、次の 4 つをそれぞれ別のスレッドで 20 秒回し、5 秒進まないスレッドがあればデッドロックとみなす試験を書きました。

libVLC の関数は、VLCKit から dlsym で取り出して呼んでいます。動画ファイルは無くても再現しました。入力スレッドが作られて閉じられれば十分なようです。

同じ内容を 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 に切り替えて、固まる不具合は直りました。↓

PixelFinder(App Store)

2026-10 より前の記事は Tumblr にあります。