1/* Pragma related interfaces.
2   Copyright (C) 1995-2020 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_SERIAL,
42  PRAGMA_OACC_UPDATE,
43  PRAGMA_OACC_WAIT,
44
45  PRAGMA_OMP_ATOMIC,
46  PRAGMA_OMP_BARRIER,
47  PRAGMA_OMP_CANCEL,
48  PRAGMA_OMP_CANCELLATION_POINT,
49  PRAGMA_OMP_CRITICAL,
50  PRAGMA_OMP_DECLARE,
51  PRAGMA_OMP_DEPOBJ,
52  PRAGMA_OMP_DISTRIBUTE,
53  PRAGMA_OMP_END_DECLARE_TARGET,
54  PRAGMA_OMP_FLUSH,
55  PRAGMA_OMP_FOR,
56  PRAGMA_OMP_LOOP,
57  PRAGMA_OMP_MASTER,
58  PRAGMA_OMP_ORDERED,
59  PRAGMA_OMP_PARALLEL,
60  PRAGMA_OMP_REQUIRES,
61  PRAGMA_OMP_SCAN,
62  PRAGMA_OMP_SECTION,
63  PRAGMA_OMP_SECTIONS,
64  PRAGMA_OMP_SIMD,
65  PRAGMA_OMP_SINGLE,
66  PRAGMA_OMP_TARGET,
67  PRAGMA_OMP_TASK,
68  PRAGMA_OMP_TASKGROUP,
69  PRAGMA_OMP_TASKLOOP,
70  PRAGMA_OMP_TASKWAIT,
71  PRAGMA_OMP_TASKYIELD,
72  PRAGMA_OMP_THREADPRIVATE,
73  PRAGMA_OMP_TEAMS,
74
75  PRAGMA_GCC_PCH_PREPROCESS,
76  PRAGMA_IVDEP,
77  PRAGMA_UNROLL,
78
79  PRAGMA_FIRST_EXTERNAL
80};
81
82
83/* All clauses defined by OpenACC 2.0, and OpenMP 2.5, 3.0, 3.1, 4.0, 4.5
84   and 5.0.  Used internally by both C and C++ parsers.  */
85enum pragma_omp_clause {
86  PRAGMA_OMP_CLAUSE_NONE = 0,
87
88  PRAGMA_OMP_CLAUSE_ALIGNED,
89  PRAGMA_OMP_CLAUSE_BIND,
90  PRAGMA_OMP_CLAUSE_COLLAPSE,
91  PRAGMA_OMP_CLAUSE_COPYIN,
92  PRAGMA_OMP_CLAUSE_COPYPRIVATE,
93  PRAGMA_OMP_CLAUSE_DEFAULT,
94  PRAGMA_OMP_CLAUSE_DEFAULTMAP,
95  PRAGMA_OMP_CLAUSE_DEPEND,
96  PRAGMA_OMP_CLAUSE_DEVICE,
97  PRAGMA_OMP_CLAUSE_DEVICE_TYPE,
98  PRAGMA_OMP_CLAUSE_DIST_SCHEDULE,
99  PRAGMA_OMP_CLAUSE_FINAL,
100  PRAGMA_OMP_CLAUSE_FIRSTPRIVATE,
101  PRAGMA_OMP_CLAUSE_FOR,
102  PRAGMA_OMP_CLAUSE_FROM,
103  PRAGMA_OMP_CLAUSE_GRAINSIZE,
104  PRAGMA_OMP_CLAUSE_HINT,
105  PRAGMA_OMP_CLAUSE_IF,
106  PRAGMA_OMP_CLAUSE_IN_REDUCTION,
107  PRAGMA_OMP_CLAUSE_INBRANCH,
108  PRAGMA_OMP_CLAUSE_IS_DEVICE_PTR,
109  PRAGMA_OMP_CLAUSE_LASTPRIVATE,
110  PRAGMA_OMP_CLAUSE_LINEAR,
111  PRAGMA_OMP_CLAUSE_LINK,
112  PRAGMA_OMP_CLAUSE_MAP,
113  PRAGMA_OMP_CLAUSE_MERGEABLE,
114  PRAGMA_OMP_CLAUSE_NOGROUP,
115  PRAGMA_OMP_CLAUSE_NONTEMPORAL,
116  PRAGMA_OMP_CLAUSE_NOTINBRANCH,
117  PRAGMA_OMP_CLAUSE_NOWAIT,
118  PRAGMA_OMP_CLAUSE_NUM_TASKS,
119  PRAGMA_OMP_CLAUSE_NUM_TEAMS,
120  PRAGMA_OMP_CLAUSE_NUM_THREADS,
121  PRAGMA_OMP_CLAUSE_ORDER,
122  PRAGMA_OMP_CLAUSE_ORDERED,
123  PRAGMA_OMP_CLAUSE_PARALLEL,
124  PRAGMA_OMP_CLAUSE_PRIORITY,
125  PRAGMA_OMP_CLAUSE_PRIVATE,
126  PRAGMA_OMP_CLAUSE_PROC_BIND,
127  PRAGMA_OMP_CLAUSE_REDUCTION,
128  PRAGMA_OMP_CLAUSE_SAFELEN,
129  PRAGMA_OMP_CLAUSE_SCHEDULE,
130  PRAGMA_OMP_CLAUSE_SECTIONS,
131  PRAGMA_OMP_CLAUSE_SHARED,
132  PRAGMA_OMP_CLAUSE_SIMD,
133  PRAGMA_OMP_CLAUSE_SIMDLEN,
134  PRAGMA_OMP_CLAUSE_TASK_REDUCTION,
135  PRAGMA_OMP_CLAUSE_TASKGROUP,
136  PRAGMA_OMP_CLAUSE_THREAD_LIMIT,
137  PRAGMA_OMP_CLAUSE_THREADS,
138  PRAGMA_OMP_CLAUSE_TO,
139  PRAGMA_OMP_CLAUSE_UNIFORM,
140  PRAGMA_OMP_CLAUSE_UNTIED,
141  PRAGMA_OMP_CLAUSE_USE_DEVICE_PTR,
142  PRAGMA_OMP_CLAUSE_USE_DEVICE_ADDR,
143
144  /* Clauses for OpenACC.  */
145  PRAGMA_OACC_CLAUSE_ASYNC,
146  PRAGMA_OACC_CLAUSE_ATTACH,
147  PRAGMA_OACC_CLAUSE_AUTO,
148  PRAGMA_OACC_CLAUSE_COPY,
149  PRAGMA_OACC_CLAUSE_COPYOUT,
150  PRAGMA_OACC_CLAUSE_CREATE,
151  PRAGMA_OACC_CLAUSE_DELETE,
152  PRAGMA_OACC_CLAUSE_DETACH,
153  PRAGMA_OACC_CLAUSE_DEVICEPTR,
154  PRAGMA_OACC_CLAUSE_DEVICE_RESIDENT,
155  PRAGMA_OACC_CLAUSE_FINALIZE,
156  PRAGMA_OACC_CLAUSE_GANG,
157  PRAGMA_OACC_CLAUSE_HOST,
158  PRAGMA_OACC_CLAUSE_INDEPENDENT,
159  PRAGMA_OACC_CLAUSE_NO_CREATE,
160  PRAGMA_OACC_CLAUSE_NUM_GANGS,
161  PRAGMA_OACC_CLAUSE_NUM_WORKERS,
162  PRAGMA_OACC_CLAUSE_PRESENT,
163  PRAGMA_OACC_CLAUSE_SELF,
164  PRAGMA_OACC_CLAUSE_SEQ,
165  PRAGMA_OACC_CLAUSE_TILE,
166  PRAGMA_OACC_CLAUSE_VECTOR,
167  PRAGMA_OACC_CLAUSE_VECTOR_LENGTH,
168  PRAGMA_OACC_CLAUSE_WAIT,
169  PRAGMA_OACC_CLAUSE_WORKER,
170  PRAGMA_OACC_CLAUSE_IF_PRESENT,
171  PRAGMA_OACC_CLAUSE_COLLAPSE = PRAGMA_OMP_CLAUSE_COLLAPSE,
172  PRAGMA_OACC_CLAUSE_COPYIN = PRAGMA_OMP_CLAUSE_COPYIN,
173  PRAGMA_OACC_CLAUSE_DEVICE = PRAGMA_OMP_CLAUSE_DEVICE,
174  PRAGMA_OACC_CLAUSE_DEFAULT = PRAGMA_OMP_CLAUSE_DEFAULT,
175  PRAGMA_OACC_CLAUSE_FIRSTPRIVATE = PRAGMA_OMP_CLAUSE_FIRSTPRIVATE,
176  PRAGMA_OACC_CLAUSE_IF = PRAGMA_OMP_CLAUSE_IF,
177  PRAGMA_OACC_CLAUSE_PRIVATE = PRAGMA_OMP_CLAUSE_PRIVATE,
178  PRAGMA_OACC_CLAUSE_REDUCTION = PRAGMA_OMP_CLAUSE_REDUCTION,
179  PRAGMA_OACC_CLAUSE_LINK = PRAGMA_OMP_CLAUSE_LINK,
180  PRAGMA_OACC_CLAUSE_USE_DEVICE = PRAGMA_OMP_CLAUSE_USE_DEVICE_PTR
181};
182
183extern struct cpp_reader* parse_in;
184
185/* It's safe to always leave visibility pragma enabled as if
186   visibility is not supported on the host OS platform the
187   statements are ignored.  */
188extern void push_visibility (const char *, int);
189extern bool pop_visibility (int);
190
191extern void init_pragma (void);
192
193/* Front-end wrappers for pragma registration.  */
194typedef void (*pragma_handler_1arg)(struct cpp_reader *);
195/* A second pragma handler, which adds a void * argument allowing to pass extra
196   data to the handler.  */
197typedef void (*pragma_handler_2arg)(struct cpp_reader *, void *);
198
199/* This union allows to abstract the different handlers.  */
200union gen_pragma_handler {
201  pragma_handler_1arg handler_1arg;
202  pragma_handler_2arg handler_2arg;
203};
204/* Internally used to keep the data of the handler.  */
205struct internal_pragma_handler {
206  union gen_pragma_handler handler;
207  /* Permits to know if handler is a pragma_handler_1arg (extra_data is false)
208     or a pragma_handler_2arg (extra_data is true).  */
209  bool extra_data;
210  /* A data field which can be used when extra_data is true.  */
211  void * data;
212};
213
214extern void c_register_pragma (const char *space, const char *name,
215                               pragma_handler_1arg handler);
216extern void c_register_pragma_with_data (const char *space, const char *name,
217                                         pragma_handler_2arg handler,
218                                         void *data);
219
220extern void c_register_pragma_with_expansion (const char *space,
221                                              const char *name,
222                                              pragma_handler_1arg handler);
223extern void c_register_pragma_with_expansion_and_data (const char *space,
224                                                       const char *name,
225                                                   pragma_handler_2arg handler,
226                                                       void *data);
227extern void c_invoke_pragma_handler (unsigned int);
228
229extern void maybe_apply_pragma_weak (tree);
230extern void maybe_apply_pending_pragma_weaks (void);
231extern tree maybe_apply_renaming_pragma (tree, tree);
232extern void maybe_apply_pragma_scalar_storage_order (tree);
233extern void add_to_renaming_pragma_list (tree, tree);
234
235extern enum cpp_ttype pragma_lex (tree *, location_t *loc = NULL);
236
237/* Flags for use with c_lex_with_flags.  The values here were picked
238   so that 0 means to translate and join strings.  */
239#define C_LEX_STRING_NO_TRANSLATE 1 /* Do not lex strings into
240				       execution character set.  */
241#define C_LEX_STRING_NO_JOIN	  2 /* Do not concatenate strings
242				       nor translate them into execution
243				       character set.  */
244
245/* This is not actually available to pragma parsers.  It's merely a
246   convenient location to declare this function for c-lex, after
247   having enum cpp_ttype declared.  */
248extern enum cpp_ttype c_lex_with_flags (tree *, location_t *, unsigned char *,
249					int);
250
251extern void c_pp_lookup_pragma (unsigned int, const char **, const char **);
252
253extern GTY(()) tree pragma_extern_prefix;
254
255#endif /* GCC_C_PRAGMA_H */
256