setjmp.h 3.6 KB

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