[[146754]]

objc_msgSend 函數支撐了我們使用 Objective-C 實現的一切。Gwynne Raskind，Friday Q&A 的讀者，建議我談談 objc_msgSend 的內部實現。要理解某件事還有比自己動手實現一次更好的方法嗎？咱們來自己動手實現一個 objc_msgSend。

Tramapoline! Trampopoline! (蹦床)

當你寫了一個發送 Objective-C 消息的方法：

[obj message] 

編譯器會生成一個 objc_msgSend 調用：

objc_msgSend(obj, @selector(message)); 

之后 objc_msgSend 會負責轉發這個消息。

它都做了什么？它會查找合適的函數指針或者 IMP，然后調用，***跳轉。任何傳給 objc_msgSend 的參數，最終都會成為 IMP 的參數。 IMP 的返回值成為了最開始被調用的方法的返回值。

因為 objcmsgSend 只是負責接收參數，找到合適的函數指針，然后跳轉，有時管這種叫做 trampoline（譯注：[蹦床](https://en.wikipedia.org/wiki/Trampoline(computing)）. 更通用的來說，任何一段負責把一段代碼轉發到另一處的代碼，都可以被叫做 trampoline。

這種轉發的行為使 objc_msgSend 變得特殊起來。因為它只是簡單的查找合適的代碼，然后直接跳轉過去，這相當的通用。傳入任何參數組合都可以，因為它只是把這些參數留給 IMP 去讀取。返回值有些棘手，但最終都可以看成 objc_msgSend 的不同變種。

不幸的是，這些轉發行為都不能用純 C 實現。因為沒有方法可以將傳入 C 函數的泛參（generic parameters）傳給另一個函數。 你可以使用變參，但是變參和普通參數的傳遞方法不同，而且慢，所以這不適合普通的 C 參數。

如果要用 C 來實現 objc_msgSend，基本樣子應該像這樣：

id objc_msgSend(id self, SEL _cmd, ...) 
{ 
    Class c = object_getClass(self); 
    IMP imp = class_getMethodImplementation(c, _cmd); 
    return imp(self, _cmd, ...); 
} 

這有點過于簡單。事實上會有一個方法緩存來提升查找速度，像這樣：

id objc_msgSend(id self, SEL _cmd, ...) 
{ 
    Class c = object_getClass(self); 
    IMP imp = cache_lookup(c, _cmd); 
    if(!imp) 
        imp = class_getMethodImplementation(c, _cmd); 
    return imp(self, _cmd, ...); 
} 

通常為了速度，cache_lookup 使用 inline 函數實現。

匯編

在 Apple 版的 runtime 中，為了***化速度，整個函數是使用匯編實現的。在 Objective-C 中每次發送消息都會調用 objc_msgSend，在一個應用中最簡單的動作都會有成千或者上百萬的消息。

為了讓事情更簡單，我自己的實現中會盡可能少的使用匯編，使用獨立的 C 函數抽象復雜度。匯編代碼會實現下面的功能：

id objc_msgSend(id self, SEL _cmd, ...) 
{ 
    IMP imp = GetImplementation(self, _cmd); 
    imp(self, _cmd, ...); 
} 

GetImplementation 可以用更可讀的方式工作。

匯編代碼需要：

1. 把所有潛在的參數存儲在安全的地方，確保 GetImplementation 不會覆蓋它們。
2. 調用 GetImplementation。
3. 把返回值保存在某處。
4. 恢復所有的參數值。
5. 跳轉到 GetImplementation 返回的 IMP。

讓我們開始吧！

這里我會嘗試使用 x86-64 匯編，這樣可以很方便的在 Mac 上工作。這些概念也可以應用于 i386 或者 ARM。

這個函數會保存在獨立的文件中，叫做 msgsend-asm.s。這個文件可以像源文件那樣傳遞給編譯器，然后會被編譯并鏈接到程序中。

***件事要做的是聲明全局的符號（global symbol）。因為一些無聊的歷史原因，C 函數的 global symbol 會在名字前有個下劃線：

.globl _objc_msgSend 
_objc_msgSend: 

編譯器會很高興的鏈接最近可使用的(nearest available) objc_msgSend。簡單的鏈接這個到一個測試 app 已經可以讓 [obj message] 表達式使用我們自己的代碼而不是蘋果的 runtime，這樣可以相當方便的測試我們的代碼確保它可以工作。

整型數和指針參數會被傳入寄存器 %rsi, %rdi, %rdx, %rcx, %r8 和 %r9。其他類型的參數會被傳進棧（stack）中。這個函數***做的事情是把這六個寄存器中的值保存在棧中，這樣它們可以在之后被恢復：

pushq %rsi 
pushq %rdi 
pushq %rdx 
pushq %rcx 
pushq %r8 
pushq %r9 

除了這些寄存器，寄存器 %rax 扮演了一個隱藏的參數。它用于變參的調用，并保存傳入的向量寄存器（vector registers）的數量，用于被調用的函數可以正確的準備變參列表。以防目標函數是個變參的方法，我同樣也保存了這個寄存器中的值：

pushq %rax 

為了完整性，用于傳入浮點類型參數的寄存器 %xmm 也應該被保存。但是，要是我能確保 GetImplementation 不會傳入任何的浮點數，我就可以忽略掉它們，這樣我就可以讓代碼更簡潔。

接著，對齊棧。 Mac OS X 要求一個函數調用棧需要對齊 16 字節邊界。上面的代碼已經是棧對齊的，但是還是需要顯式手動處理下，這樣可以確保所有都是對齊的，就不用擔心動態調用函數時會崩潰。要對齊棧，在保存 %r12 的原始值到棧中后，我把當前的棧指針保存到了 %r12 中。%r12 是隨便選的，任何保存的調用者寄存器（caller-saved register）都可以。重要的是在調用完 GetImplementation 后這些值仍然存在。然后我把棧指針按位與（and）上 -0x10，這樣可以清除棧底的四位：

pushq %r12 
mov %rsp, %r12 
andq $-0x10, %rsp 

現在棧指針是對齊的了。這樣可以安全的避開上面（above）保存的寄存器，因為棧是向下增長的，這種對齊的方法會讓它更向下（move it further down）。

是時候該調用 GetImplementation 了。它接收兩個參數，self 和 _cmd。 調用習慣是把這兩個參數分別保存到 %rsi 和 %rdi 中。然而傳入 objc_msgSend 中時就是那樣了，它們沒有被移動過，所以不需要改變它們。所有要做的事情實際上是調用 GetImplementation，方法名前面也要有一個下劃線：

callq _GetImplementation 

整型數和指針類型的返回值保存在 %rax 中，這就是找到返回的 IMP 的地方。因為 %rax 需要被恢復到初始的狀態，返回的 IMP 需要被移動到別的地方。我隨便選了個 %r11。

mov %rax, %r11 

現在是時候該恢復原樣了。首先要恢復之前保存在 %r12 中的棧指針，然后恢復舊的 %r12 的值：

mov %r12, %rsp 
popq %r12 

然后按壓入棧的相反順序恢復寄存器的值：

popq %rax 
popq %r9 
popq %r8 
popq %rcx 
popq %rdx 
popq %rdi 
popq %rsi 

現在一切都已經準備好了。參數寄存器（argument registers）都恢復到了之前的樣子。目標函數需要的參數都在合適的位置了。 IMP 在寄存器 %r11 中，現在要做的是跳轉到那里：

jmp *%r11 

就這樣！不需要其他的匯編代碼了。jump 把控制權交給了方法實現。從代碼的角度看，就好像發送消息者直接調用的這個方法。之前的那些迂回的調用方法都消失了。當方法返回，它會直接放回到 objc_msgSend 的調用處，不需要其他的操作。這個方法的返回值可以在合適的地方找到。

非常規的返回值有一些細節需要注意。比如大的結構體（不能用一個寄存器大小保存的返回值）。在 x86-64，大的結構體使用隱藏的***個參數返回。當你像這樣調用：

NSRect r = SomeFunc(a, b, c); 

這個調用會被翻譯成這樣：

NSRect r; 
SomeFunc(&r, a, b, c); 

用于返回值的內存地址被傳入到 %rdi 中。因為 objc_msgSend 期望 %rdi 和 %rsi 中包含 self 和 _cmd，當一個消息返回大的結構體時不會起作用的。同樣的問題存在于多個不同平臺上。runtime 提供了 objc_msgSend_stret 用于返回結構體，工作原理和 objc_msgSend 類似，只是知道在 %rsi 中尋找 self 和在 %rdx 中尋找 _cmd。

相似的問題發生在一些平臺上發送消息（messages）返回浮點類型值。在這些平臺上，runtime 提供了 objc_msgSend_fpret（在 x86-64，objc_msgSend_fpret2 用于特別極端的情況）。

方法查找

讓我們繼續實現 GetImplementation。上面的匯編蹦床意味著這些代碼可以用 C 實現。記得嗎，在真正的 runtime 中，這些代碼都是直接用匯編寫的，是為了盡可能的保證最快的速度。這樣不僅可以更好的控制代碼，也可以避免重復像上面那樣保存并恢復寄存器的代碼。

GetImplementation 可以簡單的調用 class_getMethodImplementation 實現，混入 Objective-C runtime 的實現。這有點無聊。真正的 objc_msgSend 為了***化速度首先會查找類的方法緩存。因為 GetImplementation 想模仿 objc_msgSend，所以它也會這么做。要是緩存中不包含給定的 selector 入口點（entry），它會繼續查找 runtime（it fall back to querying the runtime）。

我們現在需要的是一些結構體定義。方法緩存是類（class）結構體中的私有結構體，為了得到它我們需要定義自己的版本。盡管是私有的，這些結構體的定義還是可以通過蘋果的 Objective-C runtime 開源實現獲得（譯注：http://opensource.apple.com/tarballs/objc4/）。

首先需要定義一個 cache entry：

typedef struct { 
    SEL name; 
    void *unused; 
    IMP imp; 
} cache_entry; 

相當簡單。別問我 unused 字段是干什么的，我也不知道它為什么在那。這是 cache 的全部定義：

struct objc_cache { 
    uintptr_t mask; 
    uintptr_t occupied; 
    cache_entry *buckets[1]; 
}; 

緩存使用 hash table（哈希表）實現。實現這個表是為了速度的考慮，其他無關的都簡化了，所以它有點不一樣。表的大小永遠都是 2 的冪。表格使用 selector 做索引，bucket 是直接使用 selector 的值做索引，可能會通過移位去除不相關的低位（low bits），并與 mask 執行一個邏輯與（logical and）。下面是一些宏，用于給定 selector 和 mask 時計算 bucket 的索引：

#ifndef __LP64__ 
# define CACHE_HASH(sel, mask) (((uintptr_t)(sel)>>2) & (mask)) 
#else 
# define CACHE_HASH(sel, mask) (((unsigned int)((uintptr_t)(sel)>>0)) & (mask)) 
#endif 

***是類的結構體。 這是 Class 指向的類型：

struct class_t { 
    struct class_t *isa; 
    struct class_t *superclass; 
    struct objc_cache *cache; 
    IMP *vtable; 
}; 

需要的結構體都已經有了，現在開始實現 GetImplementation 吧：

IMP GetImplementation(id self, SEL _cmd) 
{ 

首先要做的是獲取對象的類。真正的 objc_msgSend 通過類似 self->isa 的方式獲取，但是它會使用官方的 API 實現：

Class c = object_getClass(self); 

因為我想訪問最原始的形式，我會為指向 class_t 結構體的指針執行類型轉換：

struct class_t *classInternals = (struct class_t *)c; 

現在該查找 IMP 了。首先我們把它初始為 NULL。如果我們在緩存中找到，我們會賦值為它。如果查找緩存后仍為 NULL，我們會回退到速度較慢的方法：

IMP imp = NULL; 

接著，獲取指向 cache 的指針：

struct objc_cache *cache = classInternals->cache; 

計算 bucket 的索引，獲取指向 buckets 數組的指針：

uintptr_t index = CACHE_HASH(_cmd, cache->mask); 
cache_entry **buckets = cache->buckets; 

然后，我們使用要找的 selector 查找緩存。runtime 使用的是線性鏈（linear chaining），之后只是遍歷 buckets 子集直到找到需要的 entry 或者 NULL entry：

for(; buckets[index] != NULL; index = (index + 1) & cache->mask) 
{ 
    if(buckets[index]->name == _cmd) 
    { 
        imp = buckets[index]->imp; 
        break; 
    } 
} 

如果沒有找到 entry，我們會調用 runtime 使用一種較慢的方法。在真正的 objc_msgSend 中，上面的所有代碼都是使用匯編實現的，這時候就該離開匯編代碼調用 runtime 自己的方法了。一旦查找緩存后沒有找到需要的 entry，期望快速發送消息的希望就要落空了。這時候獲取更快的速度就沒那么重要了，因為已經注定會變慢，在一定程度上也極少的需要這么調用。因為這點，放棄匯編代碼轉而使用更可維護的 C 也是可以接受的：

if(imp == NULL) 
    imp = class_getMethodImplementation(c, _cmd); 

不管怎樣，IMP 現在已經獲取到了。如果它在緩存中，就會在那里找到它，否則它會通過 runtime 查找到。class_getMethodImplementation 調用同樣會使用緩存，所以下次調用會更快。剩下的就是返回 IMP：

return imp; 

測試

為了確保它能工作，我寫了一個快速的測試程序：

@interface Test : NSObject 
- (void)none; 
- (void)param: (int)x; 
- (void)params: (int)a : (int)b : (int)c : (int)d : (int)e : (int)f : (int)g; 
- (int)retval; 
@end 
 
@implementation Test 
 
- (id)init 
{ 
    fprintf(stderr, "in init method, self is %p\n", self); 
    return self; 
} 
 
- (void)none 
{ 
    fprintf(stderr, "in none method\n"); 
} 
 
- (void)param: (int)x 
{ 
    fprintf(stderr, "got parameter %d\n", x); 
} 
 
- (void)params: (int)a : (int)b : (int)c : (int)d : (int)e : (int)f : (int)g 
{ 
    fprintf(stderr, "got params %d %d %d %d %d %d %d\n", a, b, c, d, e, f, g); 
} 
 
- (int)retval 
{ 
    fprintf(stderr, "in retval method\n"); 
    return 42; 
} 
 
@end 
 
 
int main(int argc, char **argv) 
{ 
    for(int i = 0; i < 20; i++) 
    { 
        Test *t = [[Test alloc] init]; 
        [t none]; 
        [t param: 9999]; 
        [t params: 1 : 2 : 3 : 4 : 5 : 6 : 7]; 
        fprintf(stderr, "retval gave us %d\n", [t retval]); 
 
        NSMutableArray *a = [[NSMutableArray alloc] init]; 
        [a addObject: @1]; 
        [a addObject: @{ @"foo" : @"bar" }]; 
        [a addObject: @("blah")]; 
        a[0] = @2; 
        NSLog(@"%@", a); 
    } 
} 

以防因為一些意外調用的是 runtime 的實現。我在 GetImplementation 中加了一些調試的日志確保它被調用了。一切都正常，即使是 literals and subscripting 也都調用的是替換的實現。

結論

objc_msgSend 的核心部分相當的簡單。但它的實現需要一些匯編代碼，這讓它比它應該的樣子更難理解。但是為了性能的優化還是得使用一些匯編代碼。但是通過構建了一個簡單的匯編蹦床，然后使用 C 實現了它的邏輯，我們可以看到它是如何工作的，它真的沒有什么高深的。

很顯然，你不應該在自己的 app 中使用替換的 objc_msgSend 實現。你會后悔這么做的。這么做只為了學習目的。