objective-C-AutoReleasePool底层实现

1、首先我们先写个段最简单的代码

https://opensource.apple.com/tarballs/objc4/

main.m
int main(int argc, const char * argv[]) {
    
    @autoreleasepool {
        for (int i=0; i<10; i++) {
            @autoreleasepool {
                NSString *str = [NSString stringWithFormat:@"%@",@"test"];
                NSLog(@"%@",str);
            }
        }
        
    }
    return 0;
}

这里我们有2个autoreleasepool嵌套

2、在命令行使用 clang -rewrite-objc main.m 命令把OC代码转成c++代码

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

    /* @autoreleasepool */ { __AtAutoreleasePool __autoreleasepool; 
        for (int i=0; i<10; i++) {
            /* @autoreleasepool */ { __AtAutoreleasePool __autoreleasepool; 
                NSString *str = ((NSString * _Nonnull (*)(id, SEL, NSString * _Nonnull, ...))(void *)objc_msgSend)((id)objc_getClass("NSString"), sel_registerName("stringWithFormat:"), (NSString *)&__NSConstantStringImpl__var_folders_j3_vbzlcc353pb72wr4jq14tq180000gn_T_main_b4d708_mi_0, (NSString *)&__NSConstantStringImpl__var_folders_j3_vbzlcc353pb72wr4jq14tq180000gn_T_main_b4d708_mi_1);
                NSLog((NSString *)&__NSConstantStringImpl__var_folders_j3_vbzlcc353pb72wr4jq14tq180000gn_T_main_b4d708_mi_2,str);
            }
        }

    }
    return 0;
}

这里我们可以看到 @autoreleasepool 转成了 __AtAutoreleasePool __autoreleasepool;

??? 定义个__AtAutoreleasePool变量就可以实现autoreleasepool

3、我们再来看看__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;
};

看到这里终于明白了，这里定义struct __AtAutoreleasePool变量的时候构造函数里会调用objc_autoreleasePoolPush函数，离开有效区域时变量被释放析构函数里调用了objc_autoreleasePoolPop，所有这里相当于转换成了

int main(int argc, const char * argv[]) {
    
    {
        __AtAutoreleasePool __pool1; 
        __pool1.atautoreleasepoolobj = objc_autoreleasePoolPush();
        for (int i=0; i<10; i++) {
            {
                __AtAutoreleasePool __pool2; 
                __pool2.atautoreleasepoolobj = objc_autoreleasePoolPush();
                NSString *str = [NSString stringWithFormat:@"%@",@"test"];
                NSLog(@"%@",str);
                objc_autoreleasePoolPop(__pool2.atautoreleasepoolobj);   
            }
        }
    
        objc_autoreleasePoolPop(__pool1.atautoreleasepoolobj);    
    }
    return 0;
}

现在我们明白了，这里push/pop使用了一个堆栈结构

4、objc_autoreleasePoolPush/objc_autoreleasePoolPop做了什么呢，我们来看看苹果开源的objc源码

//  objc/source/NSObject.mm
void *
objc_autoreleasePoolPush(void)
{
    if (UseGC) return nil;
    return AutoreleasePoolPage::push();
}

void
objc_autoreleasePoolPop(void *ctxt)
{
    if (UseGC) return;

    // fixme rdar://9167170
    if (!ctxt) return;

    AutoreleasePoolPage::pop(ctxt);
}

这里这对方法调用了AutoreleasePoolPage类的静态方法push/pop，我们先来看看push都做了什么

static inline void *push() 
    {
        //这里push就调用了AutoreleasePoolPage的autoreleaseFast成员，
        //并传递了一个POOL_SENTINEL（#define POOL_SENTINEL nil）
        //这里可以看字面意思传递的是个值为nil的哨兵，也就是一个哨兵记录着栈里保存了一个新的分段
        //从下面的函数中可以看出返回值是POOL_SENTINEL在栈中的地址，
        //用于pop的时候把push和pop之前添加的autorelease成员全部清理掉
        id *dest = autoreleaseFast(POOL_SENTINEL);
        
        assert(*dest == POOL_SENTINEL);
        return dest;
    }

static inline id *autoreleaseFast(id obj)
    {
        //hotPage调用tls_get_direct()方法获取当前激活的AutoreleasePoolPage
        //这里每个线程的所有autorelease变量全部存储在AutoreleasePoolPage的双链表中，
        //第一次添加autorelease变量时先创建一个AutoreleasePoolPage，
        //一个AutoreleasePoolPage使用SIZE个字节，
        //重写new申请的时候使用malloc_zone_memalign(malloc_default_zone(), SIZE, SIZE);按照SIZE对齐刚好是申请了一个内存分页
        AutoreleasePoolPage *page = hotPage();

        //判断当前激活AutoreleasePoolPage存在并且没满
        if (page && !page->full()) {
            //直接在当前分页中添加一个autorelease对象
            return page->add(obj);
        } else if (page) {//如果当前分页存在并且满了
            //创建一个新的分页设为激活并添加autorelease对象
            return autoreleaseFullPage(obj, page);
        } else {//如果当前没有激活的分页
            //创建分页设为激活并且添加autorelease对象
            return autoreleaseNoPage(obj);
        }
    }

这类总结下push的时候我们获取当前激活的AutoreleasePoolPage分页，当前激活的不存在或满了就新申请个AutoreleasePoolPage分页，并且将当前分页设置为激活状态，再把POOL_SENTINEL当做哨兵push到栈顶，

下面我们再来看看AutoreleasePoolPage的pop方法做了什么

//这里的token就是push对应的POOL_SENTINEL哨兵返回的内存地址
static inline void pop(void *token) 
    {
        AutoreleasePoolPage *page;
        id *stop;

        if (token) {
            //1、根据上个哨兵内存地址找出哨兵所在的AutoreleasePoolPage
            page = pageForPointer(token);
            //标记哨兵所在位置
            stop = (id *)token;
            assert(*stop == POOL_SENTINEL);
        } else {
            //2、如果token不存在，直接找到链表第一个AutoreleasePoolPage
            page = coldPage();
            assert(page);
            //标记第一个页的栈底位置
            stop = page->begin();
        }

        if (PrintPoolHiwat) printHiwat();

        //3、链表从后向前，把堆栈中从记录的哨兵位置到链表最后一个页，也就是激活页的栈顶分别用objc_release(obj)释放
        page->releaseUntil(stop);
    }

5、总结下

①一个线程的autoreleasepool存储结构是由AutoreleasePoolPage组成的双向链表
②早起版本每个AutoreleasePoolPage是一个内存分页，包含成员和一个stack

static size_t const SIZE =
#if PROTECT_AUTORELEASEPOOL
        PAGE_MAX_SIZE;  // must be multiple of vm page size
#else
        PAGE_MIN_SIZE;  // size and alignment, power of 2
#endif

③链表的所有AutoreleasePoolPage的stack加起来其实就是一个总的stack，分页是为了优化内存
④每次push在stack中添加一个值为nil的哨兵，并返回这个哨兵所在位置
⑤每次pop从stack栈顶开始一个一个把栈顶元素弹出并调用objc_release(obj)释放，直到遇到传入的哨兵才停止
⑥autoreleasepool嵌套使用stack实现