C语言中setjmp()函数和longjmp()函数

前不久在阅读Quake3源代码的时候，看到一个陌生的函数：setjmp，一番google和查询后，觉得有必要针对setjmp和longjmp这对函数写一篇blog，总结一下。

setjmp和longjmp是C语言独有的，只有将它们结合起来使用，才能达到程序控制流有效转移的目的，按照程序员的预先设计的意图，去实现对程序中可能出现的异常进行集中处理。

先来看一下这两个函数的定义吧：

setjmp和longjmp的函数原型在setjmp.h中

函数原型：

int setjmp(jmp_buf envbuf);

setjmp函数用缓冲区envbuf保存系统堆栈的内容，以便后续的longjmp函数使用。setjmp函数初次启用时返回0值。

 

void longjmp(jmp_buf envbuf, int val);

longjmp函数中的参数envbuf是由setjmp函数所保存的堆栈环境，参数val设置setjmp函数的返回值。longjmp函数本身是没有返回值的，它执行后跳转到保存envbuf参数的setjmp函数调用，并由setjmp函数调用返回，此时setjmp函数的返回值就是val。

 

上面的说明有点拗口，通俗的解释是：先调用setjmp，用变量envbuf记录当前的位置，然后调用longjmp，返回envbuf所记录的位置，并使setjmp的返回值为val。当时用longjmp时，envbuf的内容被销毁了。其实这里的“位置”一词真正的含义是栈定指针。

 

接着让我们看一个小例子吧：

#include <stdio.h> 
#include <setjmp.h> 

jmp_buf buf; 

banana(){ 
    printf("in banana() \n"); 
    longjmp(buf,1); 

    printf("you'll never see this,because i longjmp'd"); 

} 

main() 
{ 
    if(setjmp(buf)) 
        printf("back in main\n"); 
    else{ 
        printf("first time through\n"); 
        banana(); 
    } 

}

（代码段引自《C专家编程》：p）

这段代码的打印结果是：

first time through

in banana()

back in main

仔细看一下应该更能体会这对函数的作用了吧。

 

setjmp/longjmp的最大用处是错误恢复，类似try ...catch...

他们的功能比goto强多了，goto只能在函数体内跳来跳去，而setjmp/longjmp可以在到过的所有位置间。

 

从java、.net世界来的兄弟们也许会很不屑于这对函数，也许会觉得这样的功能会使代码的可读性变差。不过请别忘了，这里是C的世界，每个世界有每个世界的哲学，OO只是方法学的一种，而不是全部。quake3是用C写的，据看过其代码的前辈说，其模块化非常好，所以这也是我看quake3代码的初衷。（哦，算了吧，写游戏不是随便说说的...）

注:

   我第一次看到setjmp是在quake3代码的Com_Init中，

/* 
================= 
Com_Init 
================= 
*/ 
void Com_Init( char *commandLine ) { 
    char    *s; 

    Com_Printf( "%s %s %s\n", Q3_VERSION, CPUSTRING, __DATE__ ); 

    if ( setjmp (abortframe) ) { 
        Sys_Error ("Error during initialization"); 
    }

....

卡马克在这里也是当catch用的，其中的一句注释是这么写的：

jmp_buf abortframe;        // an ERR_DROP occured, exit the entire frame

 

继续读吧，在代码中慢慢体会吧...

C语言的setjmp:异常处理与构建协作式多任务系统
int setjmp(jmp_buf envbuf)

宏函数setjmp()在缓冲区envbuf中保存系统堆栈里的内容，供longjmp()以后使用,setjmp()必须使用头文件setjmp.h。
调用setjmp()宏时，返回值为0，然而longjmp()把一个变原传递给setjmp(),该值（恒不为0）就是调用longjmp()后出现的setjmp()的值。

setjmp 函数用于保存程序的运行时的堆栈环境，接下来的其它地方，你可以通过调用longjmp函数来恢复先前被保存的程序堆栈环境。当setjmp和 longjmp组合一起使用时，它们能提供一种在程序中实现“非本地局部跳转”（"non-local goto"）的机制。并且这种机制常常被用于来实现，把程序的控制流传递到错误处理模块之中；或者程序中不采用正常的返回（return）语句，或函数的正常调用等方法，而使程序能被恢复到先前的一个调用例程（也即函数）中。

对setjmp函数的调用时，会保存程序当前的堆栈环境到env参数中；接下来调用longjmp时，会根据这个曾经保存的变量来恢复先前的环境，并且当前的程序控制流，会因此而返回到先前调用setjmp时的程序执行点。此时，在接下来的控制流的例程中，所能访问的所有的变量（除寄存器类型的变量以外），包含了longjmp函数调用时，所拥有的变量。

如何实现异常处理
首先设置一个跳转点（setjmp() 函数可以实现这一功能），然后在其后的代码中任意地方调用 longjmp() 跳转回这个跳转点上，以此来实现当发生异常时，转到处理异常的程序上，在其后的介绍中将介绍如何实现。 setjmp() 为跳转返回保存现场并为异常提供处理程序，longjmp() 则进行跳转（抛出异常），setjmp() 与 longjmp() 可以在函数间进行跳转，这就像一个全局的 goto 语句，可以跨函数跳转。

jmp_buf 异常结构

 使用 setjmp() 及 longjmp() 函数前，需要先认识一下 jmp_buf 异常结构。jmp_buf 将使用在 setjmp() 函数中，用于保存当前程序现场（保存当前需要用到的寄存器的值），jmp_buf 结构在 setjmp.h 文件内声明：

 typedef struct
 &leftsign;
 unsigned j_sp;  // 堆栈指针寄存器
 unsigned j_ss;  // 堆栈段
 unsigned j_flag;  // 标志寄存器
 unsigned j_cs;  // 代码段
 unsigned j_ip;  // 指令指针寄存器
 unsigned j_bp; // 基址指针
 unsigned j_di;  // 目的指针
 unsigned j_es; // 附加段
 unsigned j_si;  // 源变址
 unsigned j_ds; // 数据段
 &rightsign; jmp_buf;

 jmp_buf 结构存放了程序当前寄存器的值，以确保使用 longjmp() 后可以跳回到该执行点上继续执行。

setjmp() 与 longjmp() 函数都使用了 jmp_buf 结构作为形参，它们的调用关系是这样的：
 首先调用 setjmp() 函数来初始化 jmp_buf 结构变量 jmpb，将当前CPU中的大部分影响到程序执行的积存器存入 jmpb，为 longjmp() 函数提供跳转，setjmp() 函数是一个有趣的函数，它能返回两次，它应该是所有库函数中唯一一个能返回两次的函数，第一次是初始化时，返回零，第二次遇到 longjmp() 函数调用后，longjmp() 函数使 setjmp() 函数发生第二次返回，返回值由 longjmp() 的第二个参数给出（整型，这时不应该再返回零）。
 在使用 setjmp() 初始化 jmpb 后，可以其后的程序中任意地方使用 longjmp() 函数跳转会 setjmp() 函数的位置，longjmp() 的第一个参数便是 setjmp() 初始化的 jmpb，若想跳转回刚才设置的 setjmp() 处，则 longjmp() 函数的第一个参数是 setjmp() 所初始化的 jmpb 这个异常，这也说明一件事，即 jmpb 这个异常，一般需要定义为全局变量，否则，若是局部变量，当跨函数调用时就几乎无法使用（除非每次遇到函数调用都将 jmpb 以参数传递，然而明显地，是不值得这样做的）；longjmp() 函数的第二个参数是传给 setjmp() 的第二次返回值