1/* Pragma related interfaces.
2 Copyright (C) 1995-2017 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
19
20#ifndef GCC_C_PRAGMA_H
21#define GCC_C_PRAGMA_H
22
23#include "cpplib.h" /* For enum cpp_ttype. */
24
25/* Pragma identifiers built in to the front end parsers. Identifiers
26 for ancillary handlers will follow these. */
27enum pragma_kind {
28 PRAGMA_NONE = 0,
29
30 PRAGMA_OACC_ATOMIC,
31 PRAGMA_OACC_CACHE,
32 PRAGMA_OACC_DATA,
33 PRAGMA_OACC_DECLARE,
34 PRAGMA_OACC_ENTER_DATA,
35 PRAGMA_OACC_EXIT_DATA,
36 PRAGMA_OACC_HOST_DATA,
37 PRAGMA_OACC_KERNELS,
38 PRAGMA_OACC_LOOP,
39 PRAGMA_OACC_PARALLEL,
40 PRAGMA_OACC_ROUTINE,
41 PRAGMA_OACC_UPDATE,
42 PRAGMA_OACC_WAIT,
43
44 PRAGMA_OMP_ATOMIC,
45 PRAGMA_OMP_BARRIER,
46 PRAGMA_OMP_CANCEL,
47 PRAGMA_OMP_CANCELLATION_POINT,
48 PRAGMA_OMP_CRITICAL,
49 PRAGMA_OMP_DECLARE,
50 PRAGMA_OMP_DISTRIBUTE,
51 PRAGMA_OMP_END_DECLARE_TARGET,
52 PRAGMA_OMP_FLUSH,
53 PRAGMA_OMP_FOR,
54 PRAGMA_OMP_MASTER,
55 PRAGMA_OMP_ORDERED,
56 PRAGMA_OMP_PARALLEL,
57 PRAGMA_OMP_SECTION,
58 PRAGMA_OMP_SECTIONS,
59 PRAGMA_OMP_SIMD,
60 PRAGMA_OMP_SINGLE,
61 PRAGMA_OMP_TARGET,
62 PRAGMA_OMP_TASK,
63 PRAGMA_OMP_TASKGROUP,
64 PRAGMA_OMP_TASKLOOP,
65 PRAGMA_OMP_TASKWAIT,
66 PRAGMA_OMP_TASKYIELD,
67 PRAGMA_OMP_THREADPRIVATE,
68 PRAGMA_OMP_TEAMS,
69
70 PRAGMA_GCC_PCH_PREPROCESS,
71 PRAGMA_IVDEP,
72
73 PRAGMA_FIRST_EXTERNAL
74};
75
76
77/* All clauses defined by OpenACC 2.0, and OpenMP 2.5, 3.0, 3.1, 4.0 and 4.5.
78 Used internally by both C and C++ parsers. */
79enum pragma_omp_clause {
80 PRAGMA_OMP_CLAUSE_NONE = 0,
81
82 PRAGMA_OMP_CLAUSE_ALIGNED,
83 PRAGMA_OMP_CLAUSE_COLLAPSE,
84 PRAGMA_OMP_CLAUSE_COPYIN,
85 PRAGMA_OMP_CLAUSE_COPYPRIVATE,
86 PRAGMA_OMP_CLAUSE_DEFAULT,
87 PRAGMA_OMP_CLAUSE_DEFAULTMAP,
88 PRAGMA_OMP_CLAUSE_DEPEND,
89 PRAGMA_OMP_CLAUSE_DEVICE,
90 PRAGMA_OMP_CLAUSE_DIST_SCHEDULE,
91 PRAGMA_OMP_CLAUSE_FINAL,
92 PRAGMA_OMP_CLAUSE_FIRSTPRIVATE,
93 PRAGMA_OMP_CLAUSE_FOR,
94 PRAGMA_OMP_CLAUSE_FROM,
95 PRAGMA_OMP_CLAUSE_GRAINSIZE,
96 PRAGMA_OMP_CLAUSE_HINT,
97 PRAGMA_OMP_CLAUSE_IF,
98 PRAGMA_OMP_CLAUSE_INBRANCH,
99 PRAGMA_OMP_CLAUSE_IS_DEVICE_PTR,
100 PRAGMA_OMP_CLAUSE_LASTPRIVATE,
101 PRAGMA_OMP_CLAUSE_LINEAR,
102 PRAGMA_OMP_CLAUSE_LINK,
103 PRAGMA_OMP_CLAUSE_MAP,
104 PRAGMA_OMP_CLAUSE_MERGEABLE,
105 PRAGMA_OMP_CLAUSE_NOGROUP,
106 PRAGMA_OMP_CLAUSE_NOTINBRANCH,
107 PRAGMA_OMP_CLAUSE_NOWAIT,
108 PRAGMA_OMP_CLAUSE_NUM_TASKS,
109 PRAGMA_OMP_CLAUSE_NUM_TEAMS,
110 PRAGMA_OMP_CLAUSE_NUM_THREADS,
111 PRAGMA_OMP_CLAUSE_ORDERED,
112 PRAGMA_OMP_CLAUSE_PARALLEL,
113 PRAGMA_OMP_CLAUSE_PRIORITY,
114 PRAGMA_OMP_CLAUSE_PRIVATE,
115 PRAGMA_OMP_CLAUSE_PROC_BIND,
116 PRAGMA_OMP_CLAUSE_REDUCTION,
117 PRAGMA_OMP_CLAUSE_SAFELEN,
118 PRAGMA_OMP_CLAUSE_SCHEDULE,
119 PRAGMA_OMP_CLAUSE_SECTIONS,
120 PRAGMA_OMP_CLAUSE_SHARED,
121 PRAGMA_OMP_CLAUSE_SIMD,
122 PRAGMA_OMP_CLAUSE_SIMDLEN,
123 PRAGMA_OMP_CLAUSE_TASKGROUP,
124 PRAGMA_OMP_CLAUSE_THREAD_LIMIT,
125 PRAGMA_OMP_CLAUSE_THREADS,
126 PRAGMA_OMP_CLAUSE_TO,
127 PRAGMA_OMP_CLAUSE_UNIFORM,
128 PRAGMA_OMP_CLAUSE_UNTIED,
129 PRAGMA_OMP_CLAUSE_USE_DEVICE_PTR,
130
131 /* Clauses for OpenACC. */
132 PRAGMA_OACC_CLAUSE_ASYNC,
133 PRAGMA_OACC_CLAUSE_AUTO,
134 PRAGMA_OACC_CLAUSE_COPY,
135 PRAGMA_OACC_CLAUSE_COPYOUT,
136 PRAGMA_OACC_CLAUSE_CREATE,
137 PRAGMA_OACC_CLAUSE_DELETE,
138 PRAGMA_OACC_CLAUSE_DEVICEPTR,
139 PRAGMA_OACC_CLAUSE_DEVICE_RESIDENT,
140 PRAGMA_OACC_CLAUSE_GANG,
141 PRAGMA_OACC_CLAUSE_HOST,
142 PRAGMA_OACC_CLAUSE_INDEPENDENT,
143 PRAGMA_OACC_CLAUSE_NUM_GANGS,
144 PRAGMA_OACC_CLAUSE_NUM_WORKERS,
145 PRAGMA_OACC_CLAUSE_PRESENT,
146 PRAGMA_OACC_CLAUSE_PRESENT_OR_COPY,
147 PRAGMA_OACC_CLAUSE_PRESENT_OR_COPYIN,
148 PRAGMA_OACC_CLAUSE_PRESENT_OR_COPYOUT,
149 PRAGMA_OACC_CLAUSE_PRESENT_OR_CREATE,
150 PRAGMA_OACC_CLAUSE_SELF,
151 PRAGMA_OACC_CLAUSE_SEQ,
152 PRAGMA_OACC_CLAUSE_TILE,
153 PRAGMA_OACC_CLAUSE_USE_DEVICE,
154 PRAGMA_OACC_CLAUSE_VECTOR,
155 PRAGMA_OACC_CLAUSE_VECTOR_LENGTH,
156 PRAGMA_OACC_CLAUSE_WAIT,
157 PRAGMA_OACC_CLAUSE_WORKER,
158 PRAGMA_OACC_CLAUSE_COLLAPSE = PRAGMA_OMP_CLAUSE_COLLAPSE,
159 PRAGMA_OACC_CLAUSE_COPYIN = PRAGMA_OMP_CLAUSE_COPYIN,
160 PRAGMA_OACC_CLAUSE_DEVICE = PRAGMA_OMP_CLAUSE_DEVICE,
161 PRAGMA_OACC_CLAUSE_DEFAULT = PRAGMA_OMP_CLAUSE_DEFAULT,
162 PRAGMA_OACC_CLAUSE_FIRSTPRIVATE = PRAGMA_OMP_CLAUSE_FIRSTPRIVATE,
163 PRAGMA_OACC_CLAUSE_IF = PRAGMA_OMP_CLAUSE_IF,
164 PRAGMA_OACC_CLAUSE_PRIVATE = PRAGMA_OMP_CLAUSE_PRIVATE,
165 PRAGMA_OACC_CLAUSE_REDUCTION = PRAGMA_OMP_CLAUSE_REDUCTION,
166 PRAGMA_OACC_CLAUSE_LINK = PRAGMA_OMP_CLAUSE_LINK
167};
168
169extern struct cpp_reader* parse_in;
170
171/* It's safe to always leave visibility pragma enabled as if
172 visibility is not supported on the host OS platform the
173 statements are ignored. */
174extern void push_visibility (const char *, int);
175extern bool pop_visibility (int);
176
177extern void init_pragma (void);
178
179/* Front-end wrappers for pragma registration. */
180typedef void (*pragma_handler_1arg)(struct cpp_reader *);
181/* A second pragma handler, which adds a void * argument allowing to pass extra
182 data to the handler. */
183typedef void (*pragma_handler_2arg)(struct cpp_reader *, void *);
184
185/* This union allows to abstract the different handlers. */
186union gen_pragma_handler {
187 pragma_handler_1arg handler_1arg;
188 pragma_handler_2arg handler_2arg;
189};
190/* Internally used to keep the data of the handler. */
191struct internal_pragma_handler {
192 union gen_pragma_handler handler;
193 /* Permits to know if handler is a pragma_handler_1arg (extra_data is false)
194 or a pragma_handler_2arg (extra_data is true). */
195 bool extra_data;
196 /* A data field which can be used when extra_data is true. */
197 void * data;
198};
199
200extern void c_register_pragma (const char *space, const char *name,
201 pragma_handler_1arg handler);
202extern void c_register_pragma_with_data (const char *space, const char *name,
203 pragma_handler_2arg handler,
204 void *data);
205
206extern void c_register_pragma_with_expansion (const char *space,
207 const char *name,
208 pragma_handler_1arg handler);
209extern void c_register_pragma_with_expansion_and_data (const char *space,
210 const char *name,
211 pragma_handler_2arg handler,
212 void *data);
213extern void c_invoke_pragma_handler (unsigned int);
214
215extern void maybe_apply_pragma_weak (tree);
216extern void maybe_apply_pending_pragma_weaks (void);
217extern tree maybe_apply_renaming_pragma (tree, tree);
218extern void maybe_apply_pragma_scalar_storage_order (tree);
219extern void add_to_renaming_pragma_list (tree, tree);
220
221extern enum cpp_ttype pragma_lex (tree *, location_t *loc = NULL);
222
223/* Flags for use with c_lex_with_flags. The values here were picked
224 so that 0 means to translate and join strings. */
225#define C_LEX_STRING_NO_TRANSLATE 1 /* Do not lex strings into
226 execution character set. */
227#define C_LEX_STRING_NO_JOIN 2 /* Do not concatenate strings
228 nor translate them into execution
229 character set. */
230
231/* This is not actually available to pragma parsers. It's merely a
232 convenient location to declare this function for c-lex, after
233 having enum cpp_ttype declared. */
234extern enum cpp_ttype c_lex_with_flags (tree *, location_t *, unsigned char *,
235 int);
236
237extern void c_pp_lookup_pragma (unsigned int, const char **, const char **);
238
239extern GTY(()) tree pragma_extern_prefix;
240
241#endif /* GCC_C_PRAGMA_H */
242