AutoreleasePool底層實現原理

AutoreleasePool（自動釋放池）是OC中的一種記憶體自動回收機制，它可以延遲加入AutoreleasePool中的變數release的時機。在正常情況下，建立的變數會在超出其作用域的時候release，但是如果將變數加入AutoreleasePool，那麼release將延遲執行。

AutoreleasePool建立和釋放

• App啟動後，蘋果在主執行緒 RunLoop 裡註冊了兩個 Observer，其回撥都是 _wrapRunLoopWithAutoreleasePoolHandler()。
• 第一個 Observer 監視的事件是 Entry(即將進入Loop)，其回撥內會呼叫 _objc_autoreleasePoolPush() 建立自動釋放池。其 order 是-2147483647，優先順序最高，保證建立釋放池發生在其他所有回撥之前。
• 第二個 Observer 監視了兩個事件： BeforeWaiting(準備進入休眠) 時呼叫_objc_autoreleasePoolPop() 和 _objc_autoreleasePoolPush() 釋放舊的池並建立新池；Exit(即將退出Loop) 時呼叫 _objc_autoreleasePoolPop() 來釋放自動釋放池。這個 Observer 的 order 是 2147483647，優先順序最低，保證其釋放池子發生在其他所有回撥之後。
• 在主執行緒執行的程式碼，通常是寫在諸如事件回撥、Timer回撥內的。這些回撥會被 RunLoop 建立好的 AutoreleasePool 環繞著，所以不會出現記憶體洩漏，開發者也不必顯示建立 Pool 了。

也就是說AutoreleasePool建立是在一個RunLoop事件開始之前(push)，AutoreleasePool釋放是在一個RunLoop事件即將結束之前(pop)。 AutoreleasePool裡的Autorelease物件的加入是在RunLoop事件中，AutoreleasePool裡的Autorelease物件的釋放是在AutoreleasePool釋放時。

AutoreleasePool實現原理

在終端中使用clang -rewrite-objc命令將下面的OC程式碼重寫成C++的實現：

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[]) {
    
    @autoreleasepool {
        NSLog(@"Hello, World!");
    }
 
    return 0;
}
複製程式碼

在cpp檔案程式碼中我們找到main函式程式碼如下：

int main(int argc, const char * argv[]) {

    /* @autoreleasepool */ { __AtAutoreleasePool __autoreleasepool; 
        NSLog((NSString *)&__NSConstantStringImpl__var_folders_kb_06b822gn59df4d1zt99361xw0000gn_T_main_d39a79_mi_0);
    }

    return 0;
}
複製程式碼

可以看到蘋果通過宣告一個__AtAutoreleasePool型別的區域性變數__autoreleasepool實現了@autoreleasepool{}。 __AtAutoreleasePool的定義如下:

extern "C" __declspec(dllimport) void * objc_autoreleasePoolPush(void);
extern "C" __declspec(dllimport) void objc_autoreleasePoolPop(void *);

struct __AtAutoreleasePool {
  __AtAutoreleasePool() {atautoreleasepoolobj = objc_autoreleasePoolPush();}
  ~__AtAutoreleasePool() {objc_autoreleasePoolPop(atautoreleasepoolobj);}
  void * atautoreleasepoolobj;
};
複製程式碼

根據建構函式和解構函式的特點（自動區域性變數的建構函式是在程式執行到宣告這個物件的位置時呼叫的，而對應的解構函式是在程式執行到離開這個物件的作用域時呼叫），我們可以將上面兩段程式碼簡化成如下形式：

int main(int argc, const char * argv[]) {

    /* @autoreleasepool */ {
        void *atautoreleasepoolobj = objc_autoreleasePoolPush();
        NSLog((NSString *)&__NSConstantStringImpl__var_folders_kb_06b822gn59df4d1zt99361xw0000gn_T_main_d39a79_mi_0);
        objc_autoreleasePoolPop(atautoreleasepoolobj);
    }

    return 0;
}
複製程式碼

至此，我們可以分析出，單個自動釋放池的執行過程就是objc_autoreleasePoolPush() —> [object autorelease] —> objc_autoreleasePoolPop(void *)。

來看一下objc_autoreleasePoolPush 和 objc_autoreleasePoolPop 的實現：

void *objc_autoreleasePoolPush(void) {
    return AutoreleasePoolPage::push();
}

void objc_autoreleasePoolPop(void *ctxt) {
    AutoreleasePoolPage::pop(ctxt);
}
複製程式碼

上面的方法看上去是對 AutoreleasePoolPage 對應靜態方法 push 和 pop 的封裝。 下面分析一下AutoreleasePoolPage的實現，揭開AutoreleasePool的實現原理。

AutoreleasePoolPage實現

AutoreleasePoolPage介紹

AutoreleasePoolPage 是一個 C++ 中的類，它在 NSObject.mm 中的定義是這樣的：

class AutoreleasePoolPage {
#   define EMPTY_POOL_PLACEHOLDER ((id*)1)

#   define POOL_BOUNDARY nil
    static pthread_key_t const key = AUTORELEASE_POOL_KEY;
    static uint8_t const SCRIBBLE = 0xA3;  // 0xA3A3A3A3 after releasing
    static size_t const SIZE = 
#if PROTECT_AUTORELEASEPOOL
        PAGE_MAX_SIZE;  // must be multiple of vm page size
#else
        PAGE_MAX_SIZE;  // size and alignment, power of 2
#endif
    static size_t const COUNT = SIZE / sizeof(id);

    magic_t const magic;
    id *next;
    pthread_t const thread;
    AutoreleasePoolPage * const parent;
    AutoreleasePoolPage *child;
    uint32_t const depth;
    uint32_t hiwat;
};
複製程式碼

• magic 檢查校驗完整性的變數
• next 指向新加入的autorelease物件
• thread page當前所在的執行緒，AutoreleasePool是按執行緒一一對應的（結構中的thread指標指向當前執行緒）
• parent 父節點 指向前一個page
• child 子節點 指向下一個page
• depth 連結串列的深度，節點個數
• hiwat high water mark 資料容納的一個上限
• EMPTY_POOL_PLACEHOLDER 空池佔位
• POOL_BOUNDARY 是一個邊界物件 nil,之前的原始碼變數名是 POOL_SENTINEL哨兵物件,用來區別每個page即每個 AutoreleasePoolPage 邊界
• PAGE_MAX_SIZE = 4096, 為什麼是4096呢？其實就是虛擬記憶體每個扇區4096個位元組,4K對齊的說法。
• COUNT 一個page裡物件數

雙向連結串列

AutoreleasePool並沒有單獨的結構，而是由若干個AutoreleasePoolPage以雙向連結串列的形式組合而成的棧結構（分別對應結構中的parent指標和child指標）

parent和child就是用來構造雙向連結串列的指標。parent指向前一個page, child指向下一個page。 一個AutoreleasePoolPage的空間被佔滿時，會新建一個AutoreleasePoolPage物件，連線連結串列，後來的autorelease物件在新的page加入。

objc_autoreleasePoolPush

每當自動釋放池呼叫objc_autoreleasePoolPush時都會把邊界物件放進棧頂,然後返回邊界物件,用於釋放。

atautoreleasepoolobj = objc_autoreleasePoolPush();
複製程式碼

atautoreleasepoolobj就是返回的邊界物件(POOL_BOUNDARY)

push實現如下：

void *objc_autoreleasePoolPush(void) {
    return AutoreleasePoolPage::push();
}
複製程式碼

它呼叫AutoreleasePoolPage的類方法push：

static inline void *push() {
   return autoreleaseFast(POOL_BOUNDARY);
}
複製程式碼

在這裡會進入一個比較關鍵的方法autoreleaseFast，並傳入邊界物件(POOL_BOUNDARY)：

static inline id *autoreleaseFast(id obj)
{
   AutoreleasePoolPage *page = hotPage();
   if (page && !page->full()) {
       return page->add(obj);
   } else if (page) {
       return autoreleaseFullPage(obj, page);
   } else {
       return autoreleaseNoPage(obj);
   }
}
複製程式碼

上述方法分三種情況選擇不同的程式碼執行：

• 有 hotPage 並且當前 page 不滿，呼叫 page->add(obj) 方法將物件新增至 AutoreleasePoolPage 的棧中
• 有 hotPage 並且當前 page 已滿，呼叫 autoreleaseFullPage 初始化一個新的頁，呼叫 page->add(obj) 方法將物件新增至 AutoreleasePoolPage 的棧中
• 無 hotPage，呼叫 autoreleaseNoPage 建立一個 hotPage，呼叫 page->add(obj) 方法將物件新增至 AutoreleasePoolPage 的棧中

最後的都會呼叫 page->add(obj) 將物件新增到自動釋放池中。 hotPage 可以理解為當前正在使用的 AutoreleasePoolPage。

AutoreleasePoolPage::autorelease(id obj)

autorelease方法的實現，先來看一下方法的呼叫棧：

- [NSObject autorelease]
└── id objc_object::rootAutorelease()
    └── id objc_object::rootAutorelease2()
        └── static id AutoreleasePoolPage::autorelease(id obj)
            └── static id AutoreleasePoolPage::autoreleaseFast(id obj)
                ├── id *add(id obj)
                ├── static id *autoreleaseFullPage(id obj, AutoreleasePoolPage *page)
                │   ├── AutoreleasePoolPage(AutoreleasePoolPage *newParent)
                │   └── id *add(id obj)
                └── static id *autoreleaseNoPage(id obj)
                    ├── AutoreleasePoolPage(AutoreleasePoolPage *newParent)
                    └── id *add(id obj)
複製程式碼

在autorelease方法的呼叫棧中，最終都會呼叫上面提到的 autoreleaseFast方法，將當前物件加到AutoreleasePoolPage 中。

這一小節中這些方法的實現都非常容易，只是進行了一些引數上的檢查，最終還要呼叫autoreleaseFast方法：

inline id objc_object::rootAutorelease() {
    if (isTaggedPointer()) return (id)this;
    if (prepareOptimizedReturn(ReturnAtPlus1)) return (id)this;

    return rootAutorelease2();
}

__attribute__((noinline,used)) id objc_object::rootAutorelease2() {
    return AutoreleasePoolPage::autorelease((id)this);
}

static inline id autorelease(id obj) {
   id *dest __unused = autoreleaseFast(obj);
   return obj;
}
複製程式碼

autorelease函式和push函式一樣，關鍵程式碼都是呼叫autoreleaseFast函式向自動釋放池的連結串列棧中新增一個物件， 不過push函式的入棧的是一個邊界物件，而autorelease函式入棧的是需要加入autoreleasepool的物件。

objc_autoreleasePoolPop

自動釋放池釋放是傳入 push 返回的邊界物件,

objc_autoreleasePoolPop(atautoreleasepoolobj);
複製程式碼

然後將邊界物件指向的這一頁 AutoreleasePoolPage 內的物件釋放 atautoreleasepoolobj就是返回的邊界物件(POOL_BOUNDARY)

AutoreleasePoolPage::pop()實現：

static inline void pop(void *token)   // token指標指向棧頂的地址
{
    AutoreleasePoolPage *page;
    id *stop;

    page = pageForPointer(token);   // 通過棧頂的地址找到對應的page
    stop = (id *)token;
    if (DebugPoolAllocation  &&  *stop != POOL_SENTINEL) {
        // This check is not valid with DebugPoolAllocation off
        // after an autorelease with a pool page but no pool in place.
        _objc_fatal("invalid or prematurely-freed autorelease pool %p; ", 
                    token);
    }

    if (PrintPoolHiwat) printHiwat();   // 記錄最高水位標記

    page->releaseUntil(stop);   // 從棧頂開始操作出棧，並向棧中的物件傳送release訊息，直到遇到第一個哨兵物件

    // memory: delete empty children
    // 刪除空掉的節點
    if (DebugPoolAllocation  &&  page->empty()) {
        // special case: delete everything during page-per-pool debugging
        AutoreleasePoolPage *parent = page->parent;
        page->kill();
        setHotPage(parent);
    } else if (DebugMissingPools  &&  page->empty()  &&  !page->parent) {
        // special case: delete everything for pop(top) 
        // when debugging missing autorelease pools
        page->kill();
        setHotPage(nil);
    } 
    else if (page->child) {
        // hysteresis: keep one empty child if page is more than half full
        if (page->lessThanHalfFull()) {
            page->child->kill();
        }
        else if (page->child->child) {
            page->child->child->kill();
        }
    }
}
複製程式碼

該過程主要分為兩步：

• page->releaseUntil(stop)，對棧頂（page->next）到stop地址（POOL_SENTINEL）之間的所有物件呼叫objc_release()，進行引用計數減1
• 清空page物件page->kill()，有兩句註釋

// hysteresis: keep one empty child if this page is more than half full

// special case: delete everything for pop(0)
除非是pop(0)方式呼叫，這樣會清理掉所有page物件；
否則，在當前page存放的物件大於一半時，會保留一個空的子page，
這樣估計是為了可能馬上需要新建page節省建立page的開銷。
複製程式碼

小結

• 自動釋放池是一個個 AutoreleasePoolPage 組成的一個page是4096位元組大小,每個 AutoreleasePoolPage 以雙向連結串列連線起來形成一個自動釋放池
• 當物件呼叫 autorelease 方法時，會將物件加入 AutoreleasePoolPage 的棧中
• pop 時是傳入邊界物件,然後對page 中的物件傳送release 的訊息