gcc/c-family/c-pragma.h

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