xref: /dragonfly/contrib/gcc-8.0/libgomp/omp.h.in (revision 6a3cbbc2)
1/* Copyright (C) 2005-2018 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
35typedef struct
36{
37  unsigned char _x[@OMP_LOCK_SIZE@]
38    __attribute__((__aligned__(@OMP_LOCK_ALIGN@)));
39} omp_lock_t;
40
41typedef struct
42{
43  unsigned char _x[@OMP_NEST_LOCK_SIZE@]
44    __attribute__((__aligned__(@OMP_NEST_LOCK_ALIGN@)));
45} omp_nest_lock_t;
46#endif
47
48typedef enum omp_sched_t
49{
50  omp_sched_static = 1,
51  omp_sched_dynamic = 2,
52  omp_sched_guided = 3,
53  omp_sched_auto = 4
54} omp_sched_t;
55
56typedef enum omp_proc_bind_t
57{
58  omp_proc_bind_false = 0,
59  omp_proc_bind_true = 1,
60  omp_proc_bind_master = 2,
61  omp_proc_bind_close = 3,
62  omp_proc_bind_spread = 4
63} omp_proc_bind_t;
64
65typedef enum omp_lock_hint_t
66{
67  omp_lock_hint_none = 0,
68  omp_lock_hint_uncontended = 1,
69  omp_lock_hint_contended = 2,
70  omp_lock_hint_nonspeculative = 4,
71  omp_lock_hint_speculative = 8,
72} omp_lock_hint_t;
73
74#ifdef __cplusplus
75extern "C" {
76# define __GOMP_NOTHROW throw ()
77#else
78# define __GOMP_NOTHROW __attribute__((__nothrow__))
79#endif
80
81extern void omp_set_num_threads (int) __GOMP_NOTHROW;
82extern int omp_get_num_threads (void) __GOMP_NOTHROW;
83extern int omp_get_max_threads (void) __GOMP_NOTHROW;
84extern int omp_get_thread_num (void) __GOMP_NOTHROW;
85extern int omp_get_num_procs (void) __GOMP_NOTHROW;
86
87extern int omp_in_parallel (void) __GOMP_NOTHROW;
88
89extern void omp_set_dynamic (int) __GOMP_NOTHROW;
90extern int omp_get_dynamic (void) __GOMP_NOTHROW;
91
92extern void omp_set_nested (int) __GOMP_NOTHROW;
93extern int omp_get_nested (void) __GOMP_NOTHROW;
94
95extern void omp_init_lock (omp_lock_t *) __GOMP_NOTHROW;
96extern void omp_init_lock_with_hint (omp_lock_t *, omp_lock_hint_t)
97  __GOMP_NOTHROW;
98extern void omp_destroy_lock (omp_lock_t *) __GOMP_NOTHROW;
99extern void omp_set_lock (omp_lock_t *) __GOMP_NOTHROW;
100extern void omp_unset_lock (omp_lock_t *) __GOMP_NOTHROW;
101extern int omp_test_lock (omp_lock_t *) __GOMP_NOTHROW;
102
103extern void omp_init_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
104extern void omp_init_nest_lock_with_hint (omp_nest_lock_t *, omp_lock_hint_t)
105  __GOMP_NOTHROW;
106extern void omp_destroy_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
107extern void omp_set_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
108extern void omp_unset_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
109extern int omp_test_nest_lock (omp_nest_lock_t *) __GOMP_NOTHROW;
110
111extern double omp_get_wtime (void) __GOMP_NOTHROW;
112extern double omp_get_wtick (void) __GOMP_NOTHROW;
113
114extern void omp_set_schedule (omp_sched_t, int) __GOMP_NOTHROW;
115extern void omp_get_schedule (omp_sched_t *, int *) __GOMP_NOTHROW;
116extern int omp_get_thread_limit (void) __GOMP_NOTHROW;
117extern void omp_set_max_active_levels (int) __GOMP_NOTHROW;
118extern int omp_get_max_active_levels (void) __GOMP_NOTHROW;
119extern int omp_get_level (void) __GOMP_NOTHROW;
120extern int omp_get_ancestor_thread_num (int) __GOMP_NOTHROW;
121extern int omp_get_team_size (int) __GOMP_NOTHROW;
122extern int omp_get_active_level (void) __GOMP_NOTHROW;
123
124extern int omp_in_final (void) __GOMP_NOTHROW;
125
126extern int omp_get_cancellation (void) __GOMP_NOTHROW;
127extern omp_proc_bind_t omp_get_proc_bind (void) __GOMP_NOTHROW;
128extern int omp_get_num_places (void) __GOMP_NOTHROW;
129extern int omp_get_place_num_procs (int) __GOMP_NOTHROW;
130extern void omp_get_place_proc_ids (int, int *) __GOMP_NOTHROW;
131extern int omp_get_place_num (void) __GOMP_NOTHROW;
132extern int omp_get_partition_num_places (void) __GOMP_NOTHROW;
133extern void omp_get_partition_place_nums (int *) __GOMP_NOTHROW;
134
135extern void omp_set_default_device (int) __GOMP_NOTHROW;
136extern int omp_get_default_device (void) __GOMP_NOTHROW;
137extern int omp_get_num_devices (void) __GOMP_NOTHROW;
138extern int omp_get_num_teams (void) __GOMP_NOTHROW;
139extern int omp_get_team_num (void) __GOMP_NOTHROW;
140
141extern int omp_is_initial_device (void) __GOMP_NOTHROW;
142extern int omp_get_initial_device (void) __GOMP_NOTHROW;
143extern int omp_get_max_task_priority (void) __GOMP_NOTHROW;
144
145extern void *omp_target_alloc (__SIZE_TYPE__, int) __GOMP_NOTHROW;
146extern void omp_target_free (void *, int) __GOMP_NOTHROW;
147extern int omp_target_is_present (void *, int) __GOMP_NOTHROW;
148extern int omp_target_memcpy (void *, void *, __SIZE_TYPE__, __SIZE_TYPE__,
149			      __SIZE_TYPE__, int, int) __GOMP_NOTHROW;
150extern int omp_target_memcpy_rect (void *, void *, __SIZE_TYPE__, int,
151				   const __SIZE_TYPE__ *,
152				   const __SIZE_TYPE__ *,
153				   const __SIZE_TYPE__ *,
154				   const __SIZE_TYPE__ *,
155				   const __SIZE_TYPE__ *, int, int)
156  __GOMP_NOTHROW;
157extern int omp_target_associate_ptr (void *, void *, __SIZE_TYPE__,
158				     __SIZE_TYPE__, int) __GOMP_NOTHROW;
159extern int omp_target_disassociate_ptr (void *, int) __GOMP_NOTHROW;
160
161#ifdef __cplusplus
162}
163#endif
164
165#endif /* _OMP_H */
166