OC底层原理14-2:objc_msgSend方法列表查找(快速查找)汇编分析

张建 lol

前言

上一章我们了解了 objc_msgSend消息发送慢速查找流程缓存CacheLookup查找

这一章我们来学习 objc_msgSend消息发送慢速查找流程MethodTableLookup(即查询方法列表)

方法列表查找汇编分析

缓存CacheLookup查找 过程中,如果没有找到方法实现,无论是走到 CheckMiss 还是 JumpMiss,最终都会走到 __objc_msgSend_uncached 汇编函数

  • objc-msg-ram64.s 文件中查找 __objc_msgSend_uncached 的汇编实现,其中的核心是 MethodTableLookup(即查询方法列表) ,其源码如下:

__objc_msgSend_uncached源码

1
2
3
4
5
6
7
8
9
10
11
STATIC_ENTRY __objc_msgSend_uncached
UNWIND __objc_msgSend_uncached, FrameWithNoSaves

// THIS IS NOT A CALLABLE C FUNCTION
// Out-of-band p16 is the class to search

// 开始查询方法列表
MethodTableLookup
TailCallFunctionPointer x17

END_ENTRY __objc_msgSend_uncached
  • 搜索 MethodTableLookup 的汇编实现,其中的核心是 _lookUpImpOrForward,汇编源码实现如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
.macro MethodTableLookup

// push frame
SignLR
stp fp, lr, [sp, #-16]!
mov fp, sp

// save parameter registers: x0..x8, q0..q7
sub sp, sp, #(10*8 + 8*16)
stp q0, q1, [sp, #(0*16)]
stp q2, q3, [sp, #(2*16)]
stp q4, q5, [sp, #(4*16)]
stp q6, q7, [sp, #(6*16)]
stp x0, x1, [sp, #(8*16+0*8)]
stp x2, x3, [sp, #(8*16+2*8)]
stp x4, x5, [sp, #(8*16+4*8)]
stp x6, x7, [sp, #(8*16+6*8)]
str x8, [sp, #(8*16+8*8)]

// lookUpImpOrForward(obj, sel, cls, LOOKUP_INITIALIZE | LOOKUP_RESOLVER)
// receiver and selector already in x0 and x1
mov x2, x16
mov x3, #3
bl _lookUpImpOrForward // 核心源码

// IMP in x0
mov x17, x0

// restore registers and return
ldp q0, q1, [sp, #(0*16)]
ldp q2, q3, [sp, #(2*16)]
ldp q4, q5, [sp, #(4*16)]
ldp q6, q7, [sp, #(6*16)]
ldp x0, x1, [sp, #(8*16+0*8)]
ldp x2, x3, [sp, #(8*16+2*8)]
ldp x4, x5, [sp, #(8*16+4*8)]
ldp x6, x7, [sp, #(8*16+6*8)]
ldr x8, [sp, #(8*16+8*8)]

mov sp, fp
ldp fp, lr, [sp], #16
AuthenticateLR

.endmacro

由汇编源码可知,最终跳转到 bl _lookUpImpOrForward

验证

上述汇编的过程,可以通过 汇编调式来验证

  • main 中,例如 [person sayNB] 对象方法调用处加一个断点,并且开启汇编调试 Debug -> Debug workflow -> 勾选 Always show Disassembly,运行程序

  • 汇编中 objc_msgSend 加一个断点,执行断住,按住 control + stepinto,进入 objc_msgSend 的汇编

  • _objc_msgSend_uncached 加一个断点,执行断住,按住 control + stepinto,进入汇编

从上面可以看出最后走到的就是 lookUpImpOrForward ,此时并不是汇编实现

1
2
3
注:
1、C/C++中调用汇编,去查找汇编时,C/C++调用的方法需要 `多加一个下划线`
2、汇编中调用C/C++方法时,去查找C/C++方法,需要将汇编调用的 `方法去掉一个下划线`

MethodTableLookup(即查询方法列表)慢速查找 C/C++ 部分

  • 根据汇编部分的提示全局搜索 lookUpImpOrForward,最后在 objc-runtime-new.mm 文件中找到了源码实现,这是一个 c实现的函数
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
IMP lookUpImpOrForward(id inst, SEL sel, Class cls, int behavior)
{
// 定义的消息转发
const IMP forward_imp = (IMP)_objc_msgForward_impcache;
IMP imp = nil;
Class curClass;

runtimeLock.assertUnlocked();

/*
快速查找,如果找到则直接返回imp
目的:防止多线程操作时,刚好调用函数,此时缓存进来了
*/
if (fastpath(behavior & LOOKUP_CACHE)) {
imp = cache_getImp(cls, sel);
if (imp) goto done_nolock;
}

// 加锁,目的是保证读取的线程安全
runtimeLock.lock();

// 判断是否是一个已知的类:判断当前类是否已经被认可的类,即已经加载的类
checkIsKnownClass(cls);

// 判断类是否实现,如果没有,需要先实现,此时的目的是为了确保父类链,方法后续的循环
if (slowpath(!cls->isRealized())) {
cls = realizeClassMaybeSwiftAndLeaveLocked(cls, runtimeLock);
}

// 判断类是否初始化,如果没有,需要先初始化
if (slowpath((behavior & LOOKUP_INITIALIZE) && !cls->isInitialized())) {
cls = initializeAndLeaveLocked(cls, inst, runtimeLock);
}

runtimeLock.assertLocked();
curClass = cls;

/*
查找类的缓存
unreasonableClassCount 表示类的迭代上限
猜测这里递归的原因是attempts在第一次循环时做了减一操作,然后再次循环时
仍在上限范围内,所以可以继续递归
*/
for (unsigned attempts = unreasonableClassCount();;) {
// 当前类方法列表(采用二分查找算法),如果找到,则返回,将方法缓存到cache中
Method meth = getMethodNoSuper_nolock(curClass, sel);
if (meth) {
imp = meth->imp;
goto done;
}
// 当前类 = 当前类的父类,并判断父类是否为nil
if (slowpath((curClass = curClass->superclass) == nil)) {
// 未找到方法实现,方法解析器也不行,使用转发
imp = forward_imp;
break;
}

// 如果父类链中存在循环,则停止
if (slowpath(--attempts == 0)) {
_objc_fatal("Memory corruption in class list.");
}

// 父类缓存
imp = cache_getImp(curClass, sel);
if (slowpath(imp == forward_imp)) {
// 如果在父类中找到了forward,则停止查找,且不缓存,首先调用此类的方法解析器
break;
}
if (fastpath(imp)) {
// 如果在父类中,找到了此方法,将其存储到cache中
goto done;
}
}

// 如果没找到方法,尝试一次方法解析
if (slowpath(behavior & LOOKUP_RESOLVER)) {
// 动态方法决议的控制条件,便是流程只走一次
behavior ^= LOOKUP_RESOLVER;
return resolveMethod_locked(inst, sel, cls, behavior);
}

done:
// 存储到缓存
log_and_fill_cache(cls, imp, sel, inst, curClass);
// 解锁
runtimeLock.unlock();
done_nolock:
if (slowpath((behavior & LOOKUP_NIL) && imp == forward_imp)) {
return nil;
}
return imp;
}

其整体的慢速查找流程如下图:

主要有以下几步:

  • 【第一步】cache 缓存中进行查找,即 快速查找,找到则直接返回 imp,反之,则进入【第二步】

  • 【第二步】判断 cls

    • 是否是 已知类,如果不是,则 报错

    • 类是否 实现,如果没有,则需要先实现,确定其父类链,此时实例化的目的是为了确定父类链、ro、以及rw等,方法后续数据的读取以及查找的循环

    • 是否 初始化,如果没有,则初始化

  • 【第三步】for 循环,按照 类继承链或者元类继承链 的顺序查找

    • 当前的 cls 的方法列表中使用 二分查找算法 查找方法,如果找到,则 进入cache写入流程在OC底层原理13:cache_t底层原理分析 文章中已经详述过),并 返回imp,如果 没有找到,则返回 nil

    • 当前cls 被赋值为 父类,如果父类 等于nil,则 imp = 消息转发,并终止递归,进入【第四步】

    • 如果 父类链 中存在循环,则报错,终止循环

    • 父类缓存 中查找方法

      • 如果 未找到,则直接返回 nil,继续 循环查找

      • 如果 找到,则直接 返回imp,执行 cache写入流程

    • 【第四步】判断 是否执行过 动态方法解析

      • 如果 没有,执行 动态方法解析

      • 如果 执行过 一次动态方法解析,则走到 消息转发流程

    以上就是方法的 慢速查找流程,下面在分别详细解释 二分查找原理,以及 父类缓存查找

    详细步骤

getMethodNoSuper_nolock 方法:二分查找方法流程

查找方法列表流程:

二分查找 核心的源码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
ALWAYS_INLINE static method_t *
findMethodInSortedMethodList(SEL key, const method_list_t *list)
{
ASSERT(list);

const method_t * const first = &list->first;
const method_t *base = first;
const method_t *probe;
uintptr_t keyValue = (uintptr_t)key; // key 等于 say666
uint32_t count;
// base相当于low,count是max了,probe是middle,这就是二分
for (count = list->count; count != 0; count >>= 1) {
// 从首地址+下标 -> 移动到中间位置(count >> 1 右移1位 count/2 = 4)
probe = base + (count >> 1);

uintptr_t probeValue = (uintptr_t)probe->name;

// 如果查找的key是keyVal 等于中间位置(probe)的probeValue,则直接返回中间位置
if (keyValue == probeValue) {
// while 平移 排除分类重名方法
while (probe > first && keyValue == (uintptr_t)probe[-1].name) {
/*
排除分类重名方法(方法的存储是先存储方法,再存储分类,按照先进后出的原则,分类方法最先出,
而我们要取的类方法,所以需要先排除分类方法
如果是两个分类,就看谁先进行加载)
*/
probe--;
}
return (method_t *)probe;
}
// 如果keyValue 大于 probeValue,就往probe即中间位置的右边查找
if (keyValue > probeValue) {
base = probe + 1;
count--;
}
}

return nil;
}

算法原理 简述:从第一次查找开始,每次都取 中间位置,与想查找的 key的value的值 作比较,如果 相等,则需要 排除分类方法,然后将查询到的位置的方法实现返回,如果 不相等,则需要 继续二分查找,如果循环至 count=0 还是 没有找到,则直接返回 nil,如下图所示:

以查找 ZJPerson 类的 sayNB实例方法 为例,其二分查找过程如下:

cache_getImp方法:父类缓存查找

cache_getImp 方法是通过 汇编_cache_getImp实现,传入 $0GETIMP,如下所示:

  • 如果 父类缓存 中找到了方法实现,则跳转至 CacheHit 即命中,则直接 返回imp

  • 如果在 父类缓存 中,没有找到 方法实现,则跳转至 CheckMiss 或者 JumpMiss,通过判断 $0 跳转至 LGetImpMiss,直接返回 nil

总结

  • 对于 对象方法(即实例方法),即在 类中查找,其慢速查找的 父类链 是:类 -> 父类 -> 根类 -> nil

  • 对于 类方法,即在 元类中查找,其慢速查找的 父类链 是:元类 -> 根元类 -> 根类 -> nil

  • 如果 快速查找、慢速查找没有找到 方法实现,则尝试 动态方法决议

  • 如果 动态方法决议 仍然没有找到,则进行 消息转发

常见方法未实现报错源码

如果在 快速查找、慢速查找、方法解析流程中,均没有找到方法实现,则使用消息转发,其流程如下:

消息转发的实现

  • 其中 _objc_msgForward_impcache 是汇编实现,会跳转至 __objc_msgForward,其核心是 __objc_forward_handler
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
STATIC_ENTRY __objc_msgForward_impcache

// No stret specialization.
b __objc_msgForward

END_ENTRY __objc_msgForward_impcache


ENTRY __objc_msgForward

adrp x17, __objc_forward_handler@PAGE
ldr p17, [x17, __objc_forward_handler@PAGEOFF]
TailCallFunctionPointer x17

END_ENTRY __objc_msgForward
  • 汇编实现中查找 __objc_forward_handler ,并没有找到,在源码中去掉一个下划线进行全局搜索 _objc_forward_handler ,有如下实现,本质是调用的 objc_defaultForwardHandler 方法
1
2
3
4
5
6
7
8
9
10
// Default forward handler halts the process.
__attribute__((noreturn, cold)) void
objc_defaultForwardHandler(id self, SEL sel)
{
_objc_fatal("%c[%s %s]: unrecognized selector sent to instance %p "
"(no message forward handler is installed)",
class_isMetaClass(object_getClass(self)) ? '+' : '-',
object_getClassName(self), sel_getName(sel), self);
}
void *_objc_forward_handler = (void*)objc_defaultForwardHandler;
  • 看着 objc_defaultForwardHandler 有没有很眼熟,这就是我们日常开发中最常见的错误:没有实现函数,运行程序,崩溃时的报错提示
  • Post title:OC底层原理14-2:objc_msgSend方法列表查找(快速查找)汇编分析
  • Post author:张建
  • Create time:2020-10-05 10:12:37
  • Post link:https://redefine.ohevan.com/2020/10/05/OC底层原理/OC底层原理14-2:objc_msgSend方法列表查找(慢速查找)汇编分析/
  • Copyright Notice:All articles in this blog are licensed under BY-NC-SA unless stating additionally.