こんにちは！日々のデバッグ作業、お疲れ様です。
突然ですが、CやC++で書かれた複雑なポインタの網の目、あるいは独自のメモリ管理をしている巨大な構造体をデバッグしていて、こんな絶望感を味わったことはありませんか？
「`print node->next->sub_node->data` を打つのがもう面倒くさい……」
「生ポインタの数値（`0x7fff5fbff800`）を見せられても、人間には何の意味もわからないよ！」
GDBやLLDBといった低レイヤデバッガは、プログラマの最強の武器ですが、デフォルトのままでは「機械にとって都合のいい生データ」しか見せてくれません。これを人間の脳が理解しやすい美しい形に翻訳できたら、デバッグ速度は文字通り10倍に跳ね上がります。
今回は、LLDBのPython APIを駆使して、複雑なデータ構造をあなた好みに美しく可視化する「カスタムコマンド」の作り方を、優しく徹底的に解説していきます。これをマスターすれば、毎日のコーディングとバグ退治が劇的に楽になりますよ！
—
1. なぜ「LLDBのPython拡張」なのか？
現代のモダンな開発において、LLDBは単なる「ブレークポイントを貼るツール」ではありません。LLDBの内部にはPythonインタープリターが丸ごと埋め込まれており、デバッガが保持するメモリ空間、スレッド、変数などのあらゆるオブジェクトに、Pythonから直接アクセスできるようになっています。
市販のIDEのGUIデバッグ画面も便利ですが、プロジェクト固有の複雑なドメインモデルや、独自実装のリングバッファ、ツリー構造などは、GUIのデフォルト表示では太刀打ちできません。
「自分が見たい形式で、一撃でデータを整形して出力させたい」
このわがままを完璧に叶えてくれるのが、LLDBのPythonスクリプト拡張なのです。
—
2. 基礎セットアップ：LLDBとPythonの連携を確認する
まずは、お手元の環境でLLDBがPythonスクリプトを受け入れられる状態になっているかを確認しましょう。特別なインストールの必要はなく、macOS（Xcode付属のLLDB）やLinux（LLVM公式のLLDB）であれば、最初からPython 3に対応しています。
動作確認：LLDB内でPythonを動かしてみる
ターミナルで適当なバイナリ（または単に `lldb` コマンド単体）を起動し、LLDBのプロンプトからPythonコードを実行してみましょう。
$ lldb
(lldb) script print(“Hello from LLDB Python!”)
Hello from LLDB Python!
たったこれだけです！ `script` コマンドの後に続くPythonコードは、すべてLLDBのプロセス内で実行されます。
ここから先は、このPythonのパワーをフルに使って、カスタムコマンドを自作していきましょう。
—
3. 実践！複雑なポインタ構造を美しく可視化するスクリプト
今回は、「ネストしたポインタをたどり、特定のフィールドをきれいに表形式で出力するカスタムコマンド」を作ってみます。
例えば、以下のようなリンクリストやツリー構造のノードを想像してください。
struct Node {
int id;
char name;
struct Node next;
};
この `Node` のポインタを渡すと、`next` を自動でゴリゴリと辿っていき、全要素をリストアップしてくれる魔法のコマンド `print-chain` を作ります。
カスタムスクリプトファイルを書く
任意の場所に `lldb_helpers.py` というファイルを作成し、以下のコードを記述してください。
lldb_helpers.py
import lldb
def print_chain_command(debugger, command, result, internal_dict):
“””
使い方: print-chain
指定されたポインタから始めて、nextポインタを辿りながら中身を美しく表示する
“””
# 1. ターゲット（現在デバッグ中のプロセス）を取得
target = debugger.GetSelectedTarget()
if not target:
result.SetError(“有効なターゲットが見つかりません。”)
return
# 2. ユーザーがコマンドに入力した引数（変数名など）を評価してLLDBのValueオブジェクトを取得
# 例: “head_node” という文字列が渡されたら、そのメモリ上の値を評価する
value = target.EvaluateExpression(command)
if value.GetError().Fail():
result.SetError(f”式の評価に失敗しました: {value.GetError()}”)
return
# 3. ヘッダーの出力
output = []
output.append(“=” 50)
output.append(f”{‘INDEX’:<6} | {'ID':<6} | {'NAME':<20} | {'ADDRESS':<18}")
output.append("-" 50)
# 4. ポインタを辿るループ処理
index = 0
current = value
# ポインタが有効（NULLではない）かつ、型が構造体である間ループを回す
while current.IsValid() and int(current.GetValueAsUnsigned()) != 0:
# ポインタ型の場合は中身（デリファレンス）を取得
if current.Type().IsPointerType():
deref = current.Dereference()
else:
deref = current
if not deref.IsValid():
break
# 構造体のメンバ変数に安全にアクセス
# 実際の構造体の定義（id, name, next）に合わせてメンバ名を取得
node_id = deref.GetChildMemberWithName("id").GetValue()
node_name = deref.GetChildMemberWithName("name").GetSummary()
addr = hex(current.GetValueAsUnsigned())
# リストに整形済み文字列を追加
output.append(f"{index:<6} | {node_id:<6} | {str(node_name):<20} | {addr:<18}")
# 次のノードへポインタを進める (nextメンバを取得)
current = deref.GetChildMemberWithName("next")
index += 1
output.append("=" 50)
# 結果をLLDBのコンソールに出力
result.PutCString("\n".join(output))
5. LLDBにこのPython関数をカスタムコマンドとして登録する初期化関数
def __lldb_init_module(debugger, internal_dict):
# LLDBのコンソール上で 'print-chain' というコマンドを実行できるように登録
debugger.HandleCommand('command script add -f lldb_helpers.print_chain_command print-chain')
print("✨ Custom LLDB Command 'print-chain' loaded successfully!")
---
4. LLDBにスクリプトを読み込ませて実行する
作成したPythonスクリプトを、LLDBの起動時あるいはセッション中に読み込ませます。
セッション中で読み込む場合
LLDBを起動した状態で、以下のコマンドを実行します。
(lldb) command script import /path/to/lldb_helpers.py
✨ Custom LLDB Command ‘print-chain’ loaded successfully!
これだけで、`print-chain` という独自のデバッグコマンドが誕生しました！
毎回自動で読み込ませるテクニック（超重要）
ホームディレクトリに `.lldbinit` という設定ファイルを作り、そこに記述しておけば、LLDBを起動するたびに自動でこのスクリプトがロードされます。毎回のロードの手間が消えるため、実務では必須の設定です。
~/.lldbinit
command script import /path/to/lldb_helpers.py
—
5. 動作確認：実際に使ってみる
デバッグ対象のプログラムでブレークポイントにヒットし、リンクリストの先頭ポインタ（例: `head`）がある状態で、以下のように打ってみてください。
(lldb) print-chain head
すると、コンソールには以下のような、人間にとって圧倒的に読みやすい表が出現します。
==================================================
INDEX | ID | NAME | ADDRESS
————————————————–
0 | 42 | “Alice” | 0x7fa9e1404800
1 | 55 | “Bob” | 0x7fa9e1404820
2 | 99 | “Charlie” | 0x7fa9e1404840
==================================================
どうでしょう？ 生のポインタ値を頭の中で組み立てる必要はもうありません。複雑な木構造（Tree）やグラフ構造のデバッグでも、このアプローチを使えば、特定の条件を満たすノードを赤字でハイライトしたり、不正なポインタ（循環参照など）を検知して警告を出したりするカスタムバリデーターを自由自在に作ることができます。
—
先輩エンジニアからのエール
今回はLLDBのPython APIを使ったカスタムコマンドの基本と、複雑なデータ構造の可視化手法をご紹介しました。
「たかがデバッグ表示」と思われるかもしれませんが、日々の開発において「データ構造を把握するまでの認知負荷」を下げることは、開発スピードとコードの品質に直結する極めて重要な要素です。
最初は難しく感じるかもしれませんが、LLDBのPython APIは非常に洗練されており、慣れれば数行書くだけで強力な専用ツールが手に入ります。ぜひ、あなたのプロジェクトのドメインモデルに合わせた「マイ・デバッグツール」を育ててみてください。
これをマスターすれば、毎日のコーディングが劇的に楽になりますよ。応援しています！