setjmp/setjmp.h

   1 /* Copyright (C) 1991-2023 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    <https://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/types/struct___jmp_buf_tag.h>
  31
  32 typedef struct __jmp_buf_tag jmp_buf[1];
  33
  34 /* Store the calling environment in ENV, also saving the signal mask.
  35    Return 0.  */
  36 extern int setjmp (jmp_buf __env) __THROWNL;
  37
  38 /* Store the calling environment in ENV, also saving the
  39    signal mask if SAVEMASK is nonzero.  Return 0.
  40    This is the internal name for `sigsetjmp'.  */
  41 extern int __sigsetjmp (struct __jmp_buf_tag __env[1], int __savemask) __THROWNL;
  42
  43 /* Store the calling environment in ENV, not saving the signal mask.
  44    Return 0.  */
  45 extern int _setjmp (struct __jmp_buf_tag __env[1]) __THROWNL;
  46
  47 /* Do not save the signal mask.  This is equivalent to the `_setjmp'
  48    BSD function.  */
  49 #define setjmp(env)     _setjmp (env)
  50
  51
  52 /* Jump to the environment saved in ENV, making the
  53    `setjmp' call there return VAL, or 1 if VAL is 0.  */
  54 extern void longjmp (struct __jmp_buf_tag __env[1], int __val)
  55      __THROWNL __attribute__ ((__noreturn__));
  56
  57 #if defined __USE_MISC || defined __USE_XOPEN
  58 /* Same.  Usually `_longjmp' is used with `_setjmp', which does not save
  59    the signal mask.  But it is how ENV was saved that determines whether
  60    `longjmp' restores the mask; `_longjmp' is just an alias.  */
  61 extern void _longjmp (struct __jmp_buf_tag __env[1], int __val)
  62      __THROWNL __attribute__ ((__noreturn__));
  63 #endif
  64
  65
  66 #ifdef  __USE_POSIX
  67 /* Use the same type for `jmp_buf' and `sigjmp_buf'.
  68    The `__mask_was_saved' flag determines whether
  69    or not `longjmp' will restore the signal mask.  */
  70 typedef struct __jmp_buf_tag sigjmp_buf[1];
  71
  72 /* Store the calling environment in ENV, also saving the
  73    signal mask if SAVEMASK is nonzero.  Return 0.  */
  74 # define sigsetjmp(env, savemask)       __sigsetjmp (env, savemask)
  75
  76 /* Jump to the environment saved in ENV, making the
  77    sigsetjmp call there return VAL, or 1 if VAL is 0.
  78    Restore the signal mask if that sigsetjmp call saved it.
  79    This is just an alias `longjmp'.  */
  80 extern void siglongjmp (sigjmp_buf __env, int __val)
  81      __THROWNL __attribute__ ((__noreturn__));
  82 #endif /* Use POSIX.  */
  83
  84
  85 /* Define helper functions to catch unsafe code.  */
  86 #if __USE_FORTIFY_LEVEL > 0
  87 # include <bits/setjmp2.h>
  88 #endif
  89
  90 __END_DECLS
  91
  92 #endif /* setjmp.h  */