setjmp.h is a header defined in the C standard library to provide "non-local jumps": control flow that deviates from the usual subroutine call and return sequence. The complementary functionssetjmp
and longjmp
provide this functionality.
A typical use of setjmp
/longjmp
is implementation of anexception mechanism that exploits the ability of longjmp
to reestablish program or thread state, even across multiple levels of function calls. A less common use ofsetjmp
is to create syntax similar to coroutines.
Member functions
int setjmp(jmp_buf env) | Sets up the local jmp_buf buffer and initializes it for the jump. This routine[1] saves the program's calling environment in the environment buffer specified by theenv argument for later use by longjmp . If the return is from a direct invocation,setjmp returns 0. If the return is from a call to longjmp ,setjmp returns a nonzero value. |
void longjmp(jmp_buf env, int value) | Restores the context of the environment buffer env that was saved by invocation of thesetjmp routine[1] in the same invocation of the program. Invoking longjmp from a nested signal handler is undefined. The value specified by value is passed from longjmp tosetjmp . After longjmp is completed, program execution continues as if the corresponding invocation ofsetjmp had just returned. If the value passed to longjmp is 0, setjmp will behave as if it had returned 1; otherwise, it will behave as if it had returnedvalue . |
|
setjmp
saves the current environment (i.e., the program state) at some point of program execution, into a platform-specific data structure (jmp_buf
) which can be used, at some later point of program execution, bylongjmp
to restore the program state to that which was saved by setjmp
into jmp_buf
. This process can be imagined to be a "jump" back to the point of program execution wheresetjmp
saved the environment. The (apparent) return value from setjmp
indicates whether control reached that point normally or from a call tolongjmp
. This leads to a common idiom: if( setjmp(x) ){/* handle longjmp(x) */}
.
POSIX.1 does not specify whethersetjmp
and longjmp
save or restore the current set of blockedsignals — if a program employs signal handling it should use POSIX's sigsetjmp
/siglongjmp
.
Member types
jmp_buf | An array type, such as struct __jmp_buf_tag[1] ,[2] suitable for holding the information needed to restore a calling environment. |
The C99 Rationale describes jmp_buf
as being an array type for backwards compatibility; existing code refers to jmp_buf
storage locations by name (without the&
address-of operator), which is only possible for array types.[3]
Caveats and limitations
When a "non-local goto" is executed via setjmp
/longjmp
, normal "stack unwinding" does not occur. Therefore any required cleanup actions will not occur either. This could include closing file descriptors, flushing buffers, or freeing heap-allocated memory.
If the function in which setjmp
was called returns, it is no longer possible to safely uselongjmp
with the corresponding jmp_buf
object. This is because thestack frame is invalidated when the function returns. Calling longjmp
restores thestack pointer, which—because the function returned—would point to a non-existent and potentially overwritten or corrupted stack frame.[4][5]
Similarly, C99 does not require that longjmp
preserve the current stack frame. This means that jumping into a function which was exited via a call tolongjmp
is undefined.[6] However, most implementations of longjmp
leave the stack frame intact, allowing setjmp
andlongjmp
to be used to jump back-and-forth between two or more functions—a feature exploited formultitasking.
Compared to mechanisms in higher-level programming languages such as Python, Java, C++, C#, and even pre-C languages such as Algol 60, the technique of using setjmp
/longjmp
to implement an exception mechanism is cumbersome. These languages provide more powerfulexception handling techniques, while languages such as Scheme, Smalltalk, and Haskell provide even more general continuation-handling constructs.
example:
#include <stdio.h>
#include <stdlib.h>
#include <setjmp.h>
jmp_buf buf;
void banana()
{
printf("in banana() \n");
longjmp(buf,2);
printf("you'll never see this,because i longjmp'd");
}
main()
{
int rvalu;
rvalu = setjmp(buf);
if(rvalu)
{
printf("back in main\n");
printf("return value is %d\n", rvalu); //输出值为,longjmp的第二个参数的值,可根据这个值,判断发生异常的事情
}
else
{
printf("first time through\n");
banana();
}
}