2008-05-20 Gary Dismukes <dismukes@adacore.com>
[official-gcc.git] / gcc / omp-builtins.def
blobcc450f6d4d628f2ebc775b1e6a9d7827c506dd66
1 /* This file contains the definitions and documentation for the
2 OpenMP builtins used in the GNU compiler.
3 Copyright (C) 2005, 2007 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 /* Before including this file, you should define a macro:
23 DEF_GOMP_BUILTIN (ENUM, NAME, TYPE, ATTRS)
25 See builtins.def for details. */
27 DEF_GOMP_BUILTIN (BUILT_IN_OMP_GET_THREAD_NUM, "omp_get_thread_num",
28 BT_FN_INT, ATTR_CONST_NOTHROW_LIST)
29 DEF_GOMP_BUILTIN (BUILT_IN_OMP_GET_NUM_THREADS, "omp_get_num_threads",
30 BT_FN_INT, ATTR_CONST_NOTHROW_LIST)
32 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_ATOMIC_START, "GOMP_atomic_start",
33 BT_FN_VOID, ATTR_NOTHROW_LIST)
34 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_ATOMIC_END, "GOMP_atomic_end",
35 BT_FN_VOID, ATTR_NOTHROW_LIST)
36 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_BARRIER, "GOMP_barrier",
37 BT_FN_VOID, ATTR_NOTHROW_LIST)
38 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_CRITICAL_START, "GOMP_critical_start",
39 BT_FN_VOID, ATTR_NOTHROW_LIST)
40 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_CRITICAL_END, "GOMP_critical_end",
41 BT_FN_VOID, ATTR_NOTHROW_LIST)
42 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_CRITICAL_NAME_START,
43 "GOMP_critical_name_start",
44 BT_FN_VOID_PTRPTR, ATTR_NOTHROW_LIST)
45 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_CRITICAL_NAME_END,
46 "GOMP_critical_name_end",
47 BT_FN_VOID_PTRPTR, ATTR_NOTHROW_LIST)
48 /* NOTE: Do not change the order of BUILT_IN_GOMP_LOOP_*_START. They
49 are used in index arithmetic with enum omp_clause_schedule_kind
50 in omp-low.c. */
51 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_STATIC_START,
52 "GOMP_loop_static_start",
53 BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
54 ATTR_NOTHROW_LIST)
55 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_DYNAMIC_START,
56 "GOMP_loop_dynamic_start",
57 BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
58 ATTR_NOTHROW_LIST)
59 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_GUIDED_START,
60 "GOMP_loop_guided_start",
61 BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
62 ATTR_NOTHROW_LIST)
63 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_RUNTIME_START,
64 "GOMP_loop_runtime_start",
65 BT_FN_BOOL_LONG_LONG_LONG_LONGPTR_LONGPTR,
66 ATTR_NOTHROW_LIST)
67 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_STATIC_START,
68 "GOMP_loop_ordered_static_start",
69 BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
70 ATTR_NOTHROW_LIST)
71 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_DYNAMIC_START,
72 "GOMP_loop_ordered_dynamic_start",
73 BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
74 ATTR_NOTHROW_LIST)
75 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_GUIDED_START,
76 "GOMP_loop_ordered_guided_start",
77 BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
78 ATTR_NOTHROW_LIST)
79 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_RUNTIME_START,
80 "GOMP_loop_ordered_runtime_start",
81 BT_FN_BOOL_LONG_LONG_LONG_LONGPTR_LONGPTR,
82 ATTR_NOTHROW_LIST)
83 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_STATIC_NEXT, "GOMP_loop_static_next",
84 BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LIST)
85 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_DYNAMIC_NEXT, "GOMP_loop_dynamic_next",
86 BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LIST)
87 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_GUIDED_NEXT, "GOMP_loop_guided_next",
88 BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LIST)
89 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_RUNTIME_NEXT, "GOMP_loop_runtime_next",
90 BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LIST)
91 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_STATIC_NEXT,
92 "GOMP_loop_ordered_static_next",
93 BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LIST)
94 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_DYNAMIC_NEXT,
95 "GOMP_loop_ordered_dynamic_next",
96 BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LIST)
97 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_GUIDED_NEXT,
98 "GOMP_loop_ordered_guided_next",
99 BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LIST)
100 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_RUNTIME_NEXT,
101 "GOMP_loop_ordered_runtime_next",
102 BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LIST)
103 /* NOTE: Do not change the order of BUILT_IN_GOMP_PARALLEL_LOOP_*_START.
104 They are used in index arithmetic with enum omp_clause_schedule_kind
105 in omp-low.c. */
106 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_LOOP_STATIC_START,
107 "GOMP_parallel_loop_static_start",
108 BT_FN_VOID_OMPFN_PTR_UINT_LONG_LONG_LONG_LONG,
109 ATTR_NOTHROW_LIST)
110 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_LOOP_DYNAMIC_START,
111 "GOMP_parallel_loop_dynamic_start",
112 BT_FN_VOID_OMPFN_PTR_UINT_LONG_LONG_LONG_LONG,
113 ATTR_NOTHROW_LIST)
114 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_LOOP_GUIDED_START,
115 "GOMP_parallel_loop_guided_start",
116 BT_FN_VOID_OMPFN_PTR_UINT_LONG_LONG_LONG_LONG,
117 ATTR_NOTHROW_LIST)
118 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_LOOP_RUNTIME_START,
119 "GOMP_parallel_loop_runtime_start",
120 BT_FN_VOID_OMPFN_PTR_UINT_LONG_LONG_LONG,
121 ATTR_NOTHROW_LIST)
122 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_END, "GOMP_loop_end",
123 BT_FN_VOID, ATTR_NOTHROW_LIST)
124 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_END_NOWAIT, "GOMP_loop_end_nowait",
125 BT_FN_VOID, ATTR_NOTHROW_LIST)
126 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_ORDERED_START, "GOMP_ordered_start",
127 BT_FN_VOID, ATTR_NOTHROW_LIST)
128 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_ORDERED_END, "GOMP_ordered_end",
129 BT_FN_VOID, ATTR_NOTHROW_LIST)
130 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_START, "GOMP_parallel_start",
131 BT_FN_VOID_OMPFN_PTR_UINT, ATTR_NOTHROW_LIST)
132 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_END, "GOMP_parallel_end",
133 BT_FN_VOID, ATTR_NOTHROW_LIST)
134 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SECTIONS_START, "GOMP_sections_start",
135 BT_FN_UINT_UINT, ATTR_NOTHROW_LIST)
136 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SECTIONS_NEXT, "GOMP_sections_next",
137 BT_FN_UINT, ATTR_NOTHROW_LIST)
138 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_SECTIONS_START,
139 "GOMP_parallel_sections_start",
140 BT_FN_VOID_OMPFN_PTR_UINT_UINT, ATTR_NOTHROW_LIST)
141 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SECTIONS_END, "GOMP_sections_end",
142 BT_FN_VOID, ATTR_NOTHROW_LIST)
143 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SECTIONS_END_NOWAIT,
144 "GOMP_sections_end_nowait",
145 BT_FN_VOID, ATTR_NOTHROW_LIST)
146 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SINGLE_START, "GOMP_single_start",
147 BT_FN_BOOL, ATTR_NOTHROW_LIST)
148 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SINGLE_COPY_START, "GOMP_single_copy_start",
149 BT_FN_PTR, ATTR_NOTHROW_LIST)
150 DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SINGLE_COPY_END, "GOMP_single_copy_end",
151 BT_FN_VOID_PTR, ATTR_NOTHROW_LIST)