omp.h
1 /* Copyright (C) 2005-2015 Free Software Foundation, Inc.
2  Contributed by Richard Henderson <rth@redhat.com>.
3 
4  This file is part of the GNU Offloading and Multi Processing Library
5  (libgomp).
6 
7  Libgomp is free software; you can redistribute it and/or modify it
8  under the terms of the GNU General Public License as published by
9  the Free Software Foundation; either version 3, or (at your option)
10  any later version.
11 
12  Libgomp is distributed in the hope that it will be useful, but WITHOUT ANY
13  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14  FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15  more details.
16 
17  Under Section 7 of GPL version 3, you are granted additional
18  permissions described in the GCC Runtime Library Exception, version
19  3.1, as published by the Free Software Foundation.
20 
21  You should have received a copy of the GNU General Public License and
22  a copy of the GCC Runtime Library Exception along with this program;
23  see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24  <http://www.gnu.org/licenses/>. */
25 
26 #ifndef _OMP_H
27 #define _OMP_H 1
28 
29 #ifndef _LIBGOMP_OMP_LOCK_DEFINED
30 #define _LIBGOMP_OMP_LOCK_DEFINED 1
31 /* These two structures get edited by the libgomp build process to
32  reflect the shape of the two types. Their internals are private
33  to the library. */
34 
35 typedef struct {
36  unsigned char _x[4]
37  __attribute__((__aligned__(4)));
38 } omp_lock_t;
39 
40 typedef struct {
41 #if defined(__linux__)
42  unsigned char _x[8 + sizeof (void*)]
43  __attribute__((__aligned__(sizeof (void*))));
44 #else
45  unsigned char _x[16]
46  __attribute__((__aligned__(8)));
47 #endif
49 #endif
50 
51 typedef enum omp_sched_t {
52  omp_sched_static = 1,
53  omp_sched_dynamic = 2,
54  omp_sched_guided = 3,
55  omp_sched_auto = 4
56 } omp_sched_t;
57 
58 typedef enum omp_proc_bind_t {
59  omp_proc_bind_false = 0,
60  omp_proc_bind_true = 1,
61  omp_proc_bind_master = 2,
62  omp_proc_bind_close = 3,
63  omp_proc_bind_spread = 4
64 } omp_proc_bind_t;
65 
66 #ifdef __cplusplus
67 extern "C" {
68 # define __GOMP_NOTHROW throw ()
69 #else
70 # define __GOMP_NOTHROW __attribute__((__nothrow__))
71 #endif
72 
73 extern void omp_set_num_threads (int) __GOMP_NOTHROW;
74 extern int omp_get_num_threads (void) __GOMP_NOTHROW;
75 extern int omp_get_max_threads (void) __GOMP_NOTHROW;
76 extern int omp_get_thread_num (void) __GOMP_NOTHROW;
77 extern int omp_get_num_procs (void) __GOMP_NOTHROW;
78 
79 extern int omp_in_parallel (void) __GOMP_NOTHROW;
80 
81 extern void omp_set_dynamic (int) __GOMP_NOTHROW;
82 extern int omp_get_dynamic (void) __GOMP_NOTHROW;
83 
84 extern void omp_set_nested (int) __GOMP_NOTHROW;
85 extern int omp_get_nested (void) __GOMP_NOTHROW;
86 
87 extern void omp_init_lock (omp_lock_t*) __GOMP_NOTHROW;
88 extern void omp_destroy_lock (omp_lock_t*) __GOMP_NOTHROW;
89 extern void omp_set_lock (omp_lock_t*) __GOMP_NOTHROW;
90 extern void omp_unset_lock (omp_lock_t*) __GOMP_NOTHROW;
91 extern int omp_test_lock (omp_lock_t*) __GOMP_NOTHROW;
92 
93 extern void omp_init_nest_lock (omp_nest_lock_t*) __GOMP_NOTHROW;
94 extern void omp_destroy_nest_lock (omp_nest_lock_t*) __GOMP_NOTHROW;
95 extern void omp_set_nest_lock (omp_nest_lock_t*) __GOMP_NOTHROW;
96 extern void omp_unset_nest_lock (omp_nest_lock_t*) __GOMP_NOTHROW;
97 extern int omp_test_nest_lock (omp_nest_lock_t*) __GOMP_NOTHROW;
98 
99 extern double omp_get_wtime (void) __GOMP_NOTHROW;
100 extern double omp_get_wtick (void) __GOMP_NOTHROW;
101 
102 extern void omp_set_schedule (omp_sched_t, int) __GOMP_NOTHROW;
103 extern void omp_get_schedule (omp_sched_t*, int*) __GOMP_NOTHROW;
104 extern int omp_get_thread_limit (void) __GOMP_NOTHROW;
105 extern void omp_set_max_active_levels (int) __GOMP_NOTHROW;
106 extern int omp_get_max_active_levels (void) __GOMP_NOTHROW;
107 extern int omp_get_level (void) __GOMP_NOTHROW;
108 extern int omp_get_ancestor_thread_num (int) __GOMP_NOTHROW;
109 extern int omp_get_team_size (int) __GOMP_NOTHROW;
110 extern int omp_get_active_level (void) __GOMP_NOTHROW;
111 
112 extern int omp_in_final (void) __GOMP_NOTHROW;
113 
114 extern int omp_get_cancellation (void) __GOMP_NOTHROW;
115 extern omp_proc_bind_t omp_get_proc_bind (void) __GOMP_NOTHROW;
116 
117 extern void omp_set_default_device (int) __GOMP_NOTHROW;
118 extern int omp_get_default_device (void) __GOMP_NOTHROW;
119 extern int omp_get_num_devices (void) __GOMP_NOTHROW;
120 extern int omp_get_num_teams (void) __GOMP_NOTHROW;
121 extern int omp_get_team_num (void) __GOMP_NOTHROW;
122 
123 extern int omp_is_initial_device (void) __GOMP_NOTHROW;
124 
125 #ifdef __cplusplus
126 }
127 #endif
128 
129 #endif /* _OMP_H */
Definition: omp.h:40
Definition: omp.h:35