协程如今已经不是个新东西了,不少语言都提供了原生支持,也有不少开源的库也提供了协程支持。php
最近为了要给tbox增长协程,特意研究了下各大开源协程库的实现,例如:libtask, libmill, boost, libco, libgo等等。linux
他们都属于stackfull协程,每一个协程有完整的私有堆栈,里面的核心就是上下文切换(context),而stackless的协程,比较出名的有protothreads,这个比较另类,有兴趣的同窗能够去看下源码,这里就很少说了。git
那么现有协程库,是怎么去实现context切换的呢,目前主要有如下几种方式:github
各个协程协程库的切换效率的基准测试,能够参考:切换效率基准测试报告macos
要研究ucontext,其实只要看下libtask的实现就好了,很是经典,这套接口其实效率并非很高,并且不少平台已经标记为废弃接口了(像macosx),目前主要是在linux下使用windows
libtask里面对不提供此接口的平台,进行了汇编实现,已达到跨平台的目的,架构
ucontext相关接口,主要有以下四个:app
下面给个简单的例子:less
#include <stdio.h> #include <ucontext.h> static ucontext_t ctx[3]; static void func1(void) { // 切换到func2 swapcontext(&ctx[1], &ctx[2]); // 返回后,切换到ctx[1].uc_link,也就是main的swapcontext返回处 } static void func2(void) { // 切换到func1 swapcontext(&ctx[2], &ctx[1]); // 返回后,切换到ctx[2].uc_link,也就是func1的swapcontext返回处 } int main (void) { // 初始化context1,绑定函数func1和堆栈stack1 char stack1[8192]; getcontext(&ctx[1]); ctx[1].uc_stack.ss_sp = stack1; ctx[1].uc_stack.ss_size = sizeof(stack1); ctx[1].uc_link = &ctx[0]; makecontext(&ctx[1], func1, 0); // 初始化context2,绑定函数func2和堆栈stack2 char stack2[8192]; getcontext(&ctx[2]); ctx[2].uc_stack.ss_sp = stack2; ctx[2].uc_stack.ss_size = sizeof(stack1); ctx[2].uc_link = &ctx[1]; makecontext(&ctx[2], func2, 0); // 保存当前context,而后切换到context2上去,也就是func2 swapcontext(&ctx[0], &ctx[2]); return 0; }
那这套接口的实现原理是什么呢,咱们能够拿libtask的arm汇编实现,来看下,其余平台也相似。函数
/* get mcontext * * @param mcontext r0 * * @return r0 */ .globl getmcontext getmcontext: /* 保存全部当前寄存器,包括sp和lr */ str r1, [r0, #4] // mcontext.mc_r1 = r1 str r2, [r0, #8] // mcontext.mc_r2 = r2 str r3, [r0, #12] // mcontext.mc_r3 = r3 str r4, [r0, #16] // mcontext.mc_r4 = r4 str r5, [r0, #20] // mcontext.mc_r5 = r5 str r6, [r0, #24] // mcontext.mc_r6 = r6 str r7, [r0, #28] // mcontext.mc_r7 = r7 str r8, [r0, #32] // mcontext.mc_r8 = r8 str r9, [r0, #36] // mcontext.mc_r9 = r9 str r10, [r0, #40] // mcontext.mc_r10 = r10 str r11, [r0, #44] // mcontext.mc_fp = r11 str r12, [r0, #48] // mcontext.mc_ip = r12 str r13, [r0, #52] // mcontext.mc_sp = r13 str r14, [r0, #56] // mcontext.mc_lr = r14 // 设置从setcontext切换回getcontext后,从getcontext返回的值为1 mov r1, #1 /* mcontext.mc_r0 = 1 * * if (getcontext(ctx) == 0) * setcontext(ctx); * * getcontext() will return 1 after calling setcontext() */ str r1, [r0] // 返回0 mov r0, #0 // return 0 mov pc, lr /* set mcontext * * @param mcontext r0 */ .globl setmcontext setmcontext: // 恢复指定context的全部寄存器,包括sp和lr ldr r1, [r0, #4] // r1 = mcontext.mc_r1 ldr r2, [r0, #8] // r2 = mcontext.mc_r2 ldr r3, [r0, #12] // r3 = mcontext.mc_r3 ldr r4, [r0, #16] // r4 = mcontext.mc_r4 ldr r5, [r0, #20] // r5 = mcontext.mc_r5 ldr r6, [r0, #24] // r6 = mcontext.mc_r6 ldr r7, [r0, #28] // r7 = mcontext.mc_r7 ldr r8, [r0, #32] // r8 = mcontext.mc_r8 ldr r9, [r0, #36] // r9 = mcontext.mc_r9 ldr r10, [r0, #40] // r10 = mcontext.mc_r10 ldr r11, [r0, #44] // r11 = mcontext.mc_fp ldr r12, [r0, #48] // r12 = mcontext.mc_ip ldr r13, [r0, #52] // r13 = mcontext.mc_sp ldr r14, [r0, #56] // r14 = mcontext.mc_lr // 设置getcontext的返回值 ldr r0, [r0] // r0 = mcontext.mc_r0 // 切换到getcontext的返回处,继续执行 mov pc, lr // return
其实说白了,就是对寄存器进行保存和恢复的过程,切换原理很简单
而后外面只须要用宏包裹下,就好了:
#define setcontext(u) setmcontext(&(u)->uc_mcontext) #define getcontext(u) getmcontext(&(u)->uc_mcontext)
而对于makecontext,主要的工做就是设置 函数指针 和 堆栈 到对应context保存的sp和pc寄存器中,这也就是为何makecontext调用前,必需要先getcontext下的缘由。
void makecontext(ucontext_t *uc, void (*fn)(void), int argc, ...) { int i, *sp; va_list arg; // 将函数参数陆续设置到r0, r1,r2 .. 等参数寄存器中 sp = (int*)uc->uc_stack.ss_sp + uc->uc_stack.ss_size / 4; va_start(arg, argc); for(i=0; i<4 && i<argc; i++) uc->uc_mcontext.gregs[i] = va_arg(arg, uint); va_end(arg); // 设置堆栈指针到sp寄存器 uc->uc_mcontext.gregs[13] = (uint)sp; // 设置函数指针到lr寄存器,切换时会设置到pc寄存器中进行跳转到fn uc->uc_mcontext.gregs[14] = (uint)fn; }
这套接口简单有效,不支持的平台还能够经过汇编实现来支持,看上去已经很完美了,可是确有个问题,就是效率不高,由于每次切换保存和恢复的寄存器太多。
以后能够看下boost.context的实现,就能够对比出来了,下面先简单讲讲setjmp的切换。。
libmill里面的切换主要用的就是此套接口,其实应该是sigsetjmp/siglongjmp,不只保存了寄存器,还保存了signal mask。。
经过切换效率基准测试报告,能够看到libmill在x86_64架构上,切换很是的快
实际上是由于针对这个平台,libmill没有使用原生sigsetjmp/siglongjmp接口,而是本身汇编实现了一套,作了些优化,而且去掉了signal mask的保存。
#if defined(__x86_64__) #if defined(__AVX__) #define MILL_CLOBBER \ , "ymm0", "ymm1", "ymm2", "ymm3", "ymm4", "ymm5", "ymm6", "ymm7",\ "ymm8", "ymm9", "ymm10", "ymm11", "ymm12", "ymm13", "ymm14", "ymm15" #else #define MILL_CLOBBER #endif #define mill_setjmp_(ctx) ({\ int ret;\ asm("lea LJMPRET%=(%%rip), %%rcx\n\t"\ "xor %%rax, %%rax\n\t"\ "mov %%rbx, (%%rdx)\n\t"\ "mov %%rbp, 8(%%rdx)\n\t"\ "mov %%r12, 16(%%rdx)\n\t"\ "mov %%rsp, 24(%%rdx)\n\t"\ "mov %%r13, 32(%%rdx)\n\t"\ "mov %%r14, 40(%%rdx)\n\t"\ "mov %%r15, 48(%%rdx)\n\t"\ "mov %%rcx, 56(%%rdx)\n\t"\ "mov %%rdi, 64(%%rdx)\n\t"\ "mov %%rsi, 72(%%rdx)\n\t"\ "LJMPRET%=:\n\t"\ : "=a" (ret)\ : "d" (ctx)\ : "memory", "rcx", "r8", "r9", "r10", "r11",\ "xmm0", "xmm1", "xmm2", "xmm3", "xmm4", "xmm5", "xmm6", "xmm7",\ "xmm8", "xmm9", "xmm10", "xmm11", "xmm12", "xmm13", "xmm14", "xmm15"\ MILL_CLOBBER\ );\ ret;\ }) #define mill_longjmp_(ctx) \ asm("movq (%%rax), %%rbx\n\t"\ "movq 8(%%rax), %%rbp\n\t"\ "movq 16(%%rax), %%r12\n\t"\ "movq 24(%%rax), %%rdx\n\t"\ "movq 32(%%rax), %%r13\n\t"\ "movq 40(%%rax), %%r14\n\t"\ "mov %%rdx, %%rsp\n\t"\ "movq 48(%%rax), %%r15\n\t"\ "movq 56(%%rax), %%rdx\n\t"\ "movq 64(%%rax), %%rdi\n\t"\ "movq 72(%%rax), %%rsi\n\t"\ "jmp *%%rdx\n\t"\ : : "a" (ctx) : "rdx" \ ) #else #define mill_setjmp_(ctx) \ sigsetjmp(*ctx, 0) #define mill_longjmp_(ctx) \ siglongjmp(*ctx, 1) #endif
通过测试分析,其实libc自带的sigsetjmp/siglongjmp在不一样平台下,效率上表现差别很大,并且切换也比setjmp/longjmp的慢了很多
因此libmill除了优化过的x86_64平台,在其余arch上切换效果并非很理想,彻底依赖libc的实现效率。。
所以后来再封装tbox的协程库的时候,并无考虑此方案。
这套接口,我以前用来封装setcontext/getcontext的时候,也实现并测试过,效果很是不理想,很是的慢,比用libtask那套纯汇编的实现慢了10倍左右,直接放弃了
不过这套接口用起来仍是很方便,跟ucontext相似,彻底能够用来模拟封装成ucontext的使用方式,例如:
// getcontext GetThreadContext(GetCurrentThread(), mcontext); // setcontext SetThreadContext(GetCurrentThread(), mcontext);
而makecontext,我贴下以前写的一些实现,不过如今已经废弃了,仅供参考:
tb_bool_t makecontext(tb_context_ref_t context, tb_pointer_t stack, tb_size_t stacksize, tb_context_func_t func, tb_cpointer_t priv) { // check LPCONTEXT mcontext = (LPCONTEXT)context; tb_assert_and_check_return_val(mcontext && stack && stacksize && func, tb_false); // make stack address tb_long_t* sp = (tb_long_t*)stack + stacksize / sizeof(tb_long_t); // push arguments tb_uint64_t value = tb_p2u64(priv); *--sp = (tb_long_t)(tb_uint32_t)(value); *--sp = (tb_long_t)(tb_uint32_t)(value >> 32); // push return address(unused, only reverse the stack space) *--sp = 0; /* save function and stack address * * sp + 8: arg2 * sp + 4: arg1 * sp: return address(0) => esp */ mcontext->Eip = (tb_long_t)func; mcontext->Esp = (tb_long_t)sp; tb_assert_static(sizeof(tb_long_t) == 4); // save and restore the full machine context mcontext->ContextFlags = CONTEXT_FULL; // ok return tb_true; }
原理跟libtask的那个相似,就是修改esp和eip寄存器而已,具体实现能够参考我以前的commit
这套接口,目前还没测试过,不过看msdn介绍,使用仍是很方便的,不过部分xp系统上,并不提供此接口,须要较高版本的系统支持
所以为了考虑跨平台,tbox暂时没去考虑使用,有兴趣的同窗能够研究下。
其实一开始tbox是参考libtask的ucontext汇编实现,封装了一套context切换,当时其实已经封装的差很少了,可是后来作benchbox的基准测试
把boost的切换一对比,直接就被秒杀了,哎。。而后去看boost的context实现源码,虽然对boost自己并非太喜欢,可是底层的context是实现,确实很是精妙,不得不佩服。
它主要有两个接口,一个make_fcontext()
,一个jump_fcontext()
,我在tbox的平台库里面参考其实现,进行了封装,使用方式跟boost相似,所以直接以tbox的使用为例:
static tb_void_t func1(tb_context_from_t from) { // 获取切换时传入的contexts参数 tb_context_ref_t* contexts = (tb_context_ref_t*)from.priv; // 保存原始context contexts[0] = from.context; // 切换到func2 from = tb_context_jump(contexts[2], contexts); // 从func2返回后,切换回main tb_context_jump(contexts[0], tb_null); } static tb_void_t func2(tb_context_from_t from) { // 获取切换时传入的contexts参数 tb_context_ref_t* contexts = (tb_context_ref_t*)from.priv; // 切换到func1 from = tb_context_jump(from.context, contexts); // 从func1返回后,切换回main tb_context_jump(contexts[0], tb_null); } int main(int argc, char** argv) { // the stacks static tb_context_ref_t contexts[3]; static tb_byte_t stacks1[8192]; static tb_byte_t stacks2[8192]; // 经过stack1和func1生成context1 contexts[1] = tb_context_make(stacks1, sizeof(stacks1), func1); // 经过stack2和func2生成context2 contexts[2] = tb_context_make(stacks2, sizeof(stacks2), func2); // 切换到func1,而且传入contexts做为参数 tb_context_jump(contexts[1], contexts); }
其中tb_context_make
至关于boost的make_fcontext
, tb_context_jump
至关于boost的jump_fcontext
相比ucontext,boost的切换模式,少了单独对context进行保存(getcontext)和切换(setcontext)过程,而是把二者合并到一块儿,经过jump_fcontext接口实现直接切换。
这样作有个好处,就是更加容易进行优化,使得整个切换过程更加的紧凑,咱们先来看下macosx平台x86_64的实现,这个比较简单易懂些。。
这里我就直接贴tbox的代码了,实现差很少的,只不过多了些注释而已。
/* make context (refer to boost.context) * * ------------------------------------------------------------------------------- * stackdata: | | context ||||||| * -------------------------------------------------------------------------|----- * (16-align for macosx) * * * ------------------------------------------------------------------------------- * context: | r12 | r13 | r14 | r15 | rbx | rbp | rip | end | ... * ------------------------------------------------------------------------------- * 0 8 16 24 32 40 48 56 | * | 16-align for macosx * | * esp when jump to function * * @param stackdata the stack data (rdi) * @param stacksize the stack size (rsi) * @param func the entry function (rdx) * * @return the context pointer (rax) */ function(tb_context_make) // 保存栈顶指针到rax addq %rsi, %rdi movq %rdi, %rax /* 先对栈指针进行16字节对齐 * * * ------------------------------ * context: | retaddr | padding ... | * ------------------------------ * | | * | 此处16字节对齐 * | * esp到此处时,会进行ret * * 这么作,主要是由于macosx下,对调用栈布局进行了优化,在保存调用函数返回地址的堆栈处,须要进行16字节对齐,方便利用SIMD进行优化 */ movabs $-16, %r8 andq %r8, %rax // 保留context须要的一些空间,由于context和stack是在一块儿的,stack底指针就是context leaq -64(%rax), %rax // 保存func函数地址到context.rip movq %rdx, 48(%rax) /* 保存__end地址到context.end,若是在在func返回时,没有指定jump切换到有效context * 那么会继续会执行到此处,程序也就退出了 */ leaq __end(%rip), %rcx movq %rcx, 56(%rax) // 返回rax指向的栈底指针,做为context返回 ret __end: // exit(0) xorq %rdi, %rdi #ifdef TB_ARCH_ELF call _exit@PLT #else call __exit #endif hlt endfunc /* jump context (refer to boost.context) * * @param context the to-context (rdi) * @param priv the passed user private data (rsi) * * @return the from-context (context: rax, priv: rdx) */ function(tb_context_jump) // 保存寄存器,而且按布局构形成当前context,包括jump()自身的返回地址retaddr(rip) pushq %rbp pushq %rbx pushq %r15 pushq %r14 pushq %r13 pushq %r12 // 保存当前栈基址rsp,也就是contex,到rax中 movq %rsp, %rax // 切换到指定的新context上去,也就是切换堆栈 movq %rdi, %rsp // 而后按context上的栈布局依次恢复寄存器 popq %r12 popq %r13 popq %r14 popq %r15 popq %rbx popq %rbp // 获取context.rip,也就是make时候指定的func函数地址,或者是对方context中jump()调用的返回地址 popq %r8 // 设置返回值(from.context: rax, from.priv: rdx),也就是来自对方jump()的context和传递参数 movq %rsi, %rdx // 传递当前(context: rax, priv: rdx),做为function(from)函数调用的入口参数 movq %rax, %rdi /* 跳转切换到make时候指定的func函数地址,或者是对方context中jump()调用的返回地址 * * 切换过去后,此时的栈布局以下: * * end是func的返回地址,也就是exit * * ------------------------------- * context: .. | end | args | padding ... | * ------------------------------- * 0 8 * | | * rsp 16-align for macosx */ jmp *%r8 endfunc
关于apple栈布局16字节对齐优化问题,能够参考:http://fabiensanglard.net/macosxassembly/index.php
借用下里面的图哈,能够看下:
boost的context和stack是一块儿的,栈底指针就是context,设计很是巧妙,切换context就是切换stack,一箭双雕,可是这样每次切换就必须更新context
由于每次切换context后,context地址都会变掉。
// 切换返回时,须要更新from.context的地址 from = tb_context_jump(from.context, contexts);
如今能够和getcontext/setcontext对比下,就能够看出,这种切换方式的一些优点:
1. 保存和恢复寄存器数据,在一个切换接口中,更加容易进行优化 2. 经过stack基栈做为context,切换栈至关于切换了context,一箭双雕,指令数更少 3. 经过push/pop操做保存寄存器,比mov等方式指令字节数更少,更加精简 4. 对参数、可变寄存器没去保存,仅保存部分必须的寄存器,进一步减小指令数
为了实现跨平台,boost下各个架构的实现,我都研究了一遍,发现macosx i386的实现,是有问题的,运行会挂掉,里面直接照搬了linux elf的i386实现版本。
估计macosx i386用的很少,因此没去作测试,后来发现,原来macosx i386下jump()返回from(context, priv)的结构体并非基于栈的
而是使用eax, edx返回,所以tbox里面针对这个架构,从新调整stack布局,重写了一套本身的实现。
其实在windows下,返回from(context, priv)的结构体,也是用的eax, edx,而不是像linux elf那样基于栈的,所以实现上效率会高不少。
可是,boost里面,却像elf那个版本同样,仍是采用了一个跳板,进行二次跳转后,才切换到context上去,是没有必要的。
在boost里面的跳板代码,相似像这样(摘录自tbox elf i386的实现):
__entry: /* pass arguments(context: eax, priv: edx) to the context function * * patch __end * | * | old-context * ----|------------------------------------ * context: .. | retval | context | priv | padding | * ----------------------------------------- * 0 4 arguments * | | * esp 16-align * (now) */ movl %eax, (%esp) movl %edx, 0x4(%esp) // retval = the address of label __end pushl %ebp /* jump to the context function entry * * @note need not adjust stack pointer(+4) using 'ret $4' when enter into function first */ jmp *%ebx
因为elf i386下,返回from结构体是基于栈的,因此进入function入口的栈,和切换到对方jump()返回处的栈,并非彻底平衡的,所以须要一个跳板区分对待
stack布局上也须要特殊处理,而windows i386的返回,只须要eax/edx就足够,不必再去使用这个跳板。
所以,tbox里面针对这个平台,进行了优化,从新调整了栈布局,省去跳板操做,直接进行跳转,实测切换效率比boost的实现提高30%左右。