2011-05-29 Janus Weil <janus@gcc.gnu.org>
[official-gcc.git] / libgomp / omp.h.in
blob0198b8fd7ec9817492b924ca5a9f0ca192952fa3
1 /* Copyright (C) 2005, 2007, 2008, 2009 Free Software Foundation, Inc.
2 Contributed by Richard Henderson <rth@redhat.com>.
4 This file is part of the GNU OpenMP Library (libgomp).
6 Libgomp is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3, or (at your option)
9 any later version.
11 Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13 FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 more details.
16 Under Section 7 of GPL version 3, you are granted additional
17 permissions described in the GCC Runtime Library Exception, version
18 3.1, as published by the Free Software Foundation.
20 You should have received a copy of the GNU General Public License and
21 a copy of the GCC Runtime Library Exception along with this program;
22 see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 <http://www.gnu.org/licenses/>. */
25 #ifndef OMP_H
26 #define OMP_H 1
28 #ifndef _LIBGOMP_OMP_LOCK_DEFINED
29 #define _LIBGOMP_OMP_LOCK_DEFINED 1
30 /* These two structures get edited by the libgomp build process to
31 reflect the shape of the two types. Their internals are private
32 to the library. */
34 typedef struct
36 unsigned char _x[@OMP_LOCK_SIZE@]
37 __attribute__((__aligned__(@OMP_LOCK_ALIGN@)));
38 } omp_lock_t;
40 typedef struct
42 unsigned char _x[@OMP_NEST_LOCK_SIZE@]
43 __attribute__((__aligned__(@OMP_NEST_LOCK_ALIGN@)));
44 } omp_nest_lock_t;
45 #endif
47 typedef enum omp_sched_t
49 omp_sched_static = 1,
50 omp_sched_dynamic = 2,
51 omp_sched_guided = 3,
52 omp_sched_auto = 4
53 } omp_sched_t;
55 #ifdef __cplusplus
56 extern "C" {
57 # define __GOMP_NOTHROW throw ()
58 #else
59 # define __GOMP_NOTHROW __attribute__((__nothrow__))
60 #endif
62 extern void omp_set_num_threads (int) __GOMP_NOTHROW;
63 extern int omp_get_num_threads (void) __GOMP_NOTHROW;
64 extern int omp_get_max_threads (void) __GOMP_NOTHROW;
65 extern int omp_get_thread_num (void) __GOMP_NOTHROW;
66 extern int omp_get_num_procs (void) __GOMP_NOTHROW;
68 extern int omp_in_parallel (void) __GOMP_NOTHROW;
70 extern void omp_set_dynamic (int) __GOMP_NOTHROW;
71 extern int omp_get_dynamic (void) __GOMP_NOTHROW;
73 extern void omp_set_nested (int) __GOMP_NOTHROW;
74 extern int omp_get_nested (void) __GOMP_NOTHROW;
76 extern void omp_init_lock (omp_lock_t *) __GOMP_NOTHROW;
77 extern void omp_destroy_lock (omp_lock_t *) __GOMP_NOTHROW;
78 extern void omp_set_lock (omp_lock_t *) __GOMP_NOTHROW;
79 extern void omp_unset_lock (omp_lock_t *) __GOMP_NOTHROW;
80 extern int omp_test_lock (omp_lock_t *) __GOMP_NOTHROW;
82 extern void omp_init_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
83 extern void omp_destroy_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
84 extern void omp_set_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
85 extern void omp_unset_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
86 extern int omp_test_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
88 extern double omp_get_wtime (void) __GOMP_NOTHROW;
89 extern double omp_get_wtick (void) __GOMP_NOTHROW;
91 void omp_set_schedule (omp_sched_t, int) __GOMP_NOTHROW;
92 void omp_get_schedule (omp_sched_t *, int *) __GOMP_NOTHROW;
93 int omp_get_thread_limit (void) __GOMP_NOTHROW;
94 void omp_set_max_active_levels (int) __GOMP_NOTHROW;
95 int omp_get_max_active_levels (void) __GOMP_NOTHROW;
96 int omp_get_level (void) __GOMP_NOTHROW;
97 int omp_get_ancestor_thread_num (int) __GOMP_NOTHROW;
98 int omp_get_team_size (int) __GOMP_NOTHROW;
99 int omp_get_active_level (void) __GOMP_NOTHROW;
101 #ifdef __cplusplus
103 #endif
105 #endif /* OMP_H */