runtime 之CFRunloop 之部件结构和组织关系

今天看了好多runloop的博客，感觉所有的博客对runloop的结构描述都是很概况，因此决定写篇博客将runloop的组织关系详细罗列下。

CFRunloop 的组织结构

CFRunloop的大概结构如下

runloop

接下来我们一次分析这几种结构

CFRunloop 结构体

struct __CFRunLoop {
    CFRuntimeBase _base;
    pthread_mutex_t _lock;          /* locked for accessing mode list */
    __CFPort _wakeUpPort;           // used for CFRunLoopWakeUp 
    Boolean _unused;
    volatile _per_run_data *_perRunData;              // reset for runs of the run loop
    pthread_t _pthread;
    uint32_t _winthread;
    CFMutableSetRef _commonModes;
    CFMutableSetRef _commonModeItems;
    CFRunLoopModeRef _currentMode;
    CFMutableSetRef _modes;
    struct _block_item *_blocks_head;
    struct _block_item *_blocks_tail;
    CFAbsoluteTime _runTime;
    CFAbsoluteTime _sleepTime;
    CFTypeRef _counterpart;
};

接下来我们依次介绍__CFRunLoop的每一个成员变量。

CFRuntimeBase _base; 这里就理解为继承的父类base吧。
pthread_mutex_t _lock; 每个runloop在创建的时候都要对应一把锁
__CFPort _wakeUpPort;唤醒的端口号，初始化的时候线程已经分配好了端口号，用来线程之间通信用的。
Boolean _unused;
volatile _per_run_data *_perRunData; 数据
pthread_t _pthread; 每个runloop 都有一个专门的线程。作为全局dictionary的key。value 就是runloop
uint32_t _winthread; windows的线程（不管）

CFMutableSetRef _commonModes; 存放runloop中所有的mode name
CFMutableSetRef _commonModeItems; 存放所有的mode 共享的source ，timer ，observer

CFRunLoopModeRef _currentMode; 当前runloop 执行的mode
CFMutableSetRef _modes; runloop中添加的所有mode
struct _block_item *_blocks_head; 当我们调用CFRunLoopPerformBlock 函数的时候，这个blocks_heads 会被赋值。是个双向链表结构，在进入runloop 休眠之前就执行了。不影响runloop 的执行顺序。
struct _block_item *_blocks_tail; 只是个执行的block的链表的尾部而已。
CFAbsoluteTime _runTime; 这个暂时没有作用。没地方使用
CFAbsoluteTime _sleepTime; 这个是runloop的睡眠时间。
CFTypeRef _counterpart; 暂时没看出有啥用

这里我们还需要知道 几种模式。

kCFRunLoopDefaultMode
kCFRunLoopCommonModes

kCFRunLoopDefaultMode 每个runloop在初始化的时候都有这个模式。

kCFRunLoopCommonModes 我们经常用计时器，为了让用户在操作界面的时候计时器也是不停止的时候我们就用这个模式。

这个结构体我们主要弄明白_commonModes 和_commonModeItems的作用，如何和kCFRunLoopCommonModes 模式配合使用的

我们知道runloop 有好多mode，主线程中有kCFRunLoopDefaultMode，UITrackingRunLoopMode，GSEventReceiveRunLoopMode。其实我们也可以给主线程自定义一个我们自己的mode。

///这里我们就自定义了一个**mainCustomMode** ，只是这个mode没啥用，只用来举例。
    NSRunLoop * runLoop = [NSRunLoop currentRunLoop];
    //    runLoo
    CFRunLoopRef cfrl =[runLoop getCFRunLoop];
    CFRunLoopAddCommonMode(cfrl, (CFStringRef)@"mainCustomMode");
    CFArrayRef arry= CFRunLoopCopyAllModes(cfrl);
    NSLog(@"%@",arry);

2018-05-02 10:35:27.673364+0800 NSRunloopTest[44092:166591] (
    mainCustomMode,
    UITrackingRunLoopMode,
    GSEventReceiveRunLoopMode,
    kCFRunLoopDefaultMode,
    kCFRunLoopCommonModes
)

这个_commonModes 存放的所有的我们自定义的mode。
而_commonModeItems 存放的是mode中的timer，observer,source。 提供给_commonModes 中所有的mode使用相当于一个所有的commonMode的共享缓存。

image.png

这里还有个kCFRunLoopCommonModes 模式，这个是个组合模式。当我们用这个模式添加timer source，observer的时候，我们其实是把timer，source，observer添加到了 commonModesItems这个数组里（共享缓存池）。当我们runloop控制的mode是commonMode数组中的元素的时候，runloop 就会把commonModesItems 这个数组里面的timer ，source，observer都给执行一遍。

__CFRunLoopMode 结构体

struct __CFRunLoopMode {
    CFRuntimeBase _base;
    pthread_mutex_t _lock;  /* must have the run loop locked before locking this */
    CFStringRef _name;
    Boolean _stopped;
    char _padding[3];
    CFMutableSetRef _sources0;
    CFMutableSetRef _sources1;
    CFMutableArrayRef _observers;
    CFMutableArrayRef _timers;
    CFMutableDictionaryRef _portToV1SourceMap;
    __CFPortSet _portSet;
    CFIndex _observerMask;
#if USE_DISPATCH_SOURCE_FOR_TIMERS
    dispatch_source_t _timerSource;
    dispatch_queue_t _queue;
    Boolean _timerFired; // set to true by the source when a timer has fired
    Boolean _dispatchTimerArmed;
#endif
#if USE_MK_TIMER_TOO
    mach_port_t _timerPort;
    Boolean _mkTimerArmed;
#endif
#if DEPLOYMENT_TARGET_WINDOWS
    DWORD _msgQMask;
    void (*_msgPump)(void);
#endif
    uint64_t _timerSoftDeadline; /* TSR */
    uint64_t _timerHardDeadline; /* TSR */
};

这个结构体很明确。

pthread_mutex_t _lock; 每个mode 都有锁一把
CFStringRef _name; mode的名字
Boolean _stopped; 标记是否mode 停止。
CFMutableSetRef _sources0; source 0 这里是个set集合
CFMutableSetRef _sources1; 这个是source1 set集合
CFMutableArrayRef _observers; observers 是个数组array
CFMutableArrayRef _timers; 计时器。
CFMutableDictionaryRef _portToV1SourceMap 这个也是很关键的，将source1 的port 和source 绑定
__CFPortSet _portSet; 该mode 监听的port 集合
CFIndex _observerMask; 该mode所有观察者观察的CFRunLoopActivity结构体 的集合

__CFRunLoopSource

struct __CFRunLoopSource {
    CFRuntimeBase _base;
    uint32_t _bits;
    pthread_mutex_t _lock;
    CFIndex _order;         /* immutable */
    CFMutableBagRef _runLoops;
    union {
    CFRunLoopSourceContext version0;    /* immutable, except invalidation */
        CFRunLoopSourceContext1 version1;   /* immutable, except invalidation */
    } _context;
};

CFMutableBagRef _runLoops; 可以理解为集合吧。装有与之关联的runloop。
CFIndex _order; 排序用的。

typedef struct {
    CFIndex version;
    void *  info;
    const void *(*retain)(const void *info);
    void    (*release)(const void *info);
    CFStringRef (*copyDescription)(const void *info);
    Boolean (*equal)(const void *info1, const void *info2);
    CFHashCode  (*hash)(const void *info);
    void    (*schedule)(void *info, CFRunLoopRef rl, CFRunLoopMode mode);
    void    (*cancel)(void *info, CFRunLoopRef rl, CFRunLoopMode mode);
    void    (*perform)(void *info);
} CFRunLoopSourceContext;

这是source0 的context

typedef struct {
    CFIndex version;
    void *  info;
    const void *(*retain)(const void *info);
    void    (*release)(const void *info);
    CFStringRef (*copyDescription)(const void *info);
    Boolean (*equal)(const void *info1, const void *info2);
    CFHashCode  (*hash)(const void *info);
#if (TARGET_OS_MAC && !(TARGET_OS_EMBEDDED || TARGET_OS_IPHONE)) || (TARGET_OS_EMBEDDED || TARGET_OS_IPHONE)
    mach_port_t (*getPort)(void *info);
    void *  (*perform)(void *msg, CFIndex size, CFAllocatorRef allocator, void *info);
#else
    void *  (*getPort)(void *info);
    void    (*perform)(void *info);
#endif
} CFRunLoopSourceContext1;

这是source1的结构体
发现source1 比source0 多了有个getport .这个是用来获取监听的port
void (*perform)(void *info); 相当于函数回调吧。

这里需要注意的是，source0 在runloop执行循环的时候就执行了。而source1 是需要等port 监听到消息来的时候再出发。

-(void)testSource1AndSource2{
    
        NSThread* aThread = [[NSThread alloc] initWithTarget:self selector:@selector(sourceOneAndSourceTwo) object:nil];
        self.aThread = aThread;
        [aThread start];
}

-(void)sourceOneAndSourceTwo{
    NSRunLoop * runLoop = [NSRunLoop currentRunLoop];
    //    runLoo
    CFRunLoopRef cfrl =[runLoop getCFRunLoop];
    CFRunLoopAddCommonMode(cfrl, (CFStringRef)@"mainCustomMode");
    void * str = @"testSourceZero";
    
    CFRunLoopSourceContext context = {0, str, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL};
    
    context.info = str;
    context.perform = performSource0;
   CFRunLoopSourceRef source= CFRunLoopSourceCreate(NULL, 0, &context);
    CFRunLoopAddSource(CFRunLoopGetCurrent(), source, (CFStringRef)@"mainCustomMode");
    CFRunLoopSourceSignal(source);
    CFRunLoopRunInMode((CFStringRef)@"mainCustomMode", 10000, false);
}

void performSource0(void *info){
    NSLog(@"source0 %@",info);
};

2018-05-02 18:58:07.386692+0800 NSRunloopTest[81628:820098] source0 testSourceZero

这里我们创建了source0 并且使其有效。
我们发现直接就执行了source0 信号。不依赖端口号

source1 是依赖port的，从port1 唤醒runloop。

__CFRunLoopObserver

struct __CFRunLoopObserver {
    CFRuntimeBase _base;
    pthread_mutex_t _lock;
    CFRunLoopRef _runLoop;
    CFIndex _rlCount;
    CFOptionFlags _activities;      /* immutable */
    CFIndex _order;         /* immutable */
    CFRunLoopObserverCallBack _callout; /* immutable */
    CFRunLoopObserverContext _context;  /* immutable, except invalidation */
};

CFOptionFlags _activities 我们需要观察的类型
CFIndex _order; 标记在runloop中执行的顺序
CFRunLoopObserverCallBack _callout 回调
CFIndex _rlCount; 观察的runloop 数量
CFRunLoopObserverContext _context; 记录observer的一些信息

typedef struct {
    CFIndex version;
    void *  info;
    const void *(*retain)(const void *info);
    void    (*release)(const void *info);
    CFStringRef (*copyDescription)(const void *info);
} CFRunLoopObserverContext;

__CFRunLoopTimer

struct __CFRunLoopTimer {
    CFRuntimeBase _base;
    uint16_t _bits;
    pthread_mutex_t _lock;
    CFRunLoopRef _runLoop;
    CFMutableSetRef _rlModes;
    CFAbsoluteTime _nextFireDate;
    CFTimeInterval _interval;       /* immutable */
    CFTimeInterval _tolerance;          /* mutable */
    uint64_t _fireTSR;          /* TSR units */
    CFIndex _order;         /* immutable */
    CFRunLoopTimerCallBack _callout;    /* immutable */
    CFRunLoopTimerContext _context; /* immutable, except invalidation */
};

CFRunLoopRef _runLoop; 当前runloop
CFMutableSetRef _rlModes; timer 所在的runloop
CFTimeInterval _tolerance; 两次执行的误差范围
CFAbsoluteTime _nextFireDate; 记录下一次开火时间
uint64_t _fireTSR; 记录下一次开火的具体TSR 时间
CFTimeInterval _interval; 时间间隔
CFRunLoopTimerCallBack _callout; 回调函数
CFRunLoopTimerContext _context; 记录timer的信息

typedef struct {
   CFIndex version;
   void *  info;
   const void *(*retain)(const void *info);
   void    (*release)(const void *info);
   CFStringRef (*copyDescription)(const void *info);
} CFRunLoopTimerContext;

yykit
runloop
runloop