漫谈LLDB：SBExpressionOptions简介

前言

首先要说明的是，这篇文章只是总结我的经验，不保证完全正确。如有错漏还望读者留言指正。
之所以要写这篇文章，是因为我的开源项目HMLLDB有个核心的函数HMLLDBHelpers.evaluateExpressionValue，里面用到了SBExpressionOptions这个选项，如果不说明一下，未来要写的相关文章都不好交代。
另外LLDB自带的expression命令有些选项和SBExpressionOptions是对应关系，读者可以根据名称对比一下。

SBExpressionOptions是什么

如果有用过SB API的话，肯定对SBExpressionOptions有印象，无论是SBTarget还是SBFrame都有一个EvaluateExpression函数用于执行代码表达式（两者有区别，以后有机会再谈），而这个函数参数支持传入一个SBExpressionOptions对象，看名称就知道是干什么的，附上官方文档对此类的说明：

A container for options to use when evaluating expressions.

SBExpressionOptions方法解释

方法	解释
SetCoerceResultToId	执行表达式后，是否将结果强制转换为id类型
SetFetchDynamicValue	可将结果转换为动态类型。可以设置3个值，依次是`eNoDynamicValues`(0)，`eDynamicCanRunTarget`(1)，`eDynamicDontRunTarget`(2)。如果一个`NSArray `对象，0表示为`NSArray `类型，1、2则表示为`__NSArrayI *`类型
SetUnwindOnError	是否在错误时回溯堆栈信息
SetIgnoreBreakpoints	执行表达式时，是否忽略断点的命中
SetGenerateDebugInfo	官方给出的解释是设置是否为表达式生成调试信息，还控制是否生成SBModule。但我却没测试出区别，还不了解
SetTimeoutInMicroSeconds	执行表达式的超时时间，单位为微秒，设置为0则永不超时
SetOneThreadTimeoutInMicroSeconds	执行表达式在一个线程上的超时时间，微秒，必须小于GetTimeoutInMicroSeconds的值
SetTryAllThreads	如果表达式在一个线程上未完成，是否运行所有的线程
SetStopOthers	执行表达式时是否停止其他线程
SetTrapExceptions	如果执行表达式引发了异常，是否中止执行
SetPlaygroundTransformEnabled	这个函数官网文档没有，源码也没有，意义不明
SetREPLMode	这个函数官网文档没有，源码也没有，意义不明
SetLanguage	设置表达式所用的语言LanguageType，一般常用`eLanguageTypeObjC`、`eLanguageTypeObjC_plus_plus`、`eLanguageTypeSwift`。不设置则会根据上下文推断语言类型
SetSuppressPersistentResult	设置为True，表达式结果就不会持久化。另外需要注意的是，LLDB的即时编译没有自动插入ARC释放的代码，表达式内alloc的对象，并不会释放，所以未释放对象和此项配置无关
SetPrefix	设置表达式前缀。LLDB中经常要使用typedef，可以先配置好，另外也可以配置宏定义
SetAutoApplyFixIts	设置为True，如果表达式有简单的拼写错误，会自动修正
SetRetriesWithFixIts	尝试修正的次数（Xcode 12.5新增）
SetTopLevel	是否忽略上下文，将表达式解析为顶级的实体。比如可以设为True，在表达式里定义一个C语言的外部函数或外部变量。
SetAllowJIT	如果不能解析表达式，是否进行即时编译

SBExpressionOptions的默认值

安装HMLLDB，随便运行一个iOS项目，进入LLDB调试模式后，可以通过plldbClassInfo SBExpressionOptions命令查看其默认值

方法	默认值
GetCoerceResultToId	False
GetFetchDynamicValue	0，即`eNoDynamicValues`
GetUnwindOnError	True
GetIgnoreBreakpoints	False
GetGenerateDebugInfo	False
GetTimeoutInMicroSeconds	500000
GetOneThreadTimeoutInMicroSeconds	0
GetTryAllThreads	True
GetStopOthers	True
GetTrapExceptions	True
GetPlaygroundTransformEnabled	False
GetREPLMode	False
SetLanguage	没有对应的Get方法，不设置则会根据上下文推断语言类型。
GetSuppressPersistentResult	False
GetPrefix	None
GetAutoApplyFixIts	True
GetRetriesWithFixIts	1
GetTopLevel	False
GetAllowJIT	True

HMLLDB项目的配置

相关的配置在HMLLDBHelpers.py文件的evaluateExpressionValue函数中能看到。

方法	配置
SetCoerceResultToId	False，因为返回的是SBValue，SBValue可操作性更强
SetFetchDynamicValue	`eNoDynamicValues`(0)，因为返回的是SBValue，本身就可以获取动态类型值，这样设置能保证最大的可操作性
SetUnwindOnError	True，LLDB执行不稳定，有堆栈信息可更好debug
SetIgnoreBreakpoints	True，HMLLDB所有命令都不需要命中断点而中断
SetGenerateDebugInfo	False，不了解，保持默认值
SetTimeoutInMicroSeconds	5000000，即5秒
SetOneThreadTimeoutInMicroSeconds	4900000，即4.9秒。当SetTryAllThreads和SetStopOthers都设为True时，这个方法设置的值最好略小于GetTimeoutInMicroSeconds
SetTryAllThreads	True，不了解，保持默认值
SetStopOthers	True，不了解，看字面意思，设置为True能保证执行时的稳定性
SetTrapExceptions	False，HMLLDB有Traceback机制，此项配置意义不大。如果大部分情况下都是runtime错误，设置为False可让系统自动捕获
SetPlaygroundTransformEnabled	False，意义不明，保持默认
SetREPLMode	False，意义不明，保持默认
SetLanguage	`eLanguageTypeObjC_plus_plus`，OC比Swift稳定，且HMLLDB项目使用了大量的`objc_msgSend`函数，故不选用Swift。选OC++则是为了增加兼容性
SetSuppressPersistentResult	True，表达式结果不需要持久化
SetPrefix	具体内容可以查看HMExpressionPrefix.py文件。根据表达式实际情况，按需配置
SetAutoApplyFixIts	True，HMLLDB是固定的代码，此项配置意义不大，保持默认
SetRetriesWithFixIts	1，HMLLDB是固定的代码，此项配置意义不大，保持默认
SetTopLevel	False，目前功能暂时不需要定义外部函数和外部变量，未来可期
SetAllowJIT	True，大部分功能都是必要的。