Update copyright notices with scripts/update-copyrights.
[jlayton/glibc.git] / stdlib / ucontext.h
1 /* Copyright (C) 1997-2013 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 /* System V ABI compliant user-level context switching support.  */
19
20 #ifndef _UCONTEXT_H
21 #define _UCONTEXT_H     1
22
23 #include <features.h>
24
25 /* Get machine dependent definition of data structures.  */
26 #include <sys/ucontext.h>
27
28 __BEGIN_DECLS
29
30 /* Get user context and store it in variable pointed to by UCP.  */
31 extern int getcontext (ucontext_t *__ucp) __THROWNL;
32
33 /* Set user context from information of variable pointed to by UCP.  */
34 extern int setcontext (const ucontext_t *__ucp) __THROWNL;
35
36 /* Save current context in context variable pointed to by OUCP and set
37    context from variable pointed to by UCP.  */
38 extern int swapcontext (ucontext_t *__restrict __oucp,
39                         const ucontext_t *__restrict __ucp) __THROWNL;
40
41 /* Manipulate user context UCP to continue with calling functions FUNC
42    and the ARGC-1 parameters following ARGC when the context is used
43    the next time in `setcontext' or `swapcontext'.
44
45    We cannot say anything about the parameters FUNC takes; `void'
46    is as good as any other choice.  */
47 extern void makecontext (ucontext_t *__ucp, void (*__func) (void),
48                          int __argc, ...) __THROW;
49
50 __END_DECLS
51
52 #endif /* ucontext.h */