我给 iOS 系统打了个补丁——修复 iOS 16 系统键盘重大 Crash（附补丁源码）

下载文末附件的补丁源码内置到 App 即可修正键盘 Crash

‍♀️ 编者按：本文作者是蚂蚁集团客户端工程师巴乐，经过逆向剖析发现了 iOS 16 体系键盘存在重大 Bug，或许导致运用到键盘的业务场景呈现严重 Crash。 在支付宝 App 近期版别 10.5.16.6000 上，巴乐用汇编从头完成了一套 iOS 16 体系键盘 tryLock 办法后，问题得到彻底修正，该版别上的对应 Crash 已降到 0。本文记载了该问题处理的完整进程，包括问题发现、剖析、修正以及验证，欢迎查阅与交流～

布景

在蚂蚁集团内部，支付宝技术部及蚂蚁终端技术委员会联合发起了“技术应战英雄榜”活动，经过张榜一系列技术难题，寻觅那些赋有热情、敢于应战的同学，揭榜解题，攻克顽疾！

在难题榜中，有蚂蚁内部同学张榜反应了 iOS 支付宝 App Top 1 的 iOS 16 键盘 Crash（下文可简称“键盘 Crash“），即下图 1 的 issue 1。该 Crash 量级大且持续时间长，线下欠好复现又欠好排查，对线上业务影响很大，急需攻坚。

本人根据对客户端运转时技术的浓厚兴趣，揭榜领题，应战处理该 Crash。

图 1 蚂蚁内部的技术应战英雄榜

原始信息

Crash 信息

Crash 日志要害信息如下：

Incident Identifier: 7C53A274-4184-4E38-B27E-07B4E1335277
CrashReporter Key:   
Hardware Model:      iPhone13 4
Process:             AlipayWallet [89329]
Path:                /private/var/containers/Bundle/Application/C5F00AEC-B96F-4BF1-8C9C-25B67BCA301E/AlipayWallet.app/AlipayWallet
Identifier:          com.alipay.iphoneclient
Version:             10.5.0 (10.5.0.6000)
Code Type:           ARM-64
Parent Process:      [1]
Date/Time:           2023-08-30 04:37:48 +0000
OS Version:          iPhone OS 16.6 (20G75)
Report Version:      104
Exception Type:  SIGSEGV
Exception Codes: SEGV_MAPERR at 0x2ab3106e0
Crashed Thread:  0
Thread 0 Crashed:
0   libobjc.A.dylib                 0x00000001a5183a7c _objc_retain :16 (in libobjc.A.dylib)
1   UIKitCore                       0x00000001aed4d4d4 -[UIKeyboardTaskQueue performDeferredTaskIfIdle] :32 (in UIKitCore)
2   UIKitCore                       0x00000001ae533148 -[UIKeyboardTaskQueue continueExecutionOnMainThread] :376 (in UIKitCore)
3   Foundation                      0x00000001a63e878c ___NSThreadPerformPerform :264 (in Foundation)
4   CoreFoundation                  0x00000001ac1ca128 ___CFRUNLOOP_IS_CALLING_OUT_TO_A_SOURCE0_PERFORM_FUNCTION__ :28 (in CoreFoundation)
5   CoreFoundation                  0x00000001ac1d67b4 ___CFRunLoopDoSource0 :176 (in CoreFoundation)
6   CoreFoundation                  0x00000001ac15b648 ___CFRunLoopDoSources0 :340 (in CoreFoundation)
7   CoreFoundation                  0x00000001ac1710d4 ___CFRunLoopRun :828 (in CoreFoundation)
8   CoreFoundation                  0x00000001ac1763ec _CFRunLoopRunSpecific :612 (in CoreFoundation)
9   GraphicsServices                0x00000001e768c35c _GSEventRunModal :164 (in GraphicsServices)
10  UIKitCore                       0x00000001ae502f58 -[UIApplication _run] :888 (in UIKitCore)
11  UIKitCore                       0x00000001ae502bbc _UIApplicationMain :340 (in UIKitCore)
12  AlipayWallet                    0x00000001074d539c main main.m:124 (in AlipayWallet)
13  ???                             0x00000001cb6a8dec 0x0000000000000000 + 0
Thread 1:
0   libsystem_kernel.dylib          0x00000001eb0b6ca4 _mach_msg2_trap :8 (in libsystem_kernel.dylib)
...
Thread State:
     x8:0x0000000202aa4820     x9:0x0000000282d64100     lr:0x00000001aed4d548     fp:0x000000016b032700
    x10:0x0000000000000000    x12:0x0000000000ec0e80    x11:0x000000000000001f    x14:0x0100000202aaecc9
    x13:0x0000010000000100    x16:0x0000bb12ab3106c0     sp:0x000000016b0326e0    x15:0x0000000202aaecc8
    x18:0x0000000000000000    x17:0x00000002ab3106c0    x19:0x0000000283463d00   cpsr:0x0000000000001000
     pc:0x00000001a5183a7c    x21:0x0000000000000001    x20:0x0000000000000000     x0:0x0000000286f706c0
    x23:0x0000000114841058     x1:0x0000000000000000    x22:0x000000028312e2c0     x2:0x0000000000000000
    x25:0x0000000000000002     x3:0x00000002041bc480    x24:0x0000000000000000     x4:0x0000000000000000
    x27:0x00000000211200d5     x5:0x0000000000000001    x26:0x0000000000000000     x6:0x00000001b55fb2c5
     x7:0x00000001b55fb2b9    x28:0x0000000000000001
Binary Images:
0x0000000104dcc000 - 0x000000010f6f3fff AlipayWallet arm64  <fa235f8a8e253b4d81e7e6a4fecdd4c6> /private/var/containers/Bundle/Application/C5F00AEC-B96F-4BF1-8C9C-25B67BCA301E/AlipayWallet.app/AlipayWallet
...
0x00000001a5180000 - 0x00000001a51c3f9f libobjc.A.dylib arm64e  <eb7faf215c9f37848907affa6d92bc3b> /usr/lib/libobjc.A.dylib
...
0x00000001ae166000 - 0x00000001af98afff UIKitCore arm64e  <7d57a1d1856f338d97db880c4ec8b02e> /System/Library/PrivateFrameworks/UIKitCore.framework/UIKitCore
...

提取 Crash 要害信息（后续剖析根据该信息）：

摘要信息：iPhone 12 Pro Max（Hardware Mode: iPhone13 4）、iOS 16.6、支付宝App 10.5.0.6000 版别、Crash 直接原因是读内存地址0x2ab3106e0反常（一般读内存报错为SEGV_MAPERR，写内存报错为EXC_BAD_ACCESS）
Crash 要害函数：0x00000001a5183a7c _objc_retain、0x00000001aed4d4d4 -[UIKeyboardTaskQueue performDeferredTaskIfIdle]、0x00000001ae533148 -[UIKeyboardTaskQueue continueExecutionOnMainThread]
Thread State：通用寄存器和浮点寄存器快照，用于检查运转时变量值及更深入的逻辑估测；
Binary Images：各 Image （运转时可履行指令的文件）二进制布局在内存开始方位及结束地址，开始方位可做基准，可用于核算 Crash 时的某指令地址相对于所属 Image 开始地址的偏移。

量级及散布

键盘 Crash 日 PV 一向处于大几百次，持续至少半年多，从操作体系版别散布来看仅在 iOS 16 上呈现（掩盖一切机型）。

图 2 键盘 Crash 日 PV 趋势图

图 3 键盘 Crash 在不同机型及操作体系的量级散布

信息小结

从 Crash 日志栈顶的objc_retain函数要害字和量级散布状况来看，该 Crash 很或许是由 iOS 16 体系键盘控件的内存管理反常导致。

剖析推演

下文剖析推演触及的知识点或技术：

运用软件：Sublime Text、Xcode 及自带的lldb命令，包括b、c、bt、frame select、di、image list、p/x、po、x/1b；
汇编能力：Arm64 寄存器阐明、Arm64 汇编指令集阐明;
脚本工具：otool、自研脚本fetch_class_text_from_all.sh；
要害类：UIKeyboardTaskQueue 键盘中心类、NSConditionLock条件状态锁（具体运用见官方文档）；
依赖模块：蚂蚁自研的DebugKit.framework（后续考虑对外输出）调试模块。

一、看现场，从 Crash 点开始

——核算 Crash 函数的偏移

因 iOS 运转时加载到内存的 Image 的开始地址是动态的（对应 Binary Images 列表中的开始地址），但某指令地址与所属 Image 的开始地址的偏移是固定的，所以可根据该偏移来检查 Crash 时是哪条指令。

0x00000001a5183a7c _objc_retain所属的libobjc.A.dylib的开始地址是0x00000001a5180000，所以相对偏移 = 0x00000001a5183a7c – 0x00000001a5180000 = 0x3a7c
0x00000001aed4d4d4 -[UIKeyboardTaskQueue performDeferredTaskIfIdle]所属的UIKitCore的开始地址是0x00000001ae166000，所以相对偏移 = 0x00000001aed4d4d4 – 0x00000001ae166000 = 0xbe74d4

二、模仿现场，寻觅蛛丝马迹

—— Xcode 设置断点模仿现场

为模仿与 Crash 时一样的现场，需找一台与 Crash 日志中共同的设备，即 iOS 16.6 的iPhone 12 Pro Max（Hardware Mode: iPhone13 4），只要这样在下文中断点时的函数栈以及各函数偏移对应的指令才干与 Crash 日志中的彻底对上。
将找到的设备与 Mac 连接并用 Xcode 启动 App（可用下文附件中 Demo 要害代码调试）。
从上述核算出的要害函数的偏移加上所属 Image 的开始地址，模仿出 Crash 时运转的函数栈，具体操作如下图 4。

图 4 设置断点模仿现场

从图 4 的第 11 步可知 Crash 的直接原因是 objc_retain 的目标野指针了，导致读取内存反常而触发 Crash。

图 5 检查上一层函数栈

从图 5 可知两点：

先后调用联系是-[UIKeyboardTaskQueue performDeferredTaskIfIdle] -> -[UIKeyboardTaskQueue promoteDeferredTaskIfIdle]（该函数在 Crash 函数栈中未呈现，所以只要模仿现场才干发现）-> objc_retain
UIKeyboardTaskQueue类有个NSMutableArray类型的成员变量持有UIKeyboardTaskEntry目标（从图 5 中第 8 步的输出得出），而 Crash 的直接原因便是获取该数组index = 0的UIKeyboardTaskEntry目标后，履行objc_retain该目标 Crash ，所以反常的原因需要从对该数组的读写排查。

小结：UIKeyboardTaskQueue类的NSMutableArray类型的成员变量是要害数组（在实例目标偏移0x20的方位），怀疑是多线程读写该数组导致的。那么该成员变量名是啥，UIKeyboardTaskQueue类又是怎么确保安全运用该数组的呢？

三、全面排查，搜集更多信息

——获取UIKeyboardTaskQueue类的悉数信息

凭借蚂蚁自研的DebugKit.framework调试模块可在运转时导出UIKeyboardTaskQueue类一切的实例办法、类办法、property和ivars成员变量。

图 6 获取 UIKeyboardTaskQueue 类的基础信息

从图 6 可知两点：

UIKeyboardTaskQueue的成员变量_deferredTasks的类型是NSMutableArray（在实例目标开始地址偏移0x20的方位，从图 6 中第 6 点可知）便是上述说到要害数组。野指针一般是有多线程读写目标导致的，对_deferredTasks数组读写时应该是有锁来操控的，该类中类型为NSConditionLock的成员变量_lock（在实例目标偏移0x10的方位，从图 6 中第 5 点可知）与_deferredTasks是啥联系？
发现该类的property列表只要executionContext和activeOriginator，不包括deferredTasks和lock，所以对_deferredTasks和_lock（类的成员变量名一般是在property名前多加前缀“_”）的一切读写全在该类中，不存在其他类直接引证，也便是 Crash 相关的悉数逻辑都在UIKeyboardTaskQueue类中，所以破案的边界也划清楚了，圈定范围。将UIKeyboardTaskQueue类的一切办法的汇编都导出来检查。

图 7 获取 UIKeyboardTaskQueue 类的一切办法完成

图 7 中第 2 步触及的fetch_class_text_from_all.sh见下文附件中脚本源码。小结：经过剖析圈定排查范围在UIKeyboardTaskQueue类内，凭借脚本可一键导出其一切办法的汇编，为进一步研讨_deferredTasks和_lock的联系做基础。

四、理清联系，找到突破口

—— 研讨_deferredTasks和_lock联系

理清以下重要的两个联系：

_deferredTasks视点：UIKeyboardTaskQueue类对_deferredTasks的多线程读写是怎么确保安全的，哪些办法有用到，与_lock又是什么联系？
_lock视点：UIKeyboardTaskQueue类对_lock又是怎么运用的，哪些办法有用到，加锁和解锁是否配对？

deferredTasks 视点

图 7 第 2 步导出的UIKeyboardTaskQueue的一切办法完成都是汇编的，为理清对_deferredTasks目标的一切读写有哪些指令，分别在哪些办法中（UIKeyboardTaskQueue实例目标偏移0x20的方位，该地址下存储的 8 字节地址才是_deferredTasks目标），需要在文件中全文查找正则表达式x.{1,2}, #0x20筛选出一切引证_deferredTasks的指令以及所属办法，操作如下图 8（Sublime Text）。

图 8 全文查找正则表达式的样例

在汇编层面，面向目标言语中办法的第一个入参是self（C++ 称this，Objective-C 称self），存放在x0寄存器上，所以仅筛选出偏移是从办法入参时的x0或x0备份（如mov x19, x0，x19便是备份了x0的值）开始的，终究整理出一切UIKeyboardTaskQueue对_deferredTasks有引证并读写的指令及所属办法，如下。注：

一般面向进程言语的代码块称为函数，而面向目标言语的代码块称为办法，为防止文章的混用形成困扰，这儿特别阐明。
下列部分的“读”或“写”是指获取到_deferredTasks目标后，对该目标是读操作还是写操作。

-[UIKeyboardTaskQueue isEmpty]:
...
0000000189c816a4	ldr	x0, [x19, #0x20]     读
0000000189c816a8	bl	_objc_msgSend$count
...
-[UIKeyboardTaskQueue finishExecution]:
...
00000001894677a8	ldr	x0, [x19, #0x20]     读
00000001894677ac	bl	_objc_msgSend$count
...
-[UIKeyboardTaskQueue promoteDeferredTaskIfIdle]:
...
0000000189c8152c	ldr	x0, [x0, #0x20]      读
0000000189c81530	bl	_objc_msgSend$count
0000000189c81534	cbz	x0, 0x189c81518
0000000189c81538	ldr	x0, [x19, #0x20]     读
0000000189c8153c	mov	x2, #0x0
0000000189c81540	bl	"_objc_msgSend$objectAtIndex:"
0000000189c81544	bl	0x18c9deec0          Crash在这行
...
0000000189c81558	ldr	x0, [x19, #0x20]     写：删除item
0000000189c8155c	mov	x2, #0x0
0000000189c81560	bl	"_objc_msgSend$removeObjectAtIndex:"
...
-[UIKeyboardTaskQueue continueExecutionOnMainThread]:
...
0000000189467130	ldr	x0, [x19, #0x20]     读
0000000189467134	bl	_objc_msgSend$count
...
-[UIKeyboardTaskQueue waitUntilAllTasksAreFinished]:
...
000000018952a810	ldr	x0, [x19, #0x20]     读
000000018952a814	bl	_objc_msgSend$count
...
-[UIKeyboardTaskQueue addDeferredTask:]:
...
0000000189c81640	ldr	x0, [x19, #0x20]     写：增加item
0000000189c81644	ldr	x2, [sp, #0x8]
0000000189c81648	bl	"_objc_msgSend$addObject:"
...
-[UIKeyboardTaskQueue init]:
...
0000000189543024	ldr	x8, [x19, #0x20]     读
0000000189543028	str	x0, [x19, #0x20]     写：创立数组实例
...
-[UIKeyboardTaskQueue .cxx_destruct]:
...
0000000189c817f4	add	x0, x19, #0x20       写：毁掉
0000000189c817f8	mov	x1, #0x0
0000000189c817fc	bl	0x18a1a4c64 ; symbol stub for: _objc_storeStrong
...

读_deferredTasks的办法有 6 个：

-[UIKeyboardTaskQueue isEmpty]
-[UIKeyboardTaskQueue finishExecution]
-[UIKeyboardTaskQueue promoteDeferredTaskIfIdle]
-[UIKeyboardTaskQueue continueExecutionOnMainThread]
-[UIKeyboardTaskQueue waitUntilAllTasksAreFinished]
-[UIKeyboardTaskQueue init]

写_deferredTasks的办法有 4 个：

-[UIKeyboardTaskQueue promoteDeferredTaskIfIdle]
-[UIKeyboardTaskQueue addDeferredTask:]
-[UIKeyboardTaskQueue init]
-[UIKeyboardTaskQueue .cxx_destruct]

_lock 视点

在文件中全文查找正则表达式x.{1,2}, #0x10筛选出一切引证_lock的指令以及所属办法，操作类似上述的_deferredTasks；

从上可知，UIKeyboardTaskQueue类对_lock的运用封装成 4 个办法（疏忽init创立和.cxx_destruct毁掉的两个办法，该两办法不会有并发问题），也便是办法运用_lock必定会调用这 4 个办法。

解锁办法有 1 个：

-[UIKeyboardTaskQueue unlock]

加锁办法有 3 个：

-[UIKeyboardTaskQueue lock]
-[UIKeyboardTaskQueue lockWhenReadyForMainThread]
-[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]

串联联系，发现 Bug

串联上述_deferredTasks和_lock两个视点的办法调用（疏忽init创立和.cxx_destruct毁掉的两个办法），从原汇编的要害办法中列出简版的联系描述，如下图 9。

图 9 串联 _deferredTasks 和 _lock 的联系

为便利理清锁的对应联系，图 9 顶用赤色表示加锁，绿色表示解锁，从中可知：

对_deferredTasks的要害读写的办法内是有 1 个加锁和 1 个解锁对应的，预期是多线程下保护读写的安全性；
即便不读写_deferredTasks的办法内上也是有 1 个加锁和 1 个解锁对应的，用于多线程下保护其他成员变量的读写安全性；
发现问题，有 Bug：-[UIKeyboardTaskQueue continueExecutionOnMainThread]办法内的0000000189466ff8 bl _objc_msgSend$tryLockWhenReadyForMainThread这行指令履行是回来BOOL类型的，即加锁成功为YES，加锁失利为NO。（参看图 6 中-[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]的办法签名为typeEncoding=B16@0:8，即回来为BOOL类型）；如该行指令尝试加锁但失利了，不会直接return，还会持续履行赤色框内的指令并做解锁操作，会导致多线程下UIKeyboardTaskQueue类的加锁和解锁的功能不配对，也就存在锁失效的状况。

小结：-[UIKeyboardTaskQueue continueExecutionOnMainThread]办法内有 Bug，导致存在锁失效的状况，猜测在多线程下并发读写_deferredTasks时就会偶现 Crash。

五、从头推演，确定根因

推演图

图 10 从头推演键盘 Crash 进程

按时间轴从头推演 Crash 进程：

T0：Thread A加锁成功后履行指令bl _objc_msgSend$addObject:增加目标A到数组_deferredTasks。一起，因为Main Thread履行指令bl _objc_msgSend$tryLockWhenReadyForMainThread失利后持续履行指令bl _objc_msgSend$unlock，使得Thread B也加锁成功后履行指令bl _objc_msgSend$addObject:增加目标B到数组_deferredTasks，导致呈现多线程一起写入数组_deferredTasks的反常状况。
T1：Thread A解锁后，Main Thread在-[UIKeyboardTaskQueue performDeferredTaskIfIdle]办法内加锁成功后，在-[UIKeyboardTaskQueue promoteDeferredTaskIfIdle]办法内履行指令bl _objc_msgSend$objectAtIndex:后获取数组inde = 0的目标地址时，因多线程写入导致该目标地址被反常破坏而呈现野指针（野指针存入x0寄存器）。
T2：Main Thread持续履行下一条指令bl _objc_claimAutoreleasedReturnValue会直接触发了_objc_retain并透传x0寄存器的值，终究在该函数内履行指令ldr x17, [x17, #0x20]时 Crash 了。

注：不同言语的编译器对应的符号名的生成规则是不同的，C 言语只是在原函数名前加一个前缀“_”，如objc_retain(A)，编译后符号名是_objc_retain，而 C++ 言语会根据办法名加上参数名生成的符号名，如__ZNSt3__16vectorIdNS_9allocatorIdEEEixB6v15006Em。

模仿 Crash

按推演的逻辑用本地 Xcode 从头起个 Demo 验证下（可用下文附件中 Demo 要害代码），经过调用[self test_crash]可模仿出 tryLock 失利时导致的 Crash（如调用[self test_ok]就不会呈现 Crash），现场如下。

图 11 模仿 tryLock 加锁失利而导致的 Crash

从 Xcode 的 Console 操控台的日志中能够看到呈现多线程并发增加到_deferredTasks数组的状况，在后续removeEntry_crash办法内呈现了objc_retain野指针目标导致的 Crash，与上述推演的逻辑相符。

比照不同 iOS 版别

图 12 比照不同 iOS 版别的完成

经过比照发现仅 iOS 16 上有问题，iOS 15 或 iOS 17 上 tryLock 失利后都会立即return的，也便是为什么 Crash 仅呈现在 iOS 16 的原因。从中咱们能够看出在 iOS 17 上苹果技术同学也发现了该 Bug 并做了修正。

给苹果反应 Bug

该问题已提交至苹果“反应助理”（图 13），但到目前未得到其官方的 iOS 16 上的处理计划。

图 13 “反应助理”截图

六、总结根因

经过上述剖析推演，iOS 16 键盘 Crash 根因已查明，即-[UIKeyboardTaskQueue continueExecutionOnMainThread]办法内履行-[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]尝试加锁失利后，不return持续向下履行读写不安全内存以及解锁，导致存在锁失效的状况，使得UIKeyboardTaskQueue成员变量_deferredTasks数组在多线程下呈现并发增加UIKeyboardTaskEntry实例而引起野指针，导致终究 Crash。

注：该根因除了导致数组读写反常而 Crash，也或许导致其他变量的状态不共同性，只是不一定表现为 Crash 而已，建议用本文计划修正。

处理计划（App 内置补丁源码）

清晰根因后，处理计划就比较清晰了，写一个 App 内置补丁代码使得-[UIKeyboardTaskQueue continueExecutionOnMainThread]办法内履行-[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]尝试加锁失利后，正常return即可。补丁计划有两个：

重写-[UIKeyboardTaskQueue continueExecutionOnMainThread]办法。在原汇编基础上新增一条指令，即在bl _objc_msgSend$tryLockWhenReadyForMainThread后增加一条汇编指令cbz w0, return_label（return_label对应源码return对应的汇编指令地址），如失利则return。但该计划触及的原汇编指令较多，有 95 条汇编指令（见下文附件中 iOS 体系汇编），容易踩坑。
重写-[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]办法。在该办法内如加锁失利则模仿两次return，回到-[UIKeyboardTaskQueue continueExecutionOnMainThread]的上一个函数栈，改造的汇编指令较少，安全性较好，也确认了除-[UIKeyboardTaskQueue continueExecutionOnMainThread]调用外，无其他办法调用-[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]。

终究，支付宝 App 根据稳定性的考虑，采用第 2 种补丁计划修正键盘 Crash。

补丁原理

图 14 修正键盘 Crash 的补丁原理

在-[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]完成以下逻辑：

如加锁成功，则return 1 次，回来到-[UIKeyboardTaskQueue continueExecutionOnMainThread]办法的下一条指令持续履行；
如加锁失利，则模仿return 2 次，回来到-[UIKeyboardTaskQueue continueExecutionOnMainThread]的函数栈的上一层函数的地址持续履行，也便是模仿了从-[UIKeyboardTaskQueue continueExecutionOnMainThread]中履行return操作。

源码return句子，对应汇编的 4 步：

康复fp和lr寄存器。fp（也称x29）记载当时帧的内存地址，lr（也称x30）记载从当时函数回来时跳转到哪个地址持续履行。运转时便是经过fp和lr寄存器，输出线程的函数栈的。如 Crash 函数栈，或从lldb的bt输出的函数栈；
康复callee-saved寄存器。即x19-x28的寄存器，try-catch的完成就触及该类寄存器，一般按需履行；
康复sp寄存器。sp记载当时帧的栈顶地址，，当时函数的局部变量所在的内存地址就在(fp, sp]之间；
履行ret指令。履行ret指令后，pc就指向lr寄存器的值，然后持续履行；

本文补丁计划的原理中，tryLock 失利时便是经过：康复fp和lr寄存器 + 康复callee-saved寄存器 + 康复sp寄存器 + 再次康复fp和lr寄存器 + 再次康复callee-saved寄存器 + 再次康复sp寄存器 + ret指令来模仿在-[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]办法内return 2 次直接回来到-[UIKeyboardTaskQueue continueExecutionOnMainThread]的函数栈的上一层函数的。

补丁完成

有两部分组成：

重写办法：对应 fix_UIKeyboardTaskQueue.S 文件；
Hook 进口：对应 fix_UIKeyboardTaskQueue.m 文件；

重写办法

重写-[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]办法完成，对应下文附件中补丁源码的 fix_UIKeyboardTaskQueue.S 文件。

图 15 重写 -[UIKeyboardTaskQueue tryLockWhenReadyForMainThread] 办法完成

Hook 进口

凭借+ (void)load办法在 App 启动时履行的特色完成对-[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]办法的 Hook，仅在 iOS 16 的 Arm64 架构上收效，对应下文附件中补丁源码的 fix_UIKeyboardTaskQueue.m 文件。

图 16 Hook 进口的代码

计划作用

于 2023.8.25 在支付宝 App 近期版别 10.5.16.6000 上全量开启处理计划的开关后，该版别上的 Crash 日 PV 现已降到 0 了。

图 17 支付宝 App 近期版别 10.5.16.6000 上键盘 Crash 日 PV

一起，支付宝 App 的全量版别（包括一切历史版别）的键盘 Crash 日 PV 下降了近 90%，随着更多用户升级到支付宝 App 最新版别，预计会降到个位数。

图 18 计划上线后键盘 Crash 日 PV 明显下降的趋势图

终究该计划由验收人确认有用，键盘 Crash 已处理，揭榜应战成功，附上一张应战成功喜讯图收个尾。

图 19 蚂蚁内部的技术英雄榜喜讯

附件

1、补丁源码

补丁源码包括两部分：fix_UIKeyboardTaskQueue.S 和 fix_UIKeyboardTaskQueue.m。运用时将该两文件直接内置在 App 中即可，也可在 App 启动时加开关操控 Hook 进口的时机。

#ifdef __arm64__
//
//  fix_UIKeyboardTaskQueue.S
//  fix_UIKeyboardTaskQueue
//
//  Created by Alipay on 2023/8/10.
//  Copyright  2023 Alipay. All rights reserved.
//
/**
 原完成
 -[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]:
    ldr    x0, [x0, #0x10]
    mov    x2, #0x0
    b    "_objc_msgSend$tryLockWhenCondition:"
 */
// 重写完成
.section    __TEXT,__cstring,cstring_literals
tryLockWhenCondition.str:
.asciz      "tryLockWhenCondition:"
.text
.align 4
.global _fix_UIKeyboardTaskQueue_tryLockWhenReadyForMainThread
.cfi_startproc
_fix_UIKeyboardTaskQueue_tryLockWhenReadyForMainThread:
stp    x20, x19, [sp, #-0x20]!
stp    x29, x30, [sp, #0x10]
add    x29, sp, #0x10
mov    x19, x0                     ; self
adrp   x0, tryLockWhenCondition.str@PAGE
add    x0, x0, tryLockWhenCondition.str@PAGEOFF
bl     _sel_registerName           ; @selector(tryLockWhenCondition:)
mov    x1, x0
ldr    x0, [x19, #0x10]            ; _lock
mov    x2, #0x0
bl     _objc_msgSend               ; -[_lock tryLockWhenCondition:0]
ldp    x29, x30, [sp, #0x10]       ; 康复fp和lr
ldp    x20, x19, [sp], #0x20       ; 康复callee-saved寄存器、并康复sp
cbz    x0, 1f
// 如tryLock成功，则持续履行-[UIKeyboardTaskQueue continueExecutionOnMainThread]的指令
ret
// 如tryLock失利，则模仿从-[UIKeyboardTaskQueue continueExecutionOnMainThread] return，不再持续履行
1:
ldp    x29, x30, [sp, #0x20]       ; 康复fp和lr
ldp    x20, x19, [sp, #0x10]       ; 康复callee-saved寄存器
add    sp, sp, #0x30               ; 康复sp
autibsp                            ; Authenticate Instruction address
ret
.cfi_endproc
#endif

//
//  fix_UIKeyboardTaskQueue.m
//  fix_UIKeyboardTaskQueue
//
//  Created by Alipay on 2023/9/4.
//
#ifdef __arm64__
#import <UIKit/UIKit.h>
#include <objc/runtime.h>
@interface fix_UIKeyboardTaskQueue : NSObject
@end
@implementation fix_UIKeyboardTaskQueue
+ (void)load {
    extern BOOL fix_UIKeyboardTaskQueue_tryLockWhenReadyForMainThread(id self, SEL selector);
    if (@available(iOS 16.0, *)) {
        NSString *systemVersion = [[UIDevice currentDevice] systemVersion];
        NSArray *verInfos = [systemVersion componentsSeparatedByString:@"."];
        NSUInteger count = [verInfos count];
        if (count >= 2) {
            if ([verInfos[0] isEqualToString:@"16"]) {
                class_replaceMethod(objc_getClass("UIKeyboardTaskQueue"), sel_getUid("tryLockWhenReadyForMainThread"), (IMP)fix_UIKeyboardTaskQueue_tryLockWhenReadyForMainThread, "B16@0:8");
            }
        }
    }
}
@end
#endif

2、Demo 要害源码

//
//  ViewController.m
//  UIKeyboardTaskQueueDemo
//
//  Created by Alipay on 2023/8/30.
//
#import "ViewController.h"
#include <objc/runtime.h>
// #import <DebugKit/DebugKit.h>
@interface ViewController ()
@end
@implementation ViewController {
    NSMutableArray *_tasks;
    NSMutableArray *_deferredTasks;
    NSConditionLock *_lock;
}
- (void)viewDidLoad {
    [super viewDidLoad];
    // 输出UIKeyboardTaskQueue的一切实例办法和类办法
    // dk_print_all_methods_of_class("UIKeyboardTaskQueue");
    // 输出UIKeyboardTaskQueue的一切property
    // dk_print_all_properties("UIKeyboardTaskQueue");
    // 输出UIKeyboardTaskQueue的一切ivars
    // dk_print_class_all_ivars("UIKeyboardTaskQueue");
    UITextView *textView = [[UITextView alloc] initWithFrame:self.view.bounds];
    [self.view addSubview:textView];
    [self test_crash];
    [self test_ok];
}
- (void)unlock {
    [_lock unlockWithCondition:0];
}
- (void)lock {
    [_lock lock];
}
- (BOOL)tryLock {
    return [_lock tryLockWhenCondition:0];
}
- (void)addEntry_ok {
    [self lock];
    [_deferredTasks addObject:[[NSObject alloc] init]];
    NSLog(@"add,    %lu", _deferredTasks.count);
    [self unlock];
}
- (void)removeEntry_crash {
    [self tryLock];
    if (_deferredTasks.count) {
        [_tasks addObject:[_deferredTasks objectAtIndex:0]];
        if (_deferredTasks.count) {
            [_deferredTasks removeObjectAtIndex:0];
            NSLog(@"remove, %lu", _deferredTasks.count);
//            NSLog(@"%@, %lu -[_deferredTasks removeObjectAtIndex:0]", [NSThread currentThread], _deferredTasks.count);
        }
    }
    [self unlock];
}
- (void)removeEntry_ok {
    if (![self tryLock]) return;
    if (_deferredTasks.count) {
        [_tasks addObject:[_deferredTasks objectAtIndex:0]];
        if (_deferredTasks.count) {
            [_deferredTasks removeObjectAtIndex:0];
            NSLog(@"remove, %lu", _deferredTasks.count);
//            NSLog(@"%@, %lu -[_deferredTasks removeObjectAtIndex:0]", [NSThread currentThread], _deferredTasks.count);
        }
    }
    [self unlock];
}
- (void)test_crash {
    // init
    _tasks = [NSMutableArray array];
    _deferredTasks = [NSMutableArray array];
    _lock = [[NSConditionLock alloc] initWithCondition:0];
    for (int i = 0; i < 10000; i++) {
        dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^{
            [self addEntry_ok];
        });
        dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^{
//            dispatch_async(dispatch_get_main_queue(), ^{
                [self removeEntry_crash];
//            });
        });
    }
}
- (void)test_ok {
    // init
    _tasks = [NSMutableArray array];
    _deferredTasks = [NSMutableArray array];
    _lock = [[NSConditionLock alloc] initWithCondition:0];
    for (int i = 0; i < 1000; i++) {
        dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^{
            [self addEntry_ok];
        });
        dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^{
            [self removeEntry_ok];
        });
    }
}
@end

3、脚本源码

#!/bin/sh
# File
TEXT_FILE="$1";
# Class
CLASS_NAME="$2"; 
cat "$TEXT_FILE" | tr '\n' '&' | sed 's/&\-\[/\n\-\[/g'|grep "^\-\[$CLASS_NAME " | tr '&' '\n';

4、iOS 体系汇编（要害办法）

将 iOS 16.6 的 iPhone 12 Pro Max（Hardware Mode: iPhone13 4）设备连接到 Xcode 后，按如下操作可获取到 UIKeyboardTaskQueue 类的完成汇编，即UIKitCore_20G75_arm64e_TEXT.txt 文件。

otool -s __TEXT __text -v ~/Library/Developer/Xcode/iOS\ DeviceSupport/16.6\ \(20G75\)\ arm64e/Symbols/System/Library/PrivateFrameworks/UIKitCore.framework/UIKitCore > ~/Desktop/UIKitCore_20G75_arm64e_TEXT.txt
./fetch_class_text_from_all.sh ~/Desktop/UIKitCore_20G75_arm64e_TEXT.txt UIKeyboardTaskQueue > ~/Desktop/UIKeyboardTaskQueue_20G75_arm64e_TEXT.txt

-[UIKeyboardTaskQueue continueExecutionOnMainThread]:
0000000189466fd0	pacibsp
0000000189466fd4	sub	sp, sp, #0x30
0000000189466fd8	stp	x20, x19, [sp, #0x10]
0000000189466fdc	stp	x29, x30, [sp, #0x20]
0000000189466fe0	add	x29, sp, #0x20
0000000189466fe4	mov	x19, x0
0000000189466fe8	bl	0x18c9df5e0
0000000189466fec	cmp	w0, #0x1
0000000189466ff0	b.ne	0x189467024
0000000189466ff4	mov	x0, x19
0000000189466ff8	bl	_objc_msgSend$tryLockWhenReadyForMainThread
0000000189466ffc	ldr	x8, [x19, #0x28]
0000000189467000	cbz	x8, 0x189467058
0000000189467004	ldr	x8, [x19, #0x30]
0000000189467008	cbz	x8, 0x1894670b4
000000018946700c	bl	0x18c9df2f0
0000000189467010	str	x0, [sp, #0x8]
0000000189467014	ldr	x8, [x19, #0x30]
0000000189467018	str	xzr, [x19, #0x30]
000000018946701c	bl	0x18c9df150
0000000189467020	b	0x1894670ac
0000000189467024	adrp	x8, -26465 ; 0x182d06000
0000000189467028	add	x2, x8, #0xe19
000000018946702c	mov	x0, x19
0000000189467030	mov	x3, #0x0
0000000189467034	mov	w4, #0x0
0000000189467038	ldp	x29, x30, [sp, #0x20]
000000018946703c	ldp	x20, x19, [sp, #0x10]
0000000189467040	add	sp, sp, #0x30
0000000189467044	autibsp
0000000189467048	eor	x16, x30, x30, lsl #1
000000018946704c	tbz	x16, #0x3e, 0x189467054
0000000189467050	brk	#0xc471
0000000189467054	b	"_objc_msgSend$performSelectorOnMainThread:withObject:waitUntilDone:"
0000000189467058	ldr	x0, [x19, #0x18]
000000018946705c	bl	_objc_msgSend$count
0000000189467060	cbz	x0, 0x1894670b8
0000000189467064	adrp	x8, 333019 ; 0x1da942000
0000000189467068	ldr	x0, [x8, #0x500]
000000018946706c	bl	0x18c9dee30
0000000189467070	mov	x2, x19
0000000189467074	bl	"_objc_msgSend$initWithExecutionQueue:"
0000000189467078	mov	x20, x0
000000018946707c	mov	x0, x19
0000000189467080	mov	x2, x20
0000000189467084	bl	"_objc_msgSend$setExecutionContext:"
0000000189467088	bl	0x18c9df0a0
000000018946708c	ldr	x0, [x19, #0x18]
0000000189467090	mov	x2, #0x0
0000000189467094	bl	"_objc_msgSend$objectAtIndex:"
0000000189467098	bl	0x18c9deec0
000000018946709c	str	x0, [sp, #0x8]
00000001894670a0	ldr	x0, [x19, #0x18]
00000001894670a4	mov	x2, #0x0
00000001894670a8	bl	"_objc_msgSend$removeObjectAtIndex:"
00000001894670ac	ldr	x0, [sp, #0x8]
00000001894670b0	b	0x1894670b8
00000001894670b4	mov	x0, #0x0
00000001894670b8	str	x0, [sp, #0x8]
00000001894670bc	bl	_objc_msgSend$originatingStack
00000001894670c0	bl	0x18c9deec0
00000001894670c4	mov	x20, x0
00000001894670c8	mov	x0, x19
00000001894670cc	mov	x2, x20
00000001894670d0	bl	"_objc_msgSend$setActiveOriginator:"
00000001894670d4	bl	0x18c9df0a0
00000001894670d8	mov	x0, x19
00000001894670dc	bl	_objc_msgSend$unlock
00000001894670e0	ldr	x1, [sp, #0x8]
00000001894670e4	ldrb	w20, [x19, #0x8]
00000001894670e8	mov	w8, #0x1
00000001894670ec	strb	w8, [x19, #0x8]
00000001894670f0	ldr	x2, [x19, #0x28]
00000001894670f4	cbz	x1, 0x189467108
00000001894670f8	mov	x0, x1
00000001894670fc	bl	"_objc_msgSend$execute:"
0000000189467100	ldr	x1, [sp, #0x8]
0000000189467104	b	0x18946710c
0000000189467108	cbz	x2, 0x189467130
000000018946710c	strb	w20, [x19, #0x8]
0000000189467110	ldp	x29, x30, [sp, #0x20]
0000000189467114	ldp	x20, x19, [sp, #0x10]
0000000189467118	add	sp, sp, #0x30
000000018946711c	autibsp
0000000189467120	eor	x16, x30, x30, lsl #1
0000000189467124	tbz	x16, #0x3e, 0x18946712c
0000000189467128	brk	#0xc471
000000018946712c	b	0x18c9df060
0000000189467130	ldr	x0, [x19, #0x20]
0000000189467134	bl	_objc_msgSend$count
0000000189467138	ldr	x1, [sp, #0x8]
000000018946713c	cbz	x0, 0x18946710c
0000000189467140	mov	x0, x19
0000000189467144	bl	_objc_msgSend$performDeferredTaskIfIdle
0000000189467148	b	0x189467100
-[UIKeyboardTaskQueue tryLockWhenReadyForMainThread]:
0000000189467738	ldr	x0, [x0, #0x10]
000000018946773c	mov	x2, #0x0
0000000189467740	b	"_objc_msgSend$tryLockWhenCondition:"
-[UIKeyboardTaskQueue performDeferredTaskIfIdle]:
0000000189c814b4	pacibsp
0000000189c814b8	stp	x20, x19, [sp, #-0x20]!
0000000189c814bc	stp	x29, x30, [sp, #0x10]
0000000189c814c0	add	x29, sp, #0x10
0000000189c814c4	mov	x19, x0
0000000189c814c8	bl	_objc_msgSend$lock
0000000189c814cc	mov	x0, x19
0000000189c814d0	bl	_objc_msgSend$promoteDeferredTaskIfIdle
0000000189c814d4	mov	x0, x19
0000000189c814d8	bl	_objc_msgSend$unlock
0000000189c814dc	mov	x0, x19
0000000189c814e0	ldp	x29, x30, [sp, #0x10]
0000000189c814e4	ldp	x20, x19, [sp], #0x20
0000000189c814e8	autibsp
0000000189c814ec	eor	x16, x30, x30, lsl #1
0000000189c814f0	tbz	x16, #0x3e, 0x189c814f8
0000000189c814f4	brk	#0xc471
0000000189c814f8	b	_objc_msgSend$continueExecutionOnMainThread
-[UIKeyboardTaskQueue promoteDeferredTaskIfIdle]:
0000000189c814fc	pacibsp
0000000189c81500	sub	sp, sp, #0x30
0000000189c81504	stp	x20, x19, [sp, #0x10]
0000000189c81508	stp	x29, x30, [sp, #0x20]
0000000189c8150c	add	x29, sp, #0x20
0000000189c81510	ldr	x8, [x0, #0x28]
0000000189c81514	cbz	x8, 0x189c81528
0000000189c81518	ldp	x29, x30, [sp, #0x20]
0000000189c8151c	ldp	x20, x19, [sp, #0x10]
0000000189c81520	add	sp, sp, #0x30
0000000189c81524	retab
0000000189c81528	mov	x19, x0
0000000189c8152c	ldr	x0, [x0, #0x20]
0000000189c81530	bl	_objc_msgSend$count
0000000189c81534	cbz	x0, 0x189c81518
0000000189c81538	ldr	x0, [x19, #0x20]
0000000189c8153c	mov	x2, #0x0
0000000189c81540	bl	"_objc_msgSend$objectAtIndex:"
0000000189c81544	bl	0x18c9deec0
0000000189c81548	mov	x2, x0
0000000189c8154c	str	x0, [sp, #0x8]
0000000189c81550	ldr	x0, [x19, #0x18]
0000000189c81554	bl	"_objc_msgSend$addObject:"
0000000189c81558	ldr	x0, [x19, #0x20]
0000000189c8155c	mov	x2, #0x0
0000000189c81560	bl	"_objc_msgSend$removeObjectAtIndex:"
0000000189c81564	ldr	x0, [sp, #0x8]
0000000189c81568	ldp	x29, x30, [sp, #0x20]
0000000189c8156c	ldp	x20, x19, [sp, #0x10]
0000000189c81570	add	sp, sp, #0x30
0000000189c81574	autibsp
0000000189c81578	eor	x16, x30, x30, lsl #1
0000000189c8157c	tbz	x16, #0x3e, 0x189c81584
0000000189c81580	brk	#0xc471
0000000189c81584	b	0x18c9df050
-[UIKeyboardTaskQueue addDeferredTask:]:
0000000189c815fc	pacibsp
0000000189c81600	sub	sp, sp, #0x30
0000000189c81604	stp	x20, x19, [sp, #0x10]
0000000189c81608	stp	x29, x30, [sp, #0x20]
0000000189c8160c	add	x29, sp, #0x20
0000000189c81610	mov	x19, x0
0000000189c81614	bl	0x18c9df200
0000000189c81618	mov	x20, x0
0000000189c8161c	mov	x0, x19
0000000189c81620	bl	_objc_msgSend$lock
0000000189c81624	adrp	x8, 330945 ; 0x1da942000
0000000189c81628	ldr	x0, [x8, #0x510]
0000000189c8162c	bl	0x18c9dee30
0000000189c81630	mov	x2, x20
0000000189c81634	bl	"_objc_msgSend$initWithTask:"
0000000189c81638	str	x0, [sp, #0x8]
0000000189c8163c	bl	0x18c9df0a0
0000000189c81640	ldr	x0, [x19, #0x20]
0000000189c81644	ldr	x2, [sp, #0x8]
0000000189c81648	bl	"_objc_msgSend$addObject:"
0000000189c8164c	mov	x0, x19
0000000189c81650	bl	_objc_msgSend$unlock
0000000189c81654	mov	x0, x19
0000000189c81658	bl	_objc_msgSend$continueExecutionOnMainThread
0000000189c8165c	ldr	x0, [sp, #0x8]
0000000189c81660	ldp	x29, x30, [sp, #0x20]
0000000189c81664	ldp	x20, x19, [sp, #0x10]
0000000189c81668	add	sp, sp, #0x30
0000000189c8166c	autibsp
0000000189c81670	eor	x16, x30, x30, lsl #1
0000000189c81674	tbz	x16, #0x3e, 0x189c8167c
0000000189c81678	brk	#0xc471
0000000189c8167c	b	0x18c9df050

我给 iOS 系统打了个补丁——修复 iOS 16 系统键盘重大 Crash（附补丁源码）