1/* This file contains the definitions and documentation for the
2   OpenMP builtins used in the GNU compiler.
3   Copyright (C) 2005, 2007, 2008, 2010 Free Software Foundation, Inc.
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 3, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING3.  If not see
19<http://www.gnu.org/licenses/>.  */
20
21/* Before including this file, you should define a macro:
22
23     DEF_GOMP_BUILTIN (ENUM, NAME, TYPE, ATTRS)
24
25   See builtins.def for details.  */
26
27DEF_GOMP_BUILTIN (BUILT_IN_OMP_GET_THREAD_NUM, "omp_get_thread_num",
28		  BT_FN_INT, ATTR_CONST_NOTHROW_LEAF_LIST)
29DEF_GOMP_BUILTIN (BUILT_IN_OMP_GET_NUM_THREADS, "omp_get_num_threads",
30		  BT_FN_INT, ATTR_CONST_NOTHROW_LEAF_LIST)
31
32DEF_GOMP_BUILTIN (BUILT_IN_GOMP_ATOMIC_START, "GOMP_atomic_start",
33		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
34DEF_GOMP_BUILTIN (BUILT_IN_GOMP_ATOMIC_END, "GOMP_atomic_end",
35		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
36DEF_GOMP_BUILTIN (BUILT_IN_GOMP_BARRIER, "GOMP_barrier",
37		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
38DEF_GOMP_BUILTIN (BUILT_IN_GOMP_TASKWAIT, "GOMP_taskwait",
39		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
40DEF_GOMP_BUILTIN (BUILT_IN_GOMP_TASKYIELD, "GOMP_taskyield",
41		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
42DEF_GOMP_BUILTIN (BUILT_IN_GOMP_CRITICAL_START, "GOMP_critical_start",
43		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
44DEF_GOMP_BUILTIN (BUILT_IN_GOMP_CRITICAL_END, "GOMP_critical_end",
45		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
46DEF_GOMP_BUILTIN (BUILT_IN_GOMP_CRITICAL_NAME_START,
47		  "GOMP_critical_name_start",
48		  BT_FN_VOID_PTRPTR, ATTR_NOTHROW_LEAF_LIST)
49DEF_GOMP_BUILTIN (BUILT_IN_GOMP_CRITICAL_NAME_END,
50		  "GOMP_critical_name_end",
51		  BT_FN_VOID_PTRPTR, ATTR_NOTHROW_LEAF_LIST)
52/* NOTE: Do not change the order of BUILT_IN_GOMP_LOOP_*_START.  They
53   are used in index arithmetic with enum omp_clause_schedule_kind
54   in omp-low.c.  */
55DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_STATIC_START,
56		  "GOMP_loop_static_start",
57		  BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
58		  ATTR_NOTHROW_LEAF_LIST)
59DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_DYNAMIC_START,
60		  "GOMP_loop_dynamic_start",
61		  BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
62		  ATTR_NOTHROW_LEAF_LIST)
63DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_GUIDED_START,
64		  "GOMP_loop_guided_start",
65		  BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
66		  ATTR_NOTHROW_LEAF_LIST)
67DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_RUNTIME_START,
68		  "GOMP_loop_runtime_start",
69		  BT_FN_BOOL_LONG_LONG_LONG_LONGPTR_LONGPTR,
70		  ATTR_NOTHROW_LEAF_LIST)
71DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_STATIC_START,
72		  "GOMP_loop_ordered_static_start",
73		  BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
74		  ATTR_NOTHROW_LEAF_LIST)
75DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_DYNAMIC_START,
76		  "GOMP_loop_ordered_dynamic_start",
77		  BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
78		  ATTR_NOTHROW_LEAF_LIST)
79DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_GUIDED_START,
80		  "GOMP_loop_ordered_guided_start",
81		  BT_FN_BOOL_LONG_LONG_LONG_LONG_LONGPTR_LONGPTR,
82		  ATTR_NOTHROW_LEAF_LIST)
83DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_RUNTIME_START,
84		  "GOMP_loop_ordered_runtime_start",
85		  BT_FN_BOOL_LONG_LONG_LONG_LONGPTR_LONGPTR,
86		  ATTR_NOTHROW_LEAF_LIST)
87DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_STATIC_NEXT, "GOMP_loop_static_next",
88		  BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LEAF_LIST)
89DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_DYNAMIC_NEXT, "GOMP_loop_dynamic_next",
90		  BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LEAF_LIST)
91DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_GUIDED_NEXT, "GOMP_loop_guided_next",
92		  BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LEAF_LIST)
93DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_RUNTIME_NEXT, "GOMP_loop_runtime_next",
94		  BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LEAF_LIST)
95DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_STATIC_NEXT,
96		  "GOMP_loop_ordered_static_next",
97		  BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LEAF_LIST)
98DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_DYNAMIC_NEXT,
99		  "GOMP_loop_ordered_dynamic_next",
100		  BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LEAF_LIST)
101DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_GUIDED_NEXT,
102		  "GOMP_loop_ordered_guided_next",
103		  BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LEAF_LIST)
104DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ORDERED_RUNTIME_NEXT,
105		  "GOMP_loop_ordered_runtime_next",
106		  BT_FN_BOOL_LONGPTR_LONGPTR, ATTR_NOTHROW_LEAF_LIST)
107DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_STATIC_START,
108		  "GOMP_loop_ull_static_start",
109		  BT_FN_BOOL_BOOL_ULL_ULL_ULL_ULL_ULLPTR_ULLPTR,
110		  ATTR_NOTHROW_LEAF_LIST)
111DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_DYNAMIC_START,
112		  "GOMP_loop_ull_dynamic_start",
113		  BT_FN_BOOL_BOOL_ULL_ULL_ULL_ULL_ULLPTR_ULLPTR,
114		  ATTR_NOTHROW_LEAF_LIST)
115DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_GUIDED_START,
116		  "GOMP_loop_ull_guided_start",
117		  BT_FN_BOOL_BOOL_ULL_ULL_ULL_ULL_ULLPTR_ULLPTR,
118		  ATTR_NOTHROW_LEAF_LIST)
119DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_RUNTIME_START,
120		  "GOMP_loop_ull_runtime_start",
121		  BT_FN_BOOL_BOOL_ULL_ULL_ULL_ULLPTR_ULLPTR,
122		  ATTR_NOTHROW_LEAF_LIST)
123DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_ORDERED_STATIC_START,
124		  "GOMP_loop_ull_ordered_static_start",
125		  BT_FN_BOOL_BOOL_ULL_ULL_ULL_ULL_ULLPTR_ULLPTR,
126		  ATTR_NOTHROW_LEAF_LIST)
127DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_ORDERED_DYNAMIC_START,
128		  "GOMP_loop_ull_ordered_dynamic_start",
129		  BT_FN_BOOL_BOOL_ULL_ULL_ULL_ULL_ULLPTR_ULLPTR,
130		  ATTR_NOTHROW_LEAF_LIST)
131DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_ORDERED_GUIDED_START,
132		  "GOMP_loop_ull_ordered_guided_start",
133		  BT_FN_BOOL_BOOL_ULL_ULL_ULL_ULL_ULLPTR_ULLPTR,
134		  ATTR_NOTHROW_LEAF_LIST)
135DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_ORDERED_RUNTIME_START,
136		  "GOMP_loop_ull_ordered_runtime_start",
137		  BT_FN_BOOL_BOOL_ULL_ULL_ULL_ULLPTR_ULLPTR,
138		  ATTR_NOTHROW_LEAF_LIST)
139DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_STATIC_NEXT, "GOMP_loop_ull_static_next",
140		  BT_FN_BOOL_ULONGLONGPTR_ULONGLONGPTR, ATTR_NOTHROW_LEAF_LIST)
141DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_DYNAMIC_NEXT, "GOMP_loop_ull_dynamic_next",
142		  BT_FN_BOOL_ULONGLONGPTR_ULONGLONGPTR, ATTR_NOTHROW_LEAF_LIST)
143DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_GUIDED_NEXT, "GOMP_loop_ull_guided_next",
144		  BT_FN_BOOL_ULONGLONGPTR_ULONGLONGPTR, ATTR_NOTHROW_LEAF_LIST)
145DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_RUNTIME_NEXT, "GOMP_loop_ull_runtime_next",
146		  BT_FN_BOOL_ULONGLONGPTR_ULONGLONGPTR, ATTR_NOTHROW_LEAF_LIST)
147DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_ORDERED_STATIC_NEXT,
148		  "GOMP_loop_ull_ordered_static_next",
149		  BT_FN_BOOL_ULONGLONGPTR_ULONGLONGPTR, ATTR_NOTHROW_LEAF_LIST)
150DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_ORDERED_DYNAMIC_NEXT,
151		  "GOMP_loop_ull_ordered_dynamic_next",
152		  BT_FN_BOOL_ULONGLONGPTR_ULONGLONGPTR, ATTR_NOTHROW_LEAF_LIST)
153DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_ORDERED_GUIDED_NEXT,
154		  "GOMP_loop_ull_ordered_guided_next",
155		  BT_FN_BOOL_ULONGLONGPTR_ULONGLONGPTR, ATTR_NOTHROW_LEAF_LIST)
156DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_ULL_ORDERED_RUNTIME_NEXT,
157		  "GOMP_loop_ull_ordered_runtime_next",
158		  BT_FN_BOOL_ULONGLONGPTR_ULONGLONGPTR, ATTR_NOTHROW_LEAF_LIST)
159/* NOTE: Do not change the order of BUILT_IN_GOMP_PARALLEL_LOOP_*_START.
160   They are used in index arithmetic with enum omp_clause_schedule_kind
161   in omp-low.c.  */
162DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_LOOP_STATIC_START,
163		  "GOMP_parallel_loop_static_start",
164		  BT_FN_VOID_OMPFN_PTR_UINT_LONG_LONG_LONG_LONG,
165		  ATTR_NOTHROW_LIST)
166DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_LOOP_DYNAMIC_START,
167		  "GOMP_parallel_loop_dynamic_start",
168		  BT_FN_VOID_OMPFN_PTR_UINT_LONG_LONG_LONG_LONG,
169		  ATTR_NOTHROW_LIST)
170DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_LOOP_GUIDED_START,
171		  "GOMP_parallel_loop_guided_start",
172		  BT_FN_VOID_OMPFN_PTR_UINT_LONG_LONG_LONG_LONG,
173		  ATTR_NOTHROW_LIST)
174DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_LOOP_RUNTIME_START,
175		  "GOMP_parallel_loop_runtime_start",
176		  BT_FN_VOID_OMPFN_PTR_UINT_LONG_LONG_LONG,
177		  ATTR_NOTHROW_LIST)
178DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_END, "GOMP_loop_end",
179		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
180DEF_GOMP_BUILTIN (BUILT_IN_GOMP_LOOP_END_NOWAIT, "GOMP_loop_end_nowait",
181		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
182DEF_GOMP_BUILTIN (BUILT_IN_GOMP_ORDERED_START, "GOMP_ordered_start",
183		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
184DEF_GOMP_BUILTIN (BUILT_IN_GOMP_ORDERED_END, "GOMP_ordered_end",
185		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
186DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_START, "GOMP_parallel_start",
187		  BT_FN_VOID_OMPFN_PTR_UINT, ATTR_NOTHROW_LIST)
188DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_END, "GOMP_parallel_end",
189		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
190DEF_GOMP_BUILTIN (BUILT_IN_GOMP_TASK, "GOMP_task",
191		  BT_FN_VOID_OMPFN_PTR_OMPCPYFN_LONG_LONG_BOOL_UINT,
192		  ATTR_NOTHROW_LIST)
193DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SECTIONS_START, "GOMP_sections_start",
194		  BT_FN_UINT_UINT, ATTR_NOTHROW_LEAF_LIST)
195DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SECTIONS_NEXT, "GOMP_sections_next",
196		  BT_FN_UINT, ATTR_NOTHROW_LEAF_LIST)
197DEF_GOMP_BUILTIN (BUILT_IN_GOMP_PARALLEL_SECTIONS_START,
198		  "GOMP_parallel_sections_start",
199		  BT_FN_VOID_OMPFN_PTR_UINT_UINT, ATTR_NOTHROW_LIST)
200DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SECTIONS_END, "GOMP_sections_end",
201		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
202DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SECTIONS_END_NOWAIT,
203		  "GOMP_sections_end_nowait",
204		  BT_FN_VOID, ATTR_NOTHROW_LEAF_LIST)
205DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SINGLE_START, "GOMP_single_start",
206		  BT_FN_BOOL, ATTR_NOTHROW_LEAF_LIST)
207DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SINGLE_COPY_START, "GOMP_single_copy_start",
208		  BT_FN_PTR, ATTR_NOTHROW_LEAF_LIST)
209DEF_GOMP_BUILTIN (BUILT_IN_GOMP_SINGLE_COPY_END, "GOMP_single_copy_end",
210		  BT_FN_VOID_PTR, ATTR_NOTHROW_LEAF_LIST)
211