Clang Project

include/setjmp.h
1/* Copyright (C) 1991-2016 Free Software Foundation, Inc.
2   This file is part of the GNU C Library.
3
4   The GNU C Library is free software; you can redistribute it and/or
5   modify it under the terms of the GNU Lesser General Public
6   License as published by the Free Software Foundation; either
7   version 2.1 of the License, or (at your option) any later version.
8
9   The GNU C Library is distributed in the hope that it will be useful,
10   but WITHOUT ANY WARRANTY; without even the implied warranty of
11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12   Lesser General Public License for more details.
13
14   You should have received a copy of the GNU Lesser General Public
15   License along with the GNU C Library; if not, see
16   <http://www.gnu.org/licenses/>.  */
17
18/*
19 * ISO C99 Standard: 7.13 Nonlocal jumps <setjmp.h>
20 */
21
22#ifndef _SETJMP_H
23#define _SETJMP_H 1
24
25#include <features.h>
26
27__BEGIN_DECLS
28
29#include <bits/setjmp.h> /* Get `__jmp_buf'.  */
30#include <bits/sigset.h> /* Get `__sigset_t'.  */
31
32
33/* Calling environment, plus possibly a saved signal mask.  */
34struct __jmp_buf_tag
35  {
36    /* NOTE: The machine-dependent definitions of `__sigsetjmp'
37       assume that a `jmp_buf' begins with a `__jmp_buf' and that
38       `__mask_was_saved' follows it.  Do not move these members
39       or add others before it.  */
40    __jmp_buf __jmpbuf; /* Calling environment.  */
41    int __mask_was_saved; /* Saved the signal mask?  */
42    __sigset_t __saved_mask; /* Saved signal mask.  */
43  };
44
45
46__BEGIN_NAMESPACE_STD
47
48typedef struct __jmp_buf_tag jmp_buf[1];
49
50/* Store the calling environment in ENV, also saving the signal mask.
51   Return 0.  */
52extern int setjmp (jmp_buf __env__THROWNL;
53
54__END_NAMESPACE_STD
55
56/* Store the calling environment in ENV, also saving the
57   signal mask if SAVEMASK is nonzero.  Return 0.
58   This is the internal name for `sigsetjmp'.  */
59extern int __sigsetjmp (struct __jmp_buf_tag __env[1], int __savemask__THROWNL;
60
61/* Store the calling environment in ENV, not saving the signal mask.
62   Return 0.  */
63extern int _setjmp (struct __jmp_buf_tag __env[1]) __THROWNL;
64
65/* Do not save the signal mask.  This is equivalent to the `_setjmp'
66   BSD function.  */
67#define setjmp(env) _setjmp (env)
68
69
70__BEGIN_NAMESPACE_STD
71
72/* Jump to the environment saved in ENV, making the
73   `setjmp' call there return VAL, or 1 if VAL is 0.  */
74extern void longjmp (struct __jmp_buf_tag __env[1], int __val)
75     __THROWNL __attribute__ ((__noreturn__));
76
77__END_NAMESPACE_STD
78
79#if defined __USE_MISC || defined __USE_XOPEN
80/* Same.  Usually `_longjmp' is used with `_setjmp', which does not save
81   the signal mask.  But it is how ENV was saved that determines whether
82   `longjmp' restores the mask; `_longjmp' is just an alias.  */
83extern void _longjmp (struct __jmp_buf_tag __env[1], int __val)
84     __THROWNL __attribute__ ((__noreturn__));
85#endif
86
87
88#ifdef __USE_POSIX
89/* Use the same type for `jmp_buf' and `sigjmp_buf'.
90   The `__mask_was_saved' flag determines whether
91   or not `longjmp' will restore the signal mask.  */
92typedef struct __jmp_buf_tag sigjmp_buf[1];
93
94/* Store the calling environment in ENV, also saving the
95   signal mask if SAVEMASK is nonzero.  Return 0.  */
96define sigsetjmp(env, savemask) __sigsetjmp (env, savemask)
97
98/* Jump to the environment saved in ENV, making the
99   sigsetjmp call there return VAL, or 1 if VAL is 0.
100   Restore the signal mask if that sigsetjmp call saved it.
101   This is just an alias `longjmp'.  */
102extern void siglongjmp (sigjmp_buf __envint __val)
103     __THROWNL __attribute__ ((__noreturn__));
104#endif /* Use POSIX.  */
105
106
107/* Define helper functions to catch unsafe code.  */
108#if __USE_FORTIFY_LEVEL > 0
109include <bits/setjmp2.h>
110#endif
111
112__END_DECLS
113
114#endif /* setjmp.h  */
115
__jmp_buf_tag::__jmpbuf
__jmp_buf_tag::__mask_was_saved
__jmp_buf_tag::__saved_mask