讀讀objc原始碼(二)：weak型別指標的實現

摘要： weak指標這部分程式碼寫的很好啊，結構清晰，介面定義到關鍵位置，讀取來很舒服。 整體結構 SideTable包含了引用計數表和weak指標表，大概就是記憶體管理的總表，SideTable有多張，物件根據記憶體地址會關聯上某一張 weak_table_...

weak指標這部分程式碼寫的很好啊，結構清晰，介面定義到關鍵位置，讀取來很舒服。

整體結構

• SideTable包含了引用計數表和weak指標表，大概就是記憶體管理的總表，SideTable有多張，物件根據記憶體地址會關聯上某一張
• weak_table_t 包含了所有具有weak指標的物件的weak指標資訊
• weak_entry_t 對應某一個物件，一個物件可能有多個weak指標，它們作為一個整體存放在這裡
• weak_entry_t包含兩部分，一個是物件的記憶體地址，這個相當於key/id的作用，用來識別是對應哪個物件的；另一部分就是指向這個物件的所有weak指標。

整體的邏輯就是： 使用hash表把物件和所有指向它的weak指標關聯起來，等這個物件dealloc的時候，把這些weak指標拿出來，全部設定成nil。

SideTable

We cannot use a C++ static initializer to initialize SideTables because libc calls us before our C++ initializers run.

程式碼註釋裡有句話，所以這就是為什麼用靜態記憶體+指標強轉來構建SideTable的原因吧，要足夠早。

SideTable是用StripedMap包裝了的，StripedMap的作用，看它的讀取方法：

T& operator[] (const void *p) { 
return array[indexForPointer(p)].value; 
}
複製程式碼

它過載了中括號 [] ，從array裡把值取出來，關鍵就是 indexForPointer 這個函式，它完成從指標到索引的轉換：

static unsigned int indexForPointer(const void *p) {
uintptr_t addr = reinterpret_cast<uintptr_t>(p);
return ((addr >> 4) ^ (addr >> 9)) % StripeCount;
}
複製程式碼

所以它其實是一個hash函式，根據指標的值，也就是指向記憶體的地址，轉化成落在[0, StripeCount]範圍內的一個unsigned int值。

整體來看，對一個物件，獲取它的SideTable，就是把這個物件的地址轉化成了一個[0, StripeCount]範圍內的索引，在拿到這個索引的SideTable。

weak_table_t和weak_entry_t單看結構沒什麼特別的，在使用的時候再看。

weak指標的使用

3中情況：

1. weakA = weakB
2. weakA = strongB
3. strongA = weakB

情況1和2都是呼叫了 id objc_storeWeak(id *location, id newObj) ,情況3走的是 id objc_loadWeakRetained(id *location) ，而 objc_loadWeakRetained 實際就是把weak物件retain了一下，屬於另外的問題了。

還有一種情況，定義一個weak指標的時候： __weak TFBook *weakBook = nil; ,這個也是走了 id objc_storeWeak(id *location, id newObj) 。

所以 objc_storeWeak 是核心的核心。

怎麼看呼叫什麼方法？猥瑣一點，搞個while迴圈,在裡面寫想檢視的方法，然後用instrument工具裡的 Time Profiler 看佔掉cpu 100%的那個就是了！

objc_storeWeak

template <bool HaveOld, bool HaveNew, bool CrashIfDeallocating>
static id 
storeWeak(id *location, objc_object *newObj)
複製程式碼

• HaveOld 是否有就物件，weakA = weakB，如果weakA之前是nil,那HaveOld就是false.
• HaveNew 是否新物件
• 這個操作處在deallocing呼叫過程中是否奔潰
• location是指向weak指標的指標，因為要修改weak指標
• newObj新物件

它的作用就是解除舊物件關係，和新物件建立聯絡。

weak_unregister_no_lock：

.....
if ((entry = weak_entry_for_referent(weak_table, referent))) {
remove_referrer(entry, referrer);
.....
if (empty) {
weak_entry_remove(weak_table, entry);
}
.....
複製程式碼

取出entry，移除referrer，referrer是weak指標的引用，這裡的weak_table是舊錶，舊錶裡移除weak指標，就是解除了久物件和weak指標的關係。

如果這個empty空了，就從table裡去掉。

• weak_entry_for_referent

  size_t begin = hash_pointer(referent) & weak_table->mask;
  ...
  while (weak_table->weak_entries[index].referent != referent) {
  index = (index+1) & weak_table->mask;
  if (index == begin) bad_weak_table(weak_table->weak_entries);
  hash_displacement++;
  if (hash_displacement > weak_table->max_hash_displacement) {
  return nil;
  }
  }
  複製程式碼

  從weak_table_t裡面取出entry，用了hash表的邏輯:

  • hash_pointer也是使用指標地址，對映到一個索引。 &weak_table->mask 這個操作是？這個mask實際值是表的size-1,而size是2的n次方方式擴張的，所以mask的形式就 1111 1111 1111 這種，索引和mask位與之後的值必定就落在了[0, size]範圍內。簡潔高效，牛逼！
  • index都取到了，為什麼還要while迴圈？因為hash函式也會重合的，如果index1的位置已經有人佔了，又來一個人要佔index1怎麼辦？往後挪，直到找到一個空位置。所以hash函式得到的index和實際位置有那麼一點的偏差。
  • hash_displacement是在存入資料的時候記錄了最大的偏差值，有這個做把控，偏移超過了這個值肯定是沒有了。

• remove_referrer

if (! entry->out_of_line()) {
for (size_t i = 0; i < WEAK_INLINE_COUNT; i++) {
if (entry->inline_referrers[i] == old_referrer) {
entry->inline_referrers[i] = nil;
return;
}
}
.....
size_t begin = w_hash_pointer(old_referrer) & (entry->mask);
....
while (entry->referrers[index] != old_referrer) {
index = (index+1) & entry->mask;
if (index == begin) bad_weak_table(entry);
hash_displacement++;
if (hash_displacement > entry->max_hash_displacement) {
.....
objc_weak_error();
return;
}
}
複製程式碼

weak_entry_t有個奇怪的地方就是裡面有個union:

union {
struct {
weak_referrer_t *referrers;
uintptr_tout_of_line_ness : 2;
uintptr_tnum_refs : PTR_MINUS_2;
uintptr_tmask;
uintptr_tmax_hash_displacement;
};
struct {
// out_of_line_ness field is low bits of inline_referrers[1]
weak_referrer_tinline_referrers[WEAK_INLINE_COUNT];
};
};
複製程式碼

這兩個東西都是用來儲存指向這個物件的所有weak指標的，但是是不同時期使用的，到weak指標在4（WEAK_INLINE_COUNT）個以內的時候，用陣列 inline_referrers ,超過用 weak_referrer_t ，這個還是hash表。

我的理解是這是為了效能考慮。一般情況，就一兩個weak指標會指向同一個物件，用陣列管理，存取快。但是也得允許N多weak指標指向同一個物件，WEAK_INLINE_COUNT不可能無限大。感受到了一點空時間、分階段處理的思想。

weak_referrer_t的存取跟上面weak_table_t一樣。

out_of_line是用來判斷是否超過陣列個數的，就是它用來做兩種方案的切換：

bool out_of_line() {
return (out_of_line_ness == REFERRERS_OUT_OF_LINE);
}
複製程式碼

out_of_line_ness是否被設定了 REFERRERS_OUT_OF_LINE 這個標識。這個標識的值實際是2。註釋裡有一段話：

// out_of_line_ness field overlaps with the low two bits of inline_referrers[1]. // inline_referrers[1] is a DisguisedPtr of a pointer-aligned address. // The low two bits of a pointer-aligned DisguisedPtr will always be 0b00 // (disguised nil or 0x80..00) or 0b11 (any other address). // Therefore out_of_line_ness == 0b10 is used to mark the out-of-line state.

因為union的關係，out_of_line_ness的記憶體位置對應的就是陣列inline_referrers裡第二個（weak_referrer_t和weak_referrer_t *都是8個位元組）。根據這段註釋，weak_referrer_t的資料的二進位制結尾要麼是00要麼是11，不會是10，所以用10來做標識。

如果只使用inline_referrers，那麼out_of_line_ness讀取出來就要麼是00要麼是11，所以如果讀出來是10，也就是十進位制2，就是使用hash表的referrers。

我沒搞懂的是為什麼weak_referrer_t的結尾不會是10。

weak_register_no_lock

這個函式和 weak_unregister_no_lock 幾乎就是反操作了：

weak_entry_t *entry;
if ((entry = weak_entry_for_referent(weak_table, referent))) {
append_referrer(entry, referrer);
} 
else {
weak_entry_t new_entry(referent, referrer);
weak_grow_maybe(weak_table);
weak_entry_insert(weak_table, &new_entry);
}
複製程式碼

• weak_grow_maybe+weak_entry_insert對應weak_entry_remove
• append_referrer對應remove_referrer