本文源码来自于 objc4-756.2 版本；

本文研究 sideTable 在 objc4 源码中的使用及其作用，从而解析 iOS 中引用计数器和弱引用的实现原理；

1. retain 操作

我们都知道，新版本的 objc 中引入了 Tagged Pointer，且 isa 采用 union 的方式进行构造，其中 isa 的结构体中有一个 extra_rc 和 has_sidetable_rc，这两者共同记录引用计数器。

直接看看 objc_object::rootRetain() 方法，只看 extra_rc 超出之后 sidetable 相关的代码，删减之后如下：

uintptr_t carry;newisa.bits = addc(newisa.bits, RC_ONE, 0, &carry);  // extra_rc++if (carry) {// Leave half of the retain counts inline and prepare to copy the other half to the side table.transcribeToSideTable = true;newisa.extra_rc = RC_HALF;newisa.has_sidetable_rc = true;
}
if (slowpath(transcribeToSideTable)) {// Copy the other half of the retain counts to the side table.sidetable_addExtraRC_nolock(RC_HALF);
}

那么关键方法就是 sidetable_addExtraRC_nolock()：

bool
objc_object::sidetable_addExtraRC_nolock(size_t delta_rc)
{assert(isa.nonpointer);// 取出this对象所在的SideTableSideTable& table = SideTables()[this];// 取出SideTable中存储的refcnts，类型为Mapsize_t& refcntStorage = table.refcnts[this];// 记录原始的引用计数器size_t oldRefcnt = refcntStorage;// 容错处理assert((oldRefcnt & SIDE_TABLE_DEALLOCATING) == 0);assert((oldRefcnt & SIDE_TABLE_WEAKLY_REFERENCED) == 0);if (oldRefcnt & SIDE_TABLE_RC_PINNED) return true;uintptr_t carry;size_t newRefcnt = addc(oldRefcnt, delta_rc << SIDE_TABLE_RC_SHIFT, 0, &carry);if (carry) {// SideTable溢出处理refcntStorage =SIDE_TABLE_RC_PINNED | (oldRefcnt & SIDE_TABLE_FLAG_MASK);return true;} else {// SideTable未溢出refcntStorage = newRefcnt;return false;}
}

这个函数的逻辑如下：

1. 根据 this，也就是对象的地址从 SideTables 中取出一个 SideTable；
2. 获取 SideTable 的 refcnts，这个成员变量是一个 Map；
3. 存储旧的引用计数器；
4. 进行 add 计算，并记录是否有溢出；
5. 根据是否溢出计算并记录结果，最后返回；

那么，这里有几个点需要解开：

1. 什么是 SideTables；
2. 什么是 SideTable；
3. 什么是 refcnts；
4. add 的计算逻辑为什么需要位移？
5. SideTable 中的溢出时如何处理的？

接下来，一一解决~~~

2. SideTables

直接来看 SideTables 的代码：

static StripedMap<SideTable>& SideTables() {return *reinterpret_cast<StripedMap<SideTable>*>(SideTableBuf);
}

首先，这是个静态函数，返回 StripedMap<SideTable> 类型，但是 & 是什么意思呢？这个是 C++ 语法，表示返回引用类型，看个例子：

&的用法

& 的用法还有些限制，比如不能返回栈中的引用，否则会栈变量消失后会出现 error，还有一些其他的限制，有兴趣可以深究，这里只需要知道 & 表示返回引用类型，也就是可以通过 & func() 来获取函数返回值的指针，其他的不再赘述；

接着，比较懵逼的是 *reinterpret_cast ，其实这个是 C++ 的强制类型转换语法，不用深究，有兴趣的可以自行百度。

所以，总结下这段代码：

1. SideTables() 使用 static 修饰，是一个静态函数；
2. & 表示返回引用类型；
3. reinterpret_cast 是一个强制类型转换符号；
4. 函数最终的结果就是返回 SideTableBuf；

那么 SideTableBuf 又是什么？

3. SideTableBuf

直接看代码：

// We cannot use a C++ static initializer to initialize SideTables because
// libc calls us before our C++ initializers run. We also don't want a global
// pointer to this struct because of the extra indirection.
// Do it the hard way.alignas(StripedMap<SideTable>) static uint8_t SideTableBuf[sizeof(StripedMap<SideTable>)];

首先看注释，说明了两点：

1. SideTables 在 C++ 的 initializers 函数之前被调用，所以不能使用 C++ 初始化函数来初始化 SideTables，而 SideTables 本质就是 SideTableBuf；
2. 不能使用全局指针来指向这个结构体，因为涉及到重定向问题；

其实还是比较懵逼为什么 SideTableBuf 要这么设计，原理有待考究~~~估计和初始化有关；

继续看 SideTableBuf，要点包括：

1. alignas 表示对齐；
2. StripedMap<SideTable> 的 size 为 4096(存疑，待验证)；
3. uint8_t 实际上是 unsigned char 类型，即占 1 个字节；

由此可以得出：

• SideTableBuf 本质上是一个长度为 sizeof(StripedMap<SideTable>) 的 char 类型的数组；

同时也可以这么理解：

• SideTableBuf 本质上就是一个大小为和 StripedMap<SideTable> 对象一致的内存块；

这也是为什么 SideTableBuf 可以用来表示 StripedMap<SideTable> 对象。本质上而言，SideTableBuf 就是指一个 StripedMap<SideTable>对象；

那么接下来就是搞清楚 StripedMap<SideTable> 是个什么东西了......

4. StripedMap<SideTable>

先上代码，删减一些方法之后的代码为：

template<typename T>
class StripedMap {
#if TARGET_OS_IPHONE && !TARGET_OS_SIMULATORenum { StripeCount = 8 };
#elseenum { StripeCount = 64 };
#endifstruct PaddedT {T value alignas(CacheLineSize);};PaddedT array[StripeCount];static unsigned int indexForPointer(const void *p) {uintptr_t addr = reinterpret_cast<uintptr_t>(p);return ((addr >> 4) ^ (addr >> 9)) % StripeCount;}public:T& operator[] (const void *p) { return array[indexForPointer(p)].value; }const T& operator[] (const void *p) const { return const_cast<StripedMap<T>>(this)[p]; }...省略了对象方法...
}

上述代码的逻辑为：

1. 根据是否为 iphone 定义了一个 StripeCount，iphone 下为 8；
2. 源码中 CacheLineSize 为 64，使用 T 定义了一个结构体，而 T 就是 SideTable 类型；
3. 生成了一个长度为 8 类型为 SideTable 的数组；
4. indexForPointer() 逻辑为根据传入的指针，经过一定的算法，计算出一个存储该指针的位置，因为使用了取模运算，所以值为 0 - StripeCount；
5. 后面的 operator 表示重写了运算符 [] 的逻辑，调用了 indexForPointer() 方法，这样使用起来更像一个数组；

至此，SideTables 的含义已经很清楚了：

• SideTables 可以理解成一个类型为 StripedMap<SideTable> 静态全局对象，内部以数组的形式存储了 StripeCount 个 SideTable；

那么第一个问题已经解决，按照 sidetable_addExtraRC_nolock() 方法中的逻辑，先从 SideTables 数组中取出一个 SideTable，然后进行相关操作，所以现在就来看看 SideTable 是个啥~~~

5. SideTable

struct SideTable {spinlock_t slock;RefcountMap refcnts;weak_table_t weak_table;SideTable() {memset(&weak_table, 0, sizeof(weak_table));}~SideTable() {_objc_fatal("Do not delete SideTable.");}...省略对象方法...
}

可以看到，SideTable 有三个成员变量：

1. spinlock_t：自旋锁，负责加锁相关逻辑；
2. refcnts：存储引用计数器的 Map；
3. weak_table：存储弱引用的表；

自旋锁暂不讨论，来看看 refcnts 的定义：

typedef objc::DenseMap<DisguisedPtr<objc_object>,size_t,RefcountMapValuePurgeable> RefcountMap;

DenseMap 过于复杂，我们看看基类 DenseMapBase 中的部分代码，如下，DenseMapBase中重写了操作符 []：

ValueT &operator[](const KeyT &Key) {return FindAndConstruct(Key).second;}

大意是通过传入的 Key 寻找对应的 Value。而 Key 是 DisguisedPtr<objc_object> 类型，Value 是 size_t 类型。

回到最初的 sidetable_addExtraRC_nolock 方法中：

size_t& refcntStorage = table.refcnts[this];

上述代码就是通过 this ，即 object 对象的地址，取出 refcnts 这个哈希表中存储的引用计数器；

refcnts 可以理解成一个 Map，使用 address:refcount 的形式存储了很多个对象的引用计数器；

6. 总结

SideTables 和 SideTable

1. iphone 中 SideTables() 本质是返回一个 SideTableBuf 对象，该对象存储 8 个 SideTable；
2. 因为涉及到多线程和效率的问题，必定不可能只使用一个 SideTable 来存储对象相关的引用计数器和弱引用；
3. Apple 通过对 object 的地址进行运算之后，对 SideTable 的个数进行取模运算，以此来决定将对象分配到哪个 SideTable 进行信息存储，因为有取模运算，不会出现数组溢出的情况；

总结：

• objc 中当对象需要使用到 sideTable 时，会被分配到 8/64 个全局 sideTables 中的某一个表中存储相关的引用计数器或者弱引用信息；

7. weak_table

继续看弱引用如何实现的，看看 weak_table_t 源码：

/*** The global weak references table. Stores object ids as keys,* and weak_entry_t structs as their values.*/
struct weak_table_t {weak_entry_t *weak_entries;size_t    num_entries;uintptr_t mask;uintptr_t max_hash_displacement;
};

注释也说明了 weak_table_t 是一个全局引用表，object 的地址作为 key，weak_entry_t 作为 Value。只不过这个全局引用表有 8 或者 64 个；

那么这个 weak_entry_t 是什么，又是怎么用的呢，弱引用的存储逻辑是怎样的？

image.png

疑问

1. 为什么 weak 能够自动置位 nil？
2. 析构函数？

SideTables 的初始化时机和流程

isa 中的 shiftcls 溢出时则调用 sidetable_addExtraRC_nolock 方法将一半的引用计数器存入 sidetable 中

从上面的代码来看，逻辑相对清晰：

1. SideTables 应该是一个全局性的东西；
2. 传入 this 取出 当前对象相关的 SideTable；
3. SideTable 有一个 refcnts 的 map，仍然根据 this 取出这个旧的引用计数器；
4. 通过 addc 计算，需要位移估计是因为 refcnts 在 sideTable 中的位置有关吧；
5. 计算完毕，如果没有溢出，则直接新值替换旧值；
6. 如果发生溢出，则？？

接下来 SideTable：

struct SideTable {spinlock_t slock;RefcountMap refcnts;weak_table_t weak_table;...省略对象方法...
}

SideTables 应该是一个全局变量，其定义如下：

static StripedMap<SideTable>& SideTables() {return *reinterpret_cast<StripedMap<SideTable>*>(SideTableBuf);
}

如上，是一个静态方法，获取 StripedMap<SideTable> 类型的变量的

SideTables 的初始化

image.png

image.png

image.png

image.png

image.png

notifyBatchPartial 方法中，state = dyld_image_state_bound 时：

(*sNotifyObjCMapped)(objcImageCount, paths, mhs);

image.png

image.png

image.png