使用 Python 和 LLDB 解决二进制 Pod 到源码映射问题并实现单步调试

前言

随着公司业务不断发展，组件化已经成为趋势，大多都是将各个组件拆分为一个个 Pod，然后通过 Podfile 集成到一起。为了加快编译速度，很多 Pod 组件都会做出二进制的形式，提前编译好，然而这样又带来一个问题就是如果二进制 Pod 中发生 crash 的话，我们得到的只能是一些看不懂的汇编代码，无法单步调试。本文的方案可以解决这个问题，实现二进制到源码的映射，同时能够实现单步调试。

整个操作流程如下

基本原理

二进制 Pod 里面保存有编译时的文件路径，断点调试其实就是根据这个文件路径来找到对应源码的，可以通过 LLDB 命令找到这个编译时的源码文件路径，找到对应的文件名字和对应的组件，如果本地没有对应组件就从仓库下载下来，然后找到本地的对应源码文件路径，demo 中我是直接将源码文件放到 /localPods/MapSourceTest 下面。编译路径和本地源码路径获取到以后保存到本地的 path.txt 文件中，下次在断点之前从 path.txt 文件中读出这两个路径，使用 LLDB 命令将编译时的路径替换为本地源码路径就好，然后进入下一步就可以单步调试了。

美团有一篇文章也是讲二进制 Pod 调试的，美团 iOS 工程 zsource 命令背后的那些事儿
相比而言本方案有几个优点如下：

使用苹果自带工具链，不依赖 pod，门槛低，具备通用性；
不需要源码路径跟编译路径保持一致；
直接在 Xcode 控制台操作，不需要切换到终端，体验友好。

技术实现

一. LLDB 命令

image lookup -v --address

LLDB 有很多方便调试的强大的命令，比如查看符号地址所在编译模块信息

image lookup -v --address 0x1010d7dc2

输出内容如下：

Address: MapSourceTest[0x0000000000000dc2] (MapSourceTest.__TEXT.__text + 178)
Summary: MapSourceTest`-[GHWMapSourceTest testFail] + 178 at GHWMapSourceTest.m:18:25
Module: file = "/Users/guohongwei719/Library/Developer/Xcode/DerivedData/GHWBinaryMapSource-dlmtihzqvwjdjgeckvxjxhciwtog/Build/Products/Debug-iphonesimulator/GHWBinaryMapSource.app/Frameworks/MapSourceTest.framework/MapSourceTest", arch = "x86_64"
CompileUnit: id = {0x00000000}, file = "/Users/guohongwei719/Desktop/MapSourceTest/MapSourceTest/GHWMapSourceTest.m", language = "objective-c"
Function: id = {0x100000090}, name = "-[GHWMapSourceTest testFail]", range = [0x00000001010d7d10-0x00000001010d7e51)
FuncType: id = {0x100000090}, decl = GHWMapSourceTest.m:13, compiler_type = "void (void)"
Blocks: id = {0x100000090}, range = [0x1010d7d10-0x1010d7e51)
LineEntry: [0x00000001010d7dae-0x00000001010d7dd1): /Users/guohongwei719/Desktop/MapSourceTest/MapSourceTest/GHWMapSourceTest.m:18:25
Symbol: id = {0x00000004}, range = [0x00000001010d7d10-0x00000001010d7e60), name="-[GHWMapSourceTest testFail]"
Variable: id = {0x1000000a9}, name = "self", type = "GHWMapSourceTest *const", location = DW_OP_fbreg(-24), decl = 
Variable: id = {0x1000000b5}, name = "_cmd", type = "SEL", location = DW_OP_fbreg(-32), decl = 
Variable: id = {0x1000000c1}, name = "array", type = "NSArray *", location = DW_OP_fbreg(-40), decl = GHWMapSourceTest.m:17

从输出内容可以通过看到编译源文件路径相关信息，可以通过正则表达式找出来。

settings set target.source-map

LLDB 还有个强大的命令可以将编译源码路径与当前源码位置映射

settings set target.source-map 编译源码文件路径  本地源码文件路径

二. Python 定制 LLDB 命令

既然 LLDB 里面已经有了我们功能相关的核心命令，直接敲 LLDB 命令就可以搞定我们需求了，理论上是这样的。但是人生苦短，敲这么多命令太累，有没有更简单的办法呢，有，Python 登场了。

Python 的库很多，所以功能强大，也有 LLDB 相关的模块，就叫 lldb，在 Python 文件头部 import 即可，引入 lldb 模块来与调试器交互获取各种信息，比如命令的参数等。

import lldb
import re
import os

在 Python 代码里面如何执行 LLDB 命令呢，看如下代码

// 获取 lldb 的命令交互环境，可以动态执行一些命令，比如 po obj
interpreter = lldb.debugger.GetCommandInterpreter()

// 创建一个对象，命令执行结果会通过该对象保存
returnObject = lldb.SBCommandReturnObject()

// 通过 image loopup 命令查找输入符号地址所在的编译模块信息
interpreter.HandleCommand('image lookup -v --address ' + command, returnObject)

// 获取返回结果
output = returnObject.GetOutput();
print('output: ' + output)

既然 Python 能帮我们执行这些 LLDB 命令，解决我们需求，那么如何自定义一个 LLDB 命令，在控制台输入的时候能够自动执行一个 Python 文件里面代码呢？

LLDB 有一个非常好用的函数叫 lldb_init_module。一旦 Python 模块被加载到 LLDB 中时它就会被调用。这意味着你可以在这个函数里面把你的自定义命令安装到 LLDB 里面去，我这里 Python 文件名是 GHWBinaryMapSource.py，命令叫 gMapSource。

Python 文件中的 _lldb_init_module 函数如下

def __lldb_init_module(debugger, internal_dict):
    debugger.HandleCommand('command script add gMapSource -f GHWBinaryMapSource.gMapSource')

这样就添加了一个扩展命令 gMapSource，在 lldb 控制台输入 gMapSource 0x1010d7dc2 时，会执行 GHWBinaryMapSource.py 文件的 gMapSource 方法。

Python 文件准备好了，如何更方便的加载到 LLDB 中呢，也就是说如何更快导入进来，以后每次打开 Xcode 都可以用这个命令呢。

在你的 home 目录下可以找到这个文件 .lldbinit，如下图

在 .lldbinit 文件中添加如下代码， import 我们的脚本代码，当然要修改为你自己的路径。

command script import /Users/guohongwei719/Desktop/GHWBinaryMapSource/script/GHWBinaryMapSource.py

以后每次启动都会 LLDB 都可以使用这个命令了。

实际操作流程

demo clone 下来，去修改 ~/.lldbinit 文件，添加 GHWBinaryMapSource.py，注意路径改为自己本地路径
修改 GHWBinaryMapSource.py 文件，将代码中的 /Users/guohongwei719/Desktop/GHWBinaryMapSource/script/path.txt 替换为你自己的路径，/Users/guohongwei719/Desktop/GHWBinaryMapSource/localPods/BinaryToSource 也要替换为你自己的路径。
运行demo，配置好 Breakpoint，如下图，不然崩溃以后直接到 main 函数了，连崩溃的汇编代码都看不到
点击界面的蓝色按钮，不出意外的话会出现类似下面的崩溃界面复制对应行的地址信息，到控制台敲我们自定义的命令

(lldb) gMapSource 0x106516dc2

这样崩溃地址的编译源码文件路径和本地源码文件路径就写入到 path.txt 文件中了，继续往下运行，可以看到对应崩溃源码位置，打上断点。

在进入崩溃二进制 Pod 之前打断点，重新运行项目，运行到断点位置，执行我们的自定义命令 gMapSource，此时不带参数，这样会自动读取 path.txt 中上一步写入的路径信息，将编译路径和本地源码路径进行映射。
继续往下执行，不出意外就可以看到运行到崩溃位置之前断点位置，此时此刻就可以进行单步调试了。如下图

后记

欢迎提一起探讨技术问题，觉得可以给我点个 star，谢谢。
微博：黑化肥发灰11
简书地址：https://www.jianshu.com/u/fb5591dbd1bf
掘金地址：https://juejin.im/user/595b50896fb9a06ba82d14d4

guohongwei719/GHWBinaryMapSource