RunLoop

·  阅读 1008

什么是runLoop

runloop顾名思义就是”跑圈“,所谓跑圈就给人一种循环的感觉。runloop运行的核心代码就是一个有状态的do...while循环。每循环一次就相当于跑了一圈,线程就会对当前这一圈里面产生的事件进行处理。那么为什么线程要有runloop呢?其实我们的APP可以理解为是靠event驱动的(包括iOS和Android应用)。我们触摸屏幕、网络回调等都是一个个的event,也就是事件。这些事件产生之后会分发给我们的APP,APP接收到事件之后分发给对应的线程。通常情况下,如果线程没有runloop,那么一个线程一次只能执行一个任务,执行完成后线程就会退出。要想APP的线程一直能够处理事件或者等待事件(比如异步事件),就要保活线程,也就是不能让线程早早的退出,此时runloop就派上用场了。我们已经说了,runloop本质上就是一个有状态的do...while循环,所以只要不是超时或者故意退出状态,那么runLoop就会一直执行do...while,所以可以保证线程不退出。其实也不是必须要给线程指定一个runloop,如果需要我们线程能够持续的处理事件,那么就需要给线程绑定一个runloop。也就是说,runloop能够保证线程一直可以一直处理事件。所以runloop的作用可以理解为:

使程序一直运行并处理各种事件。这些事件包括但不限于用户操作、定时器任务、内核消息 有顺序的处理各种Event。因为runLoop有状态,可以决定线程在什么时候处理什么事件 节省CPU资源。通常情况下,事件并不是永无休止的产生,所以也就没必要让线程永无休止的运行。runloop可以在无事件处理时进入休眠状态,避免无休止的do...while跑空圈。 不得不重复那句老生常谈的话:一个线程对应一个RunLoop,程序运行是主线程的RunLoop默认启动,子线程的RunLoop按需启动(调用run方法)。runloop是线程的事件管理者,或者说是线程的事件管家,他会按照顺序管理线程要处理的事件,决定哪些事件在什么时候提交给主线程处理。

无处不在的runLoop

如下,笔者在touchesBegan:withEvent:中打断点,然后查看函数调用栈。其中,红框中的部分是runloop相关的函数。不难发现,整个调用栈可以分为4个部分。自下而上依次为:

1.加载dyld动态库以及dyld加载其他动态库

2.执行main函数

3.runloop处理source,此处是source0

4.UIKit收到source0后处理touch事件

wusz6hfysf.png

上图中,调用栈中有一个很长的函数——CFRUNLOOP_IS_CALLING_OUT_TO_A_SOURCE0_PERFORM_FUNCTION。其实,所有线程的几乎所有的函数都是从以下6个函数调起的:

__CFRUNLOOP_IS_CALLING_OUT_TO_AN_OBSERVER_CALLBACK_FUNCTION__	// 回调observer的callback指针,通知runloop的activity状态变化
__CFRUNLOOP_IS_CALLING_OUT_TO_A_BLOCK__												// 处理添加到runloop的block
__CFRUNLOOP_IS_SERVICING_THE_MAIN_DISPATCH_QUEUE__						// 处理分发给主线程的事件
__CFRUNLOOP_IS_CALLING_OUT_TO_A_TIMER_CALLBACK_FUNCTION__			// 处理timer回调
__CFRUNLOOP_IS_CALLING_OUT_TO_A_SOURCE0_PERFORM_FUNCTION__		// 处理source0回调
__CFRUNLOOP_IS_CALLING_OUT_TO_A_SOURCE1_PERFORM_FUNCTION__		// 处理source1回调
复制代码

这6个函数名字之所以如此之长,也只是为了实现自解释。通过查看名字我们可以看出这几个函数都是calling_out的,也就是都是向外回调的函数。所谓的向外是相对于runloop的,其实就是runLoop向上层回调,通过回调函数runloop可以通知上层runloop当前处于什么状态或正在处理什么事件。具体的每个函数的作用会在下文详细解释,不必在此纠结。

runLoop 结构

runLoop的结构如下图所示:

eicfj7xvyp.png

通过上图可以看出:

  • 一个thread对应一个runloop
  • Cocoa层的NSRunLoop是对CF层的CFRunLoop的封装
  • 一个runloop对应多个runLoopMode
  • 一个runloop一次只能执行一个runLoopMode,runloop在同一个时间只能且必须在一种特定mode下run。要想切换runLoopMode需要停止并退出当前runLoopMode重新进入新的runLoopMode。
  • 一次执行一个mode的好处在于,底层设计相对简单,避免不同的mode耦合在一起,代码相互影响
  • 另一个好处是这样可以在不同的mode下执行不同的代码,避免上层业务代码相互影响。
  • 多个mode以及mode的切换是iOS app滑动顺畅的关键。
  • 主线程中不同的代码指定在不同的mode下运行可以提高app的流畅度。
  • 每个runLoopMode包括若干个runLoopSource、若干个runLoopTimer、若干个runLoopObserver。

RunLoop结构体定义

// RunLoop的结构体定义

struct __CFRunLoop {
    pthread_mutex_t _lock;	//访问mode集合时用到的锁
    __CFPort _wakeUpPort;  //手动唤醒runloop的端口。初始化runloop时设置,仅用于CFRunLoopWakeUp,CFRunLoopWakeUp函数会向_wakeUpPort发送一条消息
    pthread_t _pthread;	//对应的线程
    CFMutableSetRef _commonModes;  //集合,存储的是字符串,记录所有标记为common的modeName
    CFMutableSetRef _commonModeItems;	// 存储所有commonMode的sources、timers、observers
    CFRunLoopModeRef _currentMode;	// 当前modeName
    CFMutableSetRef _modes;	// 集合,存储的是CFRunLoopModeRef
    struct _block_item *_blocks_head; // 链表头指针,该链表保存了所有需要被runloop执行的block。外部通过调用CFRunLoopPerformBlock函数来向链表中添加一个block节点。runloop会在CFRunLoopDoBlock时遍历该链表,逐一执行block
    struct _block_item *_blocks_tail; // 链表尾指针,之所以有尾指针,是为了降低增加block时的时间复杂度
};
复制代码

RunLoop提供的主要API 以下API主要包括获取runloop相关函数、runloop运行相关函数、操作source\timer\observer相关函数

// 获取RunLoop
CF_EXPORT CFRunLoopRef CFRunLoopGetCurrent(void);
CF_EXPORT CFRunLoopRef CFRunLoopGetMain(void);

// 添加commonMode
CF_EXPORT void CFRunLoopAddCommonMode(CFRunLoopRef rl, CFStringRef mode);

// runloop运行相关
CF_EXPORT void CFRunLoopRun(void);
CF_EXPORT SInt32 CFRunLoopRunInMode(CFStringRef mode, CFTimeInterval seconds, Boolean returnAfterSourceHandled);
CF_EXPORT Boolean CFRunLoopIsWaiting(CFRunLoopRef rl);
CF_EXPORT void CFRunLoopWakeUp(CFRunLoopRef rl);
CF_EXPORT void CFRunLoopStop(CFRunLoopRef rl);

// source相关操作
CF_EXPORT Boolean CFRunLoopContainsSource(CFRunLoopRef rl, CFRunLoopSourceRef source, CFStringRef mode);
CF_EXPORT void CFRunLoopAddSource(CFRunLoopRef rl, CFRunLoopSourceRef source, CFStringRef mode);
CF_EXPORT void CFRunLoopRemoveSource(CFRunLoopRef rl, CFRunLoopSourceRef source, CFStringRef mode);
CF_EXPORT CFRunLoopSourceRef CFRunLoopSourceCreate(CFAllocatorRef allocator, CFIndex order, CFRunLoopSourceContext *context);
CF_EXPORT void CFRunLoopSourceSignal(CFRunLoopSourceRef source);

// observer相关操作
CF_EXPORT Boolean CFRunLoopContainsObserver(CFRunLoopRef rl, CFRunLoopObserverRef observer, CFStringRef mode);
CF_EXPORT void CFRunLoopAddObserver(CFRunLoopRef rl, CFRunLoopObserverRef observer, CFStringRef mode);
CF_EXPORT void CFRunLoopRemoveObserver(CFRunLoopRef rl, CFRunLoopObserverRef observer, CFStringRef mode);
CF_EXPORT CFRunLoopObserverRef CFRunLoopObserverCreate(CFAllocatorRef allocator, CFOptionFlags activities, Boolean repeats, CFIndex order, CFRunLoopObserverCallBack callout, CFRunLoopObserverContext *context);
CF_EXPORT CFRunLoopObserverRef CFRunLoopObserverCreateWithHandler(CFAllocatorRef allocator, CFOptionFlags activities, Boolean repeats, CFIndex order, void (^block) (CFRunLoopObserverRef observer, CFRunLoopActivity activity)) CF_AVAILABLE(10_7, 5_0);

// timer相关操作
CF_EXPORT Boolean CFRunLoopContainsTimer(CFRunLoopRef rl, CFRunLoopTimerRef timer, CFStringRef mode);
CF_EXPORT void CFRunLoopAddTimer(CFRunLoopRef rl, CFRunLoopTimerRef timer, CFStringRef mode);
CF_EXPORT void CFRunLoopRemoveTimer(CFRunLoopRef rl, CFRunLoopTimerRef timer, CFStringRef mode);
CF_EXPORT CFRunLoopTimerRef CFRunLoopTimerCreate(CFAllocatorRef allocator, CFAbsoluteTime fireDate, CFTimeInterval interval, CFOptionFlags flags, CFIndex order, CFRunLoopTimerCallBack callout, CFRunLoopTimerContext *context);
CF_EXPORT CFRunLoopTimerRef CFRunLoopTimerCreateWithHandler(CFAllocatorRef allocator, CFAbsoluteTime fireDate, CFTimeInterval interval, CFOptionFlags flags, CFIndex order, void (^block) (CFRunLoopTimerRef timer)) CF_AVAILABLE(10_7, 5_0);

/* 让runloop执行某个block
 * 本质上是把block插入到一个由runloop维护的block对象组成的链表中,在runloop运行中取出链表里被指定在当前mode下运行的block,逐一执行。
 */
CF_EXPORT void CFRunLoopPerformBlock(CFRunLoopRef rl, CFTypeRef mode, void (^block)(void)) CF_AVAILABLE(10_6, 4_0); 
复制代码

RunLoop与线程关系

以下是获取主线程runloop和子线程runloop的函数。可以看出,这两个函数内部都调用了_CFRunLoopGet0(),CFRunLoopGet0()的入参是线程。

另外,获取子线程的runloop传入的是pthread_self()函数获取到的当前线程。所以这里可以看出,CFRunLoopGetCurrent函数必须要在线程内部调用,才能获取当前线程的RunLoop。也就是说子线程的RunLoop必须要在子线程内部获取。而主线程却没有这个限制,但是一般场景下也没有在子线程获取主线程runloop的必要。

获取主线程的runloop

CFRunLoopRef CFRunLoopGetMain(void) {
    CHECK_FOR_FORK();
    static CFRunLoopRef __main = NULL; // no retain needed
    // 入参是主线程获取runloop
    if (!__main) __main = _CFRunLoopGet0(pthread_main_thread_np()); // no CAS needed
    return __main;
}
复制代码

获取子线程的runloop

CFRunLoopRef CFRunLoopGetCurrent(void) {
    CHECK_FOR_FORK();
    CFRunLoopRef rl = (CFRunLoopRef)_CFGetTSD(__CFTSDKeyRunLoop);
    if (rl) return rl;
    // 传入当前线程获取runloop
    return _CFRunLoopGet0(pthread_self());
}
复制代码

_CFRunLoopGet0()函数源码

// 获取线程对应的runloop最终调用的核心函数
// should only be called by Foundation
// t==0 is a synonym for "main thread" that always works
CF_EXPORT CFRunLoopRef _CFRunLoopGet0(pthread_t t) {
	// 线程t为空则默认返回主线程runloop
    if (pthread_equal(t, kNilPthreadT)) {
	t = pthread_main_thread_np();
    }
    __CFLock(&loopsLock);
    if (!__CFRunLoops) {
        __CFUnlock(&loopsLock);
        // 创建一个用于映射线程和runloop关系的字典
	CFMutableDictionaryRef dict = CFDictionaryCreateMutable(kCFAllocatorSystemDefault, 0, NULL, &kCFTypeDictionaryValueCallBacks);
	// 主线程runloop
	CFRunLoopRef mainLoop = __CFRunLoopCreate(pthread_main_thread_np());
	// 保存main runloop,main_thread为key,main runloop为value
	CFDictionarySetValue(dict, pthreadPointer(pthread_main_thread_np()), mainLoop);
	if (!OSAtomicCompareAndSwapPtrBarrier(NULL, dict, (void * volatile *)&__CFRunLoops)) {
	    CFRelease(dict);
	}
	CFRelease(mainLoop);
        __CFLock(&loopsLock);
    }
    // 根据线程去字典中获取缓存的runloop
    CFRunLoopRef loop = (CFRunLoopRef)CFDictionaryGetValue(__CFRunLoops, pthreadPointer(t));
    __CFUnlock(&loopsLock);
    // 未查找到缓存则创建一个runloop兵缓存在字典中
    if (!loop) {
	CFRunLoopRef newLoop = __CFRunLoopCreate(t);
        __CFLock(&loopsLock);
	loop = (CFRunLoopRef)CFDictionaryGetValue(__CFRunLoops, pthreadPointer(t));
	if (!loop) {
	    CFDictionarySetValue(__CFRunLoops, pthreadPointer(t), newLoop);
	    loop = newLoop;
	}
        // don't release run loops inside the loopsLock, because CFRunLoopDeallocate may end up taking it
        __CFUnlock(&loopsLock);
	CFRelease(newLoop);
    }
    if (pthread_equal(t, pthread_self())) {
        _CFSetTSD(__CFTSDKeyRunLoop, (void *)loop, NULL);
        if (0 == _CFGetTSD(__CFTSDKeyRunLoopCntr)) {
        	// 注册一个回调,当线程销毁时,销毁对应的RunLoop
            _CFSetTSD(__CFTSDKeyRunLoopCntr, (void *)(PTHREAD_DESTRUCTOR_ITERATIONS-1), (void (*)(void *))__CFFinalizeRunLoop);
        }
    }
    return loop;
}
复制代码

通过阅读上面这段代码可以看出:

  • RunLoop和线程的一一对应的,对应的方式是以key-value的方式保存在一个全局字典中
  • 主线程的RunLoop会在初始化全局字典时创建
  • 子线程的RunLoop会在第一次获取的时候创建,如果不获取的话就一直不会被创建
  • RunLoop会在线程销毁时销毁

CFRunLoopMode

mode作为runloop和source\timer\observer之间的桥梁。应用在启动时main runloop会注册5个mode。分别如下:

  1. kCFRunLoopDefaultMode: App的默认 Mode,通常主线程是在这个 Mode 下运行的。
  2. UITrackingRunLoopMode: 界面跟踪 Mode,用于 ScrollView 追踪触摸滑动,保证界面滑动时不受其他 Mode 影响。
  3. UIInitializationRunLoopMode: 在刚启动 App 时第进入的第一个 Mode,启动完成后就不再使用。
  4. GSEventReceiveRunLoopMode: 接受系统事件的内部 Mode,通常用不到。
  5. kCFRunLoopCommonModes: 这是一个占位的 Mode,没有实际作用。 你可以在这里看到更多的苹果内部的 Mode,但那些 Mode 在开发中就很难遇到了。

接下来是老生常谈的一段话:一个 RunLoop 包含若干个 Mode,每个 Mode 又可以包含若干个 Source/Timer/Observer。每次调用 RunLoop 的主函数时,只能指定其中一个 Mode,这个Mode就是runloop的 CurrentMode。如果需要切换 Mode,只能退出 Loop,再重新指定一个 Mode 进入。这样做主要是为了分隔开不同组的 Source/Timer/Observer,让其互不影响。

mode中有一个特殊的mode叫做commonMode。commonMode并不是一个真正的mode,而是若干个被标记为commonMode的普通mode。所以commonMode本质上是一个集合,该集合存储的是mode的名字,也就是字符串,记录所有被标记为common的modeName。当我们向commonMode添加source\timer\observer时,本质上是遍历这个集合中的所有的mode,把item依次添加到每个被标记为common的mode中。

在程序启动时,主线程的runloop有两个预置的mode:kCFRunLoopDefaultMode 和 UITrackingRunLoopMode。默认情况下是会处于defaultMode,滑动scrollView列表时runloop会退出defaultMode转而进入trackingMode。所以,有时候我们加到defaultMode中的timer事件,在滑动列表时是不会执行的。不过,kCFRunLoopDefaultMode 和 UITrackingRunLoopMode这两个 Mode 都已经被添加到runloop的commonMode集合中。也就是说,主线程的这两个预置mode默认已经被标记为commonMode。想要我们的timer回调可以在滑动列表的时候依旧执行,只需要把timer这个item添加到commonMode。

Mode结构体定义

下面是CFRunLoopMode的结构体定义,从RLM的定义不难看出以下信息:

  • 定义了一个结构体指针CFRunLoopModeRef指向__CFRunLoopMode *,从此之后通篇只是用CFRunLoopModeRef。相当于: - typedef NSString * StringRef; StringRef name = @"VV木公子";
  • runLoopMode结构体包含一个名字,用于标识该runLoopMode
  • runLoopMode包含两个集合,分别存放sources0和source1。
  • runLoopMode包含两个数组,分别存放observer和timer
typedef struct __CFRunLoopMode *CFRunLoopModeRef;

struct __CFRunLoopMode {
    CFStringRef _name;		// mode名字
    Boolean _stopped;	  	// mode的状态,标识mode是否停止
    CFMutableSetRef _sources0;	// sources0事件集合
    CFMutableSetRef _sources1;	// sources1事件集合
    CFMutableArrayRef _observers; // 观察者数组
    CFMutableArrayRef _timers;	// 定时器数组
    CFMutableDictionaryRef _portToV1SourceMap;	 //字典。key是mach_port_t,value是CFRunLoopSourceRef
    __CFPortSet _portSet; //端口的集合。保存所有需要监听的port,比如_wakeUpPort,_timerPort都保存在这个数组中
    CFIndex _observerMask; // 添加obsever时设置_observerMask为observer的_activities(CFRunLoopActivity状态)
};
复制代码

在Core Foundation中,针对Mode的操作,苹果只开放了以下3个API(cocoa中也有功能一样的函数,不再列出):

// 返回当前运行的mode的name
CF_EXPORT CFStringRef CFRunLoopCopyCurrentMode(CFRunLoopRef rl); 
// 返回当前RunLoop的所有mode
CF_EXPORT CFArrayRef CFRunLoopCopyAllModes(CFRunLoopRef rl); 
// 向当前RunLoop的common modes中添加一个mode
CF_EXPORT void CFRunLoopAddCommonMode(CFRunLoopRef rl, CFStringRef mode); 
复制代码

我们没有办法直接创建一个CFRunLoopMode对象,但是我们可以调用CFRunLoopAddCommonMode传入一个字符串向RunLoop中添加一个commonMode,传入的字符串即为Mode的名字,Mode对象应该是此时在RunLoop内部创建的。

添加commonMode源码

void CFRunLoopAddCommonMode(CFRunLoopRef rl, CFStringRef modeName) {
    if (!CFSetContainsValue(rl->_commonModes, modeName)) {
	CFSetRef set = rl->_commonModeItems ? CFSetCreateCopy(kCFAllocatorSystemDefault, rl->_commonModeItems) : NULL;
	// 把modeName添加到RunLoop的_commonModes中
	CFSetAddValue(rl->_commonModes, modeName);
	if (NULL != set) {
		// 定义一个长度为2的数组context, 第一个元素是runloop,第二个元素是modeName
	    CFTypeRef context[2] = {rl, modeName};
	    // 把commonModeItems数组中的所有Source/Observer/Timer同步到新添加的mode(CFRunLoopModeRef实例)
	    // 遍历set集合中的每一个元素作为 __CFRunLoopAddItemsToCommonMode 的第一个参数,context 作为第二个参数,调用__CFRunLoopAddItemsToCommonMode
	    CFSetApplyFunction(set, (__CFRunLoopAddItemsToCommonMode), (void *)context);
	    CFRelease(set);
	}
    } else {
    }
}

// 添加item到mode的item集合(数组)中
static void __CFRunLoopAddItemsToCommonMode(const void *value, void *ctx) {
    CFTypeRef item = (CFTypeRef)value;
    CFRunLoopRef rl = (CFRunLoopRef)(((CFTypeRef *)ctx)[0]);
    CFStringRef modeName = (CFStringRef)(((CFTypeRef *)ctx)[1]);
    if (CFGetTypeID(item) == CFRunLoopSourceGetTypeID()) {
      // item是source就添加到source"集合"中
	CFRunLoopAddSource(rl, (CFRunLoopSourceRef)item, modeName);
    } else if (CFGetTypeID(item) == CFRunLoopObserverGetTypeID()) {
      // item是observer就添加到observer"数组"中
	CFRunLoopAddObserver(rl, (CFRunLoopObserverRef)item, modeName);
    } else if (CFGetTypeID(item) == CFRunLoopTimerGetTypeID()) {
      // item是timer就添加到timer"数组"中
	CFRunLoopAddTimer(rl, (CFRunLoopTimerRef)item, modeName);
    }
}
复制代码

CFRunLoopSource

如下图所示,__CFRunLoopSource结构体定义中包括两个版本的source,分别是version0和version1。version0和version1分别对应source0和source1。

7qsydv9mxd.png

typedef struct __CFRunLoopSource * CFRunLoopSourceRef;之所以定义在.h中,是为了给开发者提供创建并使用source的能力。

一个source对应多个runloop。之所以使用CFMutableBagRef这种集合结构保存runloop而非array或set。主要原因是bag是无序的且允许重复。更多信息详见:developer.apple.com/documentati…

typedef struct __CFRunLoopSource * CFRunLoopSourceRef;	// 定义在.h文件中
struct __CFRunLoopSource {
    CFIndex _order;			// souce的顺序(不可变)
    CFMutableBagRef _runLoops;  // 集合(允许元素重复)说明一个source可以对应多个runloop
    union {
				CFRunLoopSourceContext version0; // source0的结构体(不可变)
        CFRunLoopSourceContext1 version1; // source1的结构体(不可变)
    } _context;
};
复制代码

source对应的runloop是一个集合,说明source可以被添加到多个runloop中。

Source0和Source1区别

Source0:source0是App内部事件,由App自己管理的,像UIEvent、CFSocket都是source0。source0并不能主动触发事件,当一个source0事件准备处理时,要先调用 CFRunLoopSourceSignal(source),将这个 Source 标记为待处理。然后手动调用 CFRunLoopWakeUp(runloop) 来唤醒 RunLoop,让其处理这个事件。框架已经帮我们做好了这些调用,比如网络请求的回调、滑动触摸的回调,我们不需要自己处理。

Source1:由RunLoop和内核管理,Mach port驱动,如CFMachPort、CFMessagePort。source1包含了一个 mach_port 和一个回调(函数指针),被用于通过内核和其他线程相互发送消息。这种 Source 能主动唤醒 RunLoop 的线程。

添加Source的源码

作用:把source添加到对应mode的source0或source1集合中。只是这里区分了下source被指定的mode是否为commonMode,如果source被指定的mode是commonMode,还需要把source添加到runloop的commonModeItems集合中。

void CFRunLoopAddSource(CFRunLoopRef rl, CFRunLoopSourceRef rls, CFStringRef modeName) {
    // 导出runloop的commonMode(如果modeName是commonMode)
    if (modeName == kCFRunLoopCommonModes) {
	CFSetRef set = rl->_commonModes ? CFSetCreateCopy(kCFAllocatorSystemDefault, rl->_commonModes) : NULL;
        // 初始化创建commonModeItems(如果_commonModeItems为空)
        if (NULL == rl->_commonModeItems) {
	    rl->_commonModeItems = CFSetCreateMutable(kCFAllocatorSystemDefault, 0, &kCFTypeSetCallBacks);
	}
	// 把source添加到commonModeItems集合中
	CFSetAddValue(rl->_commonModeItems, rls);
	if (NULL != set) {
        // 创建一个长度为2的数组,分别存储runloop和runloopSource
	    CFTypeRef context[2] = {rl, rls};
        // 添加新的item也就是runloopSource到所有的commonMode中
        // set是commonMode集合,CFSetApplyFunction遍历set,添加runloopSource到所有被标记为commonMode的mode->source0(或source1)中
	    CFSetApplyFunction(set, (__CFRunLoopAddItemToCommonModes), (void *)context);
	}
    } else {
    // 走到这里说明modeName不是commonMode
    // 根据modeName和runloop获取runloop的mode
	CFRunLoopModeRef rlm = __CFRunLoopFindMode(rl, modeName, true);
	// 初始化创建runloopMode的source0 & source1这个集合(如果为空)
	if (NULL != rlm && NULL == rlm->_sources0) {
	    rlm->_sources0 = CFSetCreateMutable(kCFAllocatorSystemDefault, 0, &kCFTypeSetCallBacks);
	    rlm->_sources1 = CFSetCreateMutable(kCFAllocatorSystemDefault, 0, &kCFTypeSetCallBacks);
	    rlm->_portToV1SourceMap = CFDictionaryCreateMutable(kCFAllocatorSystemDefault, 0, NULL, NULL);
	}
	// 如果runloopMode的sources0集合和sources1都不包含将要添加的runloopSource则把runloopSource添加到对应的集合中
	if (NULL != rlm && !CFSetContainsValue(rlm->_sources0, rls) && !CFSetContainsValue(rlm->_sources1, rls)) {
	    if (0 == rls->_context.version0.version) {
	    	// rls是source0
	        CFSetAddValue(rlm->_sources0, rls);
	    } else if (1 == rls->_context.version0.version) {
	    	// rls是source1
	        CFSetAddValue(rlm->_sources1, rls);
		__CFPort src_port = rls->_context.version1.getPort(rls->_context.version1.info);
		if (CFPORT_NULL != src_port) {
			// key是src_port,value是rls,存储到runloopMode的_portToV1SourceMap字典中
		    CFDictionarySetValue(rlm->_portToV1SourceMap, (const void *)(uintptr_t)src_port, rls);
		    __CFPortSetInsert(src_port, rlm->_portSet);
	        }
	    }
	    __CFRunLoopSourceLock(rls);
	    if (NULL == rls->_runLoops) {
            // source有一个集合成员变量runLoops。source每被添加进一个runloop,都会把runloop添加到他的这个集合中
            // 如官方注释所言:sources retain run loops!(source会持有runloop!)
	        rls->_runLoops = CFBagCreateMutable(kCFAllocatorSystemDefault, 0, &kCFTypeBagCallBacks); // sources retain run loops!
	    }
	    // 更新runloopSource的runLoops集合,将rl添加到rls->_runloops中
	    CFBagAddValue(rls->_runLoops, rl);
	    __CFRunLoopSourceUnlock(rls);
        // 如果rls是source0则doVer0Callout标记置为true,即需要向外调用回调
	    if (0 == rls->_context.version0.version) {
	        if (NULL != rls->_context.version0.schedule) {
	            doVer0Callout = true;
	        }
	    }
	}
    }
    // 如果是source0,则向外层(上层)调用source0的schedule回调函数
    if (doVer0Callout) {
	rls->_context.version0.schedule(rls->_context.version0.info, rl, modeName);	/* CALLOUT */
    }
}
复制代码

UIButton点击事件是source0还是source1?

UIButton的点击事件到底是source0还是source1,这是很多人困惑的一点。断点打印堆栈看是从source0调出的,而有人说是source1。其实不难理解,我们上面说了,source1是由runloop和内核管理,mach port驱动。所以button的点击事件首先是由source1 接收IOHIDEvent,然后再回调 __IOHIDEventSystemClientQueueCallback() 内触发的source0,source0再触发的 _UIApplicationHandleEventQueue()。所以打印调用堆栈发现UIButton事件是source0触发的。我们可以在 __IOHIDEventSystemClientQueueCallback() 处打一个 Symbolic Breakpoint 来验证这一点。

事实上,即便没有点击button,只要触摸屏幕,就会产生一个__CFRunLoopDoSource1 到 __IOHIDEventSystemClientQueueCallback() 的调用过程。而点击按钮时,除了上述流程,会有一条新的调用从 GSEventRunModal -> CFRunLoopRunSpecific -> __CFRunLoopDoSources0,所以看起来按钮点击事件还是直接触发的 source0事件。

RunLoop timer

CFRunLoopTimerRef 是基于时间的触发器,它和 NSTimer 是toll-free bridged 的,可以混用。其包含一个时间长度和一个回调(函数指针)。当其加入到 RunLoop 时,RunLoop会注册对应的时间点,当时间点到时,RunLoop会被唤醒以执行那个回调。

CFRunLoopTimer结构体

struct __CFRunLoopTimer {
    uint16_t _bits;							// 标记fire状态
    CFRunLoopRef _runLoop;			// timer所处的runloop
    CFMutableSetRef _rlModes;		// mode集合。存放所有包含该timer的mode的modeName,意味着一个timer可能会在多个mode中存在
    CFAbsoluteTime _nextFireDate;		// 下次触发时间
    CFTimeInterval _interval;				// 理想时间间隔(不可变)
    CFTimeInterval _tolerance;      // 允许的误差(可变)
    CFRunLoopTimerCallBack _callout;// timer回调
};
复制代码

和source不同,timer对应的runloop是一个runloop指针,而非数组,所以此处说明一个timer只能添加到一个runloop。

添加timer的源码

作用:添加timer到rl->commonModeItems中,添加timer到runloopMode中,根据触发时间调整timer在runloopMode->timers数组中的位置。

// 添加timer到runloopMode中,添加timer到rl->commonModeItems中
void CFRunLoopAddTimer(CFRunLoopRef rl, CFRunLoopTimerRef rlt, CFStringRef modeName) {    

    if (!__CFIsValid(rlt) || (NULL != rlt->_runLoop && rlt->_runLoop != rl)) return;
    // 导出runloop的commonMode(如果modeName是commonMode)
    if (modeName == kCFRunLoopCommonModes) {
	CFSetRef set = rl->_commonModes ? CFSetCreateCopy(kCFAllocatorSystemDefault, rl->_commonModes) : NULL;
        // 如果rl->_commonModeItems为空就初始化rl->commonModeItems
	if (NULL == rl->_commonModeItems) {
	    rl->_commonModeItems = CFSetCreateMutable(kCFAllocatorSystemDefault, 0, &kCFTypeSetCallBacks);
	}
	CFSetAddValue(rl->_commonModeItems, rlt);
	if (NULL != set) {
        // 长度为2的数组,分别存放rl和rlt
	    CFTypeRef context[2] = {rl, rlt};
        // 添加新的item也就是timer到所有的commonMode中
        // set是commonMode集合,CFSetApplyFunction遍历set,添加context[1]存放的rlt添加到所有被标记为commonMode的mode中
	    CFSetApplyFunction(set, (__CFRunLoopAddItemToCommonModes), (void *)context);
	    CFRelease(set);
	}
    } else {
      // 走到这里说明modeName不是commonMode
      // 根据runloop和modeName查找对用的mode
	CFRunLoopModeRef rlm = __CFRunLoopFindMode(rl, modeName, true);
	if (NULL != rlm) {
            if (NULL == rlm->_timers) {
                CFArrayCallBacks cb = kCFTypeArrayCallBacks;
                cb.equal = NULL;
                rlm->_timers = CFArrayCreateMutable(kCFAllocatorSystemDefault, 0, &cb);
            }
	}
	if (NULL != rlm && !CFSetContainsValue(rlt->_rlModes, rlm->_name)) {
            __CFRunLoopTimerLock(rlt);
            if (NULL == rlt->_runLoop) {
		rlt->_runLoop = rl;
  	    } else if (rl != rlt->_runLoop) {
		return;
	    }
        // 更新rlt的rlModes集合。将rlm->name添加到name中
  	    CFSetAddValue(rlt->_rlModes, rlm->_name);
            // Reposition释义复位。所以顾名思义该函数用于复位timer
            // 此处调用该函数本质上是按照timer下次触发时间长短,计算timer需要插入到runloopMode->timers数组中的位置,然后把timer插入到runloopMode->timers数组中
            __CFRepositionTimerInMode(rlm, rlt, false);
            __CFRunLoopTimerFireTSRUnlock();
            // 为了向后兼容,如果系统版本低于CFSystemVersionLion且timer执行的rl不是当前runloop,则唤醒rl
            if (!_CFExecutableLinkedOnOrAfter(CFSystemVersionLion)) {
                if (rl != CFRunLoopGetCurrent()) CFRunLoopWakeUp(rl);
            }
	}
    }
}
复制代码

设置timer下次触发时间的源码

void CFRunLoopTimerSetNextFireDate(CFRunLoopTimerRef rlt, CFAbsoluteTime fireDate) {
    // 触发日期大于最大限制时间,则把触发日期调整为最大触发时间
    if (TIMER_DATE_LIMIT < fireDate) fireDate = TIMER_DATE_LIMIT;
    uint64_t nextFireTSR = 0ULL;
    uint64_t now2 = mach_absolute_time();
    CFAbsoluteTime now1 = CFAbsoluteTimeGetCurrent();
    // 下次触发时间小于现在则立即触发
    if (fireDate < now1) {
	nextFireTSR = now2;
    // 下次触发时间间隔大于允许的最大间隔TIMER_INTERVAL_LIMIT,则将下次触发时间调整为now + TIMER_INTERVAL_LIMIT
    } else if (TIMER_INTERVAL_LIMIT < fireDate - now1) {
	nextFireTSR = now2 + __CFTimeIntervalToTSR(TIMER_INTERVAL_LIMIT);
    } else {
	nextFireTSR = now2 + __CFTimeIntervalToTSR(fireDate - now1);
    }
    __CFRunLoopTimerLock(rlt);
    if (NULL != rlt->_runLoop) {
        // 获取runloopMode个数
        CFIndex cnt = CFSetGetCount(rlt->_rlModes);
        // 声明名为modes的栈结构
        STACK_BUFFER_DECL(CFTypeRef, modes, cnt);
        // rlt->rlModes赋值给modes栈结构
        CFSetGetValues(rlt->_rlModes, (const void **)modes);
        for (CFIndex idx = 0; idx < cnt; idx++) {
            // 先retain
            CFRetain(modes[idx]);
        }
        CFRunLoopRef rl = (CFRunLoopRef)CFRetain(rlt->_runLoop);
        // 把modes集合中存储的modeName转换为mode结构体实例,然后再存入modes集合
        for (CFIndex idx = 0; idx < cnt; idx++) {
	    CFStringRef name = (CFStringRef)modes[idx];
            modes[idx] = __CFRunLoopFindMode(rl, name, false);
            // 后release
	    CFRelease(name);
        }
        // 把上面计算好的下次触发时间设置给rlt
	rlt->_fireTSR = nextFireTSR;
        rlt->_nextFireDate = fireDate;
        for (CFIndex idx = 0; idx < cnt; idx++) {
	    CFRunLoopModeRef rlm = (CFRunLoopModeRef)modes[idx];
            if (rlm) {
                // Reposition释义复位。所以顾名思义该函数用于复位timer,所谓复位,就是调整timer在runloopMode->timers数组中的位置
                // 此处调用该函数本质上是先移除timer,然后按照timer下次触发时间长短计算timer需要插入到runloopMode->timers数组中的位置,最后把timer插入到runloopMode->timers数组中
                __CFRepositionTimerInMode(rlm, rlt, true);
            }
        }
        // 以上注释的意思是:这行代码的是为了给timer设置date,但不直接作用于runloop
        // 以防万一,我们手动唤醒runloop,尽管有可能这个代价是高昂的
        // 另一方面,这么做的目的也是为了兼容timer的之前的实现方式
        // 如果timer执行的rl不是当前的runloop,则手动唤醒
        if (rl != CFRunLoopGetCurrent()) CFRunLoopWakeUp(rl);
     } else {
         // 走到这里说明timer的rl还是空,所以只是简单的设置timer的下次触发时间
	rlt->_fireTSR = nextFireTSR;
        rlt->_nextFireDate = fireDate;
     }
}
复制代码

RunLoop observer

Observer顾名思义,观察者,和我们设计模式中的观察者模式如出一辙。每个 Observer 都包含了一个回调(函数指针),observer主要观察runloop的状态变化,然后执行回调函数。runloop可观察的状态主要有6种状态,如下:


// runloop的6种状态,用于通知observer runloop的状态变化
/* Run Loop Observer Activities */
typedef CF_OPTIONS(CFOptionFlags, CFRunLoopActivity) {
    kCFRunLoopEntry = (1UL << 0),					// 即将进入Loop
    kCFRunLoopBeforeTimers = (1UL << 1),	// 即将处理 Timer
    kCFRunLoopBeforeSources = (1UL << 2),	// 即将处理 Source
    kCFRunLoopBeforeWaiting = (1UL << 5),	// 即将进入休眠
    kCFRunLoopAfterWaiting = (1UL << 6),	// 刚从休眠中唤醒 但是还没开始处理事件
    kCFRunLoopExit = (1UL << 7),					// 即将退出Loop
    kCFRunLoopAllActivities = 0x0FFFFFFFU
};
复制代码

CFRunLoopObserver结构体定义

struct __CFRunLoopObserver {
    CFRunLoopRef _runLoop;  						// observer所观察的runloop
    CFOptionFlags _activities; 					// CFOptionFlags是UInt类型的别名,_activities用来说明要观察runloop的哪些状态。一旦指定了就不可变。
    CFRunLoopObserverCallBack _callout;	// 观察到runloop状态变化后的回调(不可变)
};
复制代码

和source不同,observer对应的runloop是一个runloop指针,而非数组,此处说明一个observer只能观察一个runloop,所以observer只能添加到一个runloop的一个或者多个mode中。

添加Observer源码

void CFRunLoopAddObserver(CFRunLoopRef rl, CFRunLoopObserverRef rlo, CFStringRef modeName) {
    if (modeName == kCFRunLoopCommonModes) {
        // 导出runloop的commonModes
	CFSetRef set = rl->_commonModes ? CFSetCreateCopy(kCFAllocatorSystemDefault, rl->_commonModes) : NULL;
        // 初始化创建commonModeItems
	if (NULL == rl->_commonModeItems) {
	    rl->_commonModeItems = CFSetCreateMutable(kCFAllocatorSystemDefault, 0, &kCFTypeSetCallBacks);
	}
        // 添加observer到commonModeItems
	CFSetAddValue(rl->_commonModeItems, rlo);
	if (NULL != set) {
	    CFTypeRef context[2] = {rl, rlo};
        // 添加observer到所有被标记为commonMode的mode中
	    CFSetApplyFunction(set, (__CFRunLoopAddItemToCommonModes), (void *)context);
	}
    } else {
	rlm = __CFRunLoopFindMode(rl, modeName, true);
	if (NULL != rlm && NULL == rlm->_observers) {
	    rlm->_observers = CFArrayCreateMutable(kCFAllocatorSystemDefault, 0, &kCFTypeArrayCallBacks);
	}
	if (NULL != rlm && !CFArrayContainsValue(rlm->_observers, CFRangeMake(0, CFArrayGetCount(rlm->_observers)), rlo)) {
            Boolean inserted = false;
            for (CFIndex idx = CFArrayGetCount(rlm->_observers); idx--; ) {
                CFRunLoopObserverRef obs = (CFRunLoopObserverRef)CFArrayGetValueAtIndex(rlm->_observers, idx);
                if (obs->_order <= rlo->_order) {
                    CFArrayInsertValueAtIndex(rlm->_observers, idx + 1, rlo);
                    inserted = true;
                    break;
                }
            }
            if (!inserted) {
	        CFArrayInsertValueAtIndex(rlm->_observers, 0, rlo);
            }
    	// 设置runloopMode的_observerMask为观察者的_activities(CFRunLoopActivity状态)
	    rlm->_observerMask |= rlo->_activities;
	    __CFRunLoopObserverSchedule(rlo, rl, rlm);
	}
        if (NULL != rlm) {
	    __CFRunLoopModeUnlock(rlm);
	}
    }
    __CFRunLoopUnlock(rl);
}
复制代码

自定义Observer来监听runloop状态变化

 /* 创建一个observer对象
     第一个参数: 告诉系统如何给Observer对象分配存储空间
     第二个参数: 需要监听的状态类型
     第三个参数: 是否需要重复监听
     第四个参数: 优先级
     第五个参数: 监听到对应的状态之后的回调
     */
    CFRunLoopObserverRef observer =  CFRunLoopObserverCreateWithHandler(CFAllocatorGetDefault(), kCFRunLoopAllActivities, YES, 0, ^(CFRunLoopObserverRef observer, CFRunLoopActivity activity) {
        switch (activity) {
            case kCFRunLoopEntry:
                NSLog(@"即将进入RunLoop");
                break;
            case kCFRunLoopBeforeTimers:
                NSLog(@"即将处理timer");
                break;
            case kCFRunLoopBeforeSources:
                NSLog(@"即将处理source");
                break;
            case kCFRunLoopBeforeWaiting:
                NSLog(@"即将进入休眠");
                break;
            case kCFRunLoopAfterWaiting:
                NSLog(@"从休眠中被唤醒");
                break;
            case kCFRunLoopExit:
                NSLog(@"即将退出RunLoop");
                break;
                
            default:
                break;
        }
    });
    

    /* 给主线程的RunLoop添加observer用于监听runLoop状态
     第一个参数:需要监听的RunLoop对象
     第二个参数:给指定的RunLoop对象添加的监听对象
     第三个参数:在那种模式下监听
     */
    CFRunLoopAddObserver(CFRunLoopGetMain(), observer, kCFRunLoopCommonModes);
复制代码

RunLoop运行相关源码

如下图,是CFRunLoop运行相关的几个函数以及调用关系。CFRunLoopRun 调用 CFRunLoopRunSpecific 调用 __CFRunLoopRun。

其中CFRunLoopRunSpecific主要由CFRunLoopRun和CFRunLoopRunInMode调用。

CFRunLoop运行调用链

0jof8f407b.png

CFRunLoopRun源码

// 一个do...while循环 如果不是stop或finish就不断的循环 还可以重新启动runloop
void CFRunLoopRun(void) {	/* DOES CALLOUT */
    int32_t result;
    do {
        result = CFRunLoopRunSpecific(CFRunLoopGetCurrent(), kCFRunLoopDefaultMode, 1.0e10, false);
    } while (kCFRunLoopRunStopped != result && kCFRunLoopRunFinished != result);
}
复制代码

CFRunLoopRunInMode源码

SInt32 CFRunLoopRunInMode(CFStringRef modeName, CFTimeInterval seconds, Boolean returnAfterSourceHandled) {     /* DOES CALLOUT */
    return CFRunLoopRunSpecific(CFRunLoopGetCurrent(), modeName, seconds, returnAfterSourceHandled);
}
复制代码

CFRunLoopRunSpecific源码

SInt32 CFRunLoopRunSpecific(CFRunLoopRef rl, CFStringRef modeName, CFTimeInterval seconds, Boolean returnAfterSourceHandled) {     /* DOES CALLOUT */
		// 如果runloop正在销毁则直接返回finish
    if (__CFRunLoopIsDeallocating(rl)) return kCFRunLoopRunFinished;
    // 根据指定的modeName获取指定的mode,也就是将要运行的mode
    CFRunLoopModeRef currentMode = __CFRunLoopFindMode(rl, modeName, false);
    // 出现以下情况就不会return finish:
    // 1>.将要运行的mode不为空
    // 以下这几条是在__CFRunLoopModeIsEmpty函数中判断的:
    // 2>.将要运行的currentMode是source0、source1、timer任一个不为空
    // 3>.待执行的block的mode和将要运行的mode相同
    // 4>.待执行的block的mode是commonMode且待运行的mode包含在commonMode中
    // 5>.待执行的block的mode包含待运行的mode
    // 6>.待执行的block的mode包含commonMode且待运行的mode包含在commonMode中
    // 所谓待执行的block是外部(开发者)通过调用CFRunLoopPerformBlock函数添加到runloop中的
    if (NULL == currentMode || __CFRunLoopModeIsEmpty(rl, currentMode, rl->_currentMode)) {
	return kCFRunLoopRunFinished;
    }
    volatile _per_run_data *previousPerRun = __CFRunLoopPushPerRunData(rl);
    CFRunLoopModeRef previousMode = rl->_currentMode;
    rl->_currentMode = currentMode;
    int32_t result = kCFRunLoopRunFinished;
	// 1.通知observer即将进入runloop
  // 这里使用currentMode->_observerMask 和 kCFRunLoopEntry按位与操作
  // 如果按位与的结果不是0则说明即将进入runloop
  // 而currentMode->_observerMask是个什么东西呢?
  // currentMode->_observerMask本质上是Int类型的变量,标识当前mode的CFRunLoopActivity状态
  // 那么currentMode->_observerMask是在哪里赋值的呢?
  // 调用CFRunLoopAddObserver函数向runloop添加observer的时候会把observer的activities按位或赋值给mode->_observerMask
	if (currentMode->_observerMask & kCFRunLoopEntry ) __CFRunLoopDoObservers(rl, currentMode, kCFRunLoopEntry);
  // RunLoop的运行的最核心函数
	result = __CFRunLoopRun(rl, currentMode, seconds, returnAfterSourceHandled, previousMode);
	// 10.通知observer即将退出runloop
	if (currentMode->_observerMask & kCFRunLoopExit ) __CFRunLoopDoObservers(rl, currentMode, kCFRunLoopExit);
	rl->_currentMode = previousMode;
    return result;
}
复制代码

__CFRunLoopRun源码

这个函数时runloop运行的核心函数,几乎所有的事件都在这个函数中被处理。笔者为了保持源码的味道,并没有对这个函数进行过分精简,所以看起来很长。参考注释可以迅速的了解函数的运行原理:


/**RunLoop的运行的最核心函数(进入和退出时runloop和runloopMode都会被加锁)
 * rl: 运行的runloop
 * rlm: runloop Mode
 * seconds: runloop超时时间
 * stopAfterHandle: 处理完时间后runloop是否stop,默认为false
 * previousMode: runloop上次运行的mode
 */
static int32_t __CFRunLoopRun(CFRunLoopRef rl, CFRunLoopModeRef rlm, CFTimeInterval seconds, Boolean stopAfterHandle, CFRunLoopModeRef previousMode) {
    // 获取基于系统启动后的时钟"嘀嗒"数,其单位是纳秒
    uint64_t startTSR = mach_absolute_time();
    // 状态判断
    if (__CFRunLoopIsStopped(rl)) {
        __CFRunLoopUnsetStopped(rl);
        return kCFRunLoopRunStopped;
    } else if (rlm->_stopped) {
        rlm->_stopped = false;
        return kCFRunLoopRunStopped;
    }
    // 获取主线程接收消息的port备用。如果runLoop是mainRunLoop且后续内核唤醒的port等于主线程接收消息的port,主线程就处理这个消息
    mach_port_name_t dispatchPort = MACH_PORT_NULL;
    Boolean libdispatchQSafe = pthread_main_np() && ((HANDLE_DISPATCH_ON_BASE_INVOCATION_ONLY && NULL == previousMode) || (!HANDLE_DISPATCH_ON_BASE_INVOCATION_ONLY && 0 == _CFGetTSD(__CFTSDKeyIsInGCDMainQ)));
    if (libdispatchQSafe && (CFRunLoopGetMain() == rl) && CFSetContainsValue(rl->_commonModes, rlm->_name)) dispatchPort = _dispatch_get_main_queue_port_4CF();
    
#if USE_DISPATCH_SOURCE_FOR_TIMERS
    // 初始化获取timer的port(source1)
    // 如果这个port和mach_msg发消息的livePort相等则说明timer时间到了,处理timer
    mach_port_name_t modeQueuePort = MACH_PORT_NULL;
    if (rlm->_queue) {
        modeQueuePort = _dispatch_runloop_root_queue_get_port_4CF(rlm->_queue);
    }
#endif
    // 使用GCD实现runloop超时功能
    dispatch_source_t timeout_timer = NULL;
    struct __timeout_context *timeout_context = (struct __timeout_context *)malloc(sizeof(*timeout_context));
    // seconds是设置的runloop超时时间,一般为1.0e10,11.574万年,所以不会超时
    if (seconds <= 0.0) { // instant timeout
        seconds = 0.0;
        timeout_context->termTSR = 0ULL;
    } else if (seconds <= TIMER_INTERVAL_LIMIT) {
        dispatch_queue_t queue = pthread_main_np() ? __CFDispatchQueueGetGenericMatchingMain() : __CFDispatchQueueGetGenericBackground();
        timeout_timer = dispatch_source_create(DISPATCH_SOURCE_TYPE_TIMER, 0, 0, queue);
        dispatch_retain(timeout_timer);
        timeout_context->ds = timeout_timer;
        timeout_context->rl = (CFRunLoopRef)CFRetain(rl);
        // 设置超时的时间点(从现在开始 + 允许运行的时长)
        timeout_context->termTSR = startTSR + __CFTimeIntervalToTSR(seconds);
        dispatch_set_context(timeout_timer, timeout_context); // source gets ownership of context
        dispatch_source_set_event_handler_f(timeout_timer, __CFRunLoopTimeout);
        dispatch_source_set_cancel_handler_f(timeout_timer, __CFRunLoopTimeoutCancel);
        uint64_t ns_at = (uint64_t)((__CFTSRToTimeInterval(startTSR) + seconds) * 1000000000ULL);
        dispatch_source_set_timer(timeout_timer, dispatch_time(1, ns_at), DISPATCH_TIME_FOREVER, 1000ULL);
        dispatch_resume(timeout_timer);
    } else { // infinite timeout
        seconds = 9999999999.0;
        timeout_context->termTSR = UINT64_MAX;
    }
    
    Boolean didDispatchPortLastTime = true;
    // returnValue 标识runloop状态,如果returnValue不为0就不退出。
    // returnValue可能的值:
    // enum {
    //     kCFRunLoopRunFinished = 1,
    //     kCFRunLoopRunStopped = 2,
    //     kCFRunLoopRunTimedOut = 3,
    //     kCFRunLoopRunHandledSource = 4
    // };
    int32_t retVal = 0;
    do {
        voucher_mach_msg_state_t voucherState = VOUCHER_MACH_MSG_STATE_UNCHANGED;
        voucher_t voucherCopy = NULL;
        // 消息缓冲区,用户缓存内核发的消息
        uint8_t msg_buffer[3 * 1024];
        // 消息缓冲区指针,用于指向msg_buffer
        mach_msg_header_t *msg = NULL;
        // 用于保存被内核唤醒的端口(调用mach_msg函数时会把livePort地址传进去供内核写数据)
        mach_port_t livePort = MACH_PORT_NULL;
        __CFPortSet waitSet = rlm->_portSet;
        
        __CFRunLoopUnsetIgnoreWakeUps(rl);
        // 2. 通知 Observers: RunLoop 即将触发 Timer 回调。
        // __CFRunLoopDoObservers内部会调用__CFRUNLOOP_IS_CALLING_OUT_TO_AN_OBSERVER_CALLBACK_FUNCTION__这个函数,这个函数的参数包括observer的回调函数、observer、runloop状态
        if (rlm->_observerMask & kCFRunLoopBeforeTimers) __CFRunLoopDoObservers(rl, rlm, kCFRunLoopBeforeTimers);
        // 3. 通知 Observers: RunLoop 即将触发 Source0 (非port) 回调。
        if (rlm->_observerMask & kCFRunLoopBeforeSources) __CFRunLoopDoObservers(rl, rlm, kCFRunLoopBeforeSources);
        //  执行被加入的block
        // 外部通过调用CFRunLoopPerformBlock函数向当前runloop增加block。新增加的block保存咋runloop.blocks_head链表里。
        // __CFRunLoopDoBlocks会遍历链表取出每一个block,如果block被指定执行的mode和当前的mode一致,则调用__CFRUNLOOP_IS_CALLING_OUT_TO_A_BLOCK__执行之
        __CFRunLoopDoBlocks(rl, rlm);
        // 4. RunLoop 触发 Source0 (非port) 回调
        // __CFRunLoopDoSources0函数内部会调用__CFRUNLOOP_IS_CALLING_OUT_TO_A_SOURCE0_PERFORM_FUNCTION__函数
        // __CFRUNLOOP_IS_CALLING_OUT_TO_A_SOURCE0_PERFORM_FUNCTION__函数会调用source0的perform回调函数,即rls->context.version0.perform
        Boolean sourceHandledThisLoop = __CFRunLoopDoSources0(rl, rlm, stopAfterHandle);
        // 如果rl处理了source0事件,那再处理source0之后的block
        if (sourceHandledThisLoop) {
            __CFRunLoopDoBlocks(rl, rlm);
        }
        // 标记是否需要轮询,如果处理了source0则轮询,否则休眠
        Boolean poll = sourceHandledThisLoop || (0ULL == timeout_context->termTSR);
        
        if (MACH_PORT_NULL != dispatchPort && !didDispatchPortLastTime) {
            msg = (mach_msg_header_t *)msg_buffer;
            // 5. 如果有 Source1 (基于port的source) 处于 ready 状态,直接处理这个 Source1 然后跳转到第9步去处理消息。
            // __CFRunLoopServiceMachPort函数内部调用了mach_msg,mach_msg函数会监听内核给端口发送的消息
            // 如果mach_msg监听到消息就会执行goto跳转去处理这个消息
            // 第五个参数为0代表不休眠立即返回
            if (__CFRunLoopServiceMachPort(dispatchPort, &msg, sizeof(msg_buffer), &livePort, 0, &voucherState, NULL)) {
                goto handle_msg;
            }
        }
        
        didDispatchPortLastTime = false;
        // 6. 通知 Observers: RunLoop 的线程即将进入休眠(sleep)。
        // 根据上面第4步是否处理过source0,来判断如果也没有source1消息的时候是否让线程进入睡眠
        if (!poll && (rlm->_observerMask & kCFRunLoopBeforeWaiting)) __CFRunLoopDoObservers(rl, rlm, kCFRunLoopBeforeWaiting);
        // runloop置为休眠状态
        __CFRunLoopSetSleeping(rl);
        // 通知进入休眠状态后,不要做任何用户级回调
        __CFPortSetInsert(dispatchPort, waitSet);
        // 标记休眠开始时间
        CFAbsoluteTime sleepStart = poll ? 0.0 : CFAbsoluteTimeGetCurrent();
        
#if USE_DISPATCH_SOURCE_FOR_TIMERS
        do {
            msg = (mach_msg_header_t *)msg_buffer;
            // 7. __CFRunLoopServiceMachPort内部调用mach_msg函数等待接受mach_port的消息。随即线程将进入休眠,等待被唤醒。 以下事件会会唤醒runloop:
            // mach_msg接收到来自内核的消息。本质上是内核向我们的port发送了一条消息。即收到一个基于port的Source事件(source1)。
            // 一个timer的时间到了(处理timer)
            // RunLoop自身的超时时间到了(几乎不可能)
            // 被其他调用者手动唤醒(source0)
            __CFRunLoopServiceMachPort(waitSet, &msg, sizeof(msg_buffer), &livePort, poll ? 0 : TIMEOUT_INFINITY, &voucherState, &voucherCopy);
            
            if (modeQueuePort != MACH_PORT_NULL && livePort == modeQueuePort) {
                // Drain the internal queue. If one of the callout blocks sets the timerFired flag, break out and service the timer.
                while (_dispatch_runloop_root_queue_perform_4CF(rlm->_queue));
                if (rlm->_timerFired) {
                    // Leave livePort as the queue port, and service timers below
                    rlm->_timerFired = false;
                    break;
                } else {
                    if (msg && msg != (mach_msg_header_t *)msg_buffer) free(msg);
                }
            } else {
                // Go ahead and leave the inner loop.
                break;
            }
        } while (1);
#else
        msg = (mach_msg_header_t *)msg_buffer;
        __CFRunLoopServiceMachPort(waitSet, &msg, sizeof(msg_buffer), &livePort, poll ? 0 : TIMEOUT_INFINITY, &voucherState, &voucherCopy);
#endif
        // 计算线程沉睡的时长
        rl->_sleepTime += (poll ? 0.0 : (CFAbsoluteTimeGetCurrent() - sleepStart));
        
        __CFPortSetRemove(dispatchPort, waitSet);
        
        __CFRunLoopSetIgnoreWakeUps(rl);
        // runloop置为唤醒状态
        __CFRunLoopUnsetSleeping(rl);
        // 8. 通知 Observers: RunLoop对应的线程刚被唤醒。
        if (!poll && (rlm->_observerMask & kCFRunLoopAfterWaiting)) __CFRunLoopDoObservers(rl, rlm, kCFRunLoopAfterWaiting);
        // 9. 收到&处理source1消息(第5步的goto会到达这里开始处理source1)
    handle_msg:;
        // 忽略端口唤醒runloop,避免在处理source1时通过其他线程或进程唤醒runloop(保证线程安全)
        __CFRunLoopSetIgnoreWakeUps(rl);
        
        if (MACH_PORT_NULL == livePort) {
            // livePort为null则什么也不做
            CFRUNLOOP_WAKEUP_FOR_NOTHING();
            // handle nothing
        } else if (livePort == rl->_wakeUpPort) {
            // livePort为wakeUpPort则只需要简单的唤醒runloop(rl->_wakeUpPort是专门用来唤醒runloop的)
            CFRUNLOOP_WAKEUP_FOR_WAKEUP();
        }
#if USE_DISPATCH_SOURCE_FOR_TIMERS
        else if (modeQueuePort != MACH_PORT_NULL && livePort == modeQueuePort) {
            CFRUNLOOP_WAKEUP_FOR_TIMER();
            // 9.1 如果一个 Timer 到时间了,触发这个Timer的回调
            // __CFRunLoopDoTimers返回值代表是否处理了这个timer
            if (!__CFRunLoopDoTimers(rl, rlm, mach_absolute_time())) {
                __CFArmNextTimerInMode(rlm, rl);
            }
        }
#endif
#if USE_MK_TIMER_TOO
        else if (rlm->_timerPort != MACH_PORT_NULL && livePort == rlm->_timerPort) {
            CFRUNLOOP_WAKEUP_FOR_TIMER();
            if (!__CFRunLoopDoTimers(rl, rlm, mach_absolute_time())) {
                __CFArmNextTimerInMode(rlm, rl);
            }
        }
#endif
        else if (livePort == dispatchPort) {
            CFRUNLOOP_WAKEUP_FOR_DISPATCH();
            /// 9.2 如果有dispatch到main_queue的block,执行block(也就是处理GCD通过port提交到主线程的事件)。
            __CFRUNLOOP_IS_SERVICING_THE_MAIN_DISPATCH_QUEUE__(msg);
            sourceHandledThisLoop = true;
            didDispatchPortLastTime = true;
        } else {
            CFRUNLOOP_WAKEUP_FOR_SOURCE();
            /// 9.3 如果一个 Source1 (基于port) 发出事件了,处理这个事件
            // 根据livePort获取source(不需要name,从mode->_portToV1SourceMap字典中以port作为key即可取到source)
            CFRunLoopSourceRef rls = __CFRunLoopModeFindSourceForMachPort(rl, rlm, livePort);
            if (rls) {
                mach_msg_header_t *reply = NULL;
                // 处理source1事件(触发source1的回调)
                // runloop 触发source1的回调,__CFRunLoopDoSource1内部会调用__CFRUNLOOP_IS_CALLING_OUT_TO_A_SOURCE1_PERFORM_FUNCTION__
                sourceHandledThisLoop = __CFRunLoopDoSource1(rl, rlm, rls, msg, msg->msgh_size, &reply) || sourceHandledThisLoop;
                // 如果__CFRunLoopDoSource1响应的数据reply不为空则通过mach_msg 再send给内核
                if (NULL != reply) {
                    (void)mach_msg(reply, MACH_SEND_MSG, reply->msgh_size, 0, MACH_PORT_NULL, 0, MACH_PORT_NULL);
                    CFAllocatorDeallocate(kCFAllocatorSystemDefault, reply);
                }
            }
        }
        if (msg && msg != (mach_msg_header_t *)msg_buffer) free(msg);
        /// 执行加入到Loop的block
        __CFRunLoopDoBlocks(rl, rlm);
        
        if (sourceHandledThisLoop && stopAfterHandle) {
            /// 进入loop时参数说处理完事件就返回。
            retVal = kCFRunLoopRunHandledSource; // 4
        } else if (timeout_context->termTSR < mach_absolute_time()) {
            /// 超出传入参数标记的超时时间了
            retVal = kCFRunLoopRunTimedOut; // 3
        } else if (__CFRunLoopIsStopped(rl)) {
            /// 被外部调用者强制停止了
            __CFRunLoopUnsetStopped(rl); // 2
            retVal = kCFRunLoopRunStopped;
        } else if (rlm->_stopped) {
            // 调用了_CFRunLoopStopMode将mode停止了
            rlm->_stopped = false;
            retVal = kCFRunLoopRunStopped; // 2
        } else if (__CFRunLoopModeIsEmpty(rl, rlm, previousMode)) {
            // source/timer/observer一个都没有了
            retVal = kCFRunLoopRunFinished; // 1
        }
        // 如果retVal不是0,即未超时,mode不是空,loop也没被停止,那继续loop
    } while (0 == retVal);
    
    if (timeout_timer) {
        dispatch_source_cancel(timeout_timer);
        dispatch_release(timeout_timer);
    } else {
        free(timeout_context);
    }
    
    return retVal;
}
复制代码

如下图,笔者绘制了一张详细的函数调用图说明上述runloop的整个调用过程:

uax3321q0k.png

手动唤醒runloop的方式

  • static void __CFRunLoopTimeout(void *arg) {}

The interval is DISPATCH_TIME_FOREVER, so this won't fire again。因为runloop的执行时长是forever,所有runloop永远不会超时,也就说函数__CFRunLoopTimeout永远不会执行到。

  • CFRunLoopStop(CFRunLoopRef rl) {}

调用了CFRunLoopStop代表runloop被强制终止了。即便调用了CFRunLoopWakeUp,当前的runloop也永远不会被唤醒了**。因为CFRunLoopStop函数内部调用了_ _CFRunLoopSetStopped函数。而__CFRunLoopSetStopped的实现是rl->_perRunData->stopped = 0x53544F50;。加之CFRunLoopWakeUp函数中通过调用__CFRunLoopIsIgnoringWakeUps(rl)检查了rl->_perRunData->stopped的值是否为true,如果值为true则CFRunLoopWakeUp函数直接返回,不再执行唤醒操作。

  • CF_EXPORT void _CFRunLoopStopMode(CFRunLoopRef rl, CFStringRef modeName) {}

_CFRunLoopStopMode函数只是通过modeName查找对应的mode,然后把mode的stopped置为true rlm->_stopped = true;。 不会操作runloop->perRunData->stopped。

  • void CFRunLoopAddTimer(CFRunLoopRef rl, CFRunLoopTimerRef rlt, CFStringRef modeName) {}

CFRunLoopAddTimer函数调用CFRunLoopWakeUp函数纯粹是为了向后兼容,如果系统版本低于CFSystemVersionLion且timer执行的rl不是当前runloop,则唤醒rl。 通常情况下,在主流机型上,CFRunLoopAddTimer函数不会调用到CFRunLoopWakeUp函数,但因为timer handler发生了变化,所以需要兼容旧的实现。在旧版本系统上调用CFRunLoopWakeUp函数。

  • static void __CFRunLoopSourceWakeUpLoop(const void value, void context) {} 直接调用CFRunLoopWakeUp((CFRunLoopRef)value);
  • void CFRunLoopTimerSetNextFireDate(CFRunLoopTimerRef rlt, CFAbsoluteTime fireDate) {}

如果timer执行的rl不是当前的runloop,则调用CFRunLoopWakeUp手动唤醒rl 除手动唤醒runloop外,内核通过向port发送消息也可以自动唤醒runloop。

手动唤醒runloop的代码

void CFRunLoopWakeUp(CFRunLoopRef rl) {
    // __CFSendTrivialMachMessage内部调用mach_msg函数向runloop的wakeUpPort发送消息以唤醒runloop
    kern_return_t ret = __CFSendTrivialMachMessage(rl->_wakeUpPort, 0, MACH_SEND_TIMEOUT, 0);
}

// 手动调用 mach_msg 向 rl->_wakeUpPort sendMsg 以唤醒runloop
static uint32_t __CFSendTrivialMachMessage(mach_port_t port, uint32_t msg_id, CFOptionFlags options, uint32_t timeout) {
    kern_return_t result;
   // 配置header...
    mach_msg_header_t header;
    header.msgh_remote_port = port;
    header.msgh_id = msg_id; 
    // 向内核发送消息唤醒runloop
    result = mach_msg(&header, MACH_SEND_MSG|options, header.msgh_size, 0, MACH_PORT_NULL, timeout, MACH_PORT_NULL);
		// ... 
    return result;
}
复制代码

GCD和RunLoop的关系

当调用 dispatch_async(dispatch_get_main_queue(), block) 时,libDispatch 会向主线程的RunLoop发送消息,RunLoop会被唤醒,并从消息中取得这个 block,并在回调 CFRUNLOOP_IS_SERVICING_THE_MAIN_DISPATCH_QUEUE() 里执行这个 block。但这个逻辑仅限于 dispatch 到主线程,dispatch 到其他线程仍然是由 libDispatch 处理的。那么你肯定会问:为什么子线程没有这个和GCD交互的逻辑?原因有二:

  • 主线程runloop是主线程的事件管理者。runloop负责何时让runloop处理何种事件。所有分发给主线程的任务必须统一交给主线程runloop排队处理。举例:UI操作只能在主线程,不在主线程操作UI会带来很多UI错乱问题以及UI更新延迟问题。
  • 子线程不接受GCD的交互。因为子线程不一定会有runloop。

AutoreleasePool和RunLoop的关系

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 了。

RunLoop应用

runloop在实际开发中有很多应用,通过源码可知苹果官方规定runloop一次只能运行在一个mode中,要想切换mode必须退出当前mode,以此来实现runloop不同mode的隔离。runloop的mode隔离实现了不同mode下任务的隔离。隔离了不同的mode就代表了隔离了不同mode下的source、timer、observer。这样做的好处是当前mode只会执行当前mode中的sourece、timer、observer,可以极大节省CPU资源。与所有任务都运行在一个mode中相比,这是一种很巧妙的设计。但苹果并没有将每个mode都严格的隔离,考虑到有些代码在不同的mode中都要执行的场景(比如,列表滚动时还要保证轮播图定时轮播),苹果又提供了一个名为commonMode的mode,这个mode不是一个真正的mode,而是多个mode的合集。兼顾性能的同时又给拓展留了活口,这种设计方式很值得学习。

苹果对runloop的使用

苹果在AutoreleasePool、手势识别、事件响应、UI更新、定时器、NSObject延时调用方法(performSelecter:afterDelay: )等方面都有使用RunLoop。

AFNetworking对runloop的使用

另外,众所周知,为了线程保活,AFNetworking内部也使用了runLoop:通过给子线程添加一个runloop来保证这个子线程不退出。这样,当需要这个子线程执行任务时,AFNetworking 通过调用 NSObject performSelector:onThread:.. 将任务抛给这个子线程的 RunLoop 即可。

SDWebImage对runloop的使用

SDWebImage中的动画播放类SDAnimatedImageView中也有runloop的影子。该类暴露了一个runloopMode属性,开发者可以指定动画播放的runloopMode,如果不指定则会使用内部默认的mode。这个runloopMode属性最终传递给了SDDisplayLink,SDDisplayLink在iOS平台上是对CADisplayLink的封装。最终通过调用CADisplyLink的实例方法- (void)addToRunLoop:(NSRunLoop *)runloop forMode:(NSRunLoopMode)mode;将的runloopMode设置给CADisplayLink。

其他有使用runLoop的地方还有卡顿监控、异步绘制等。总之,只要我们想要保活线程能够随时处理任务,这个线程必须要有runloop。

分类:
iOS
标签:
收藏成功!
已添加到「」, 点击更改