gcc/c-family/c-pragma.h

   1 /* Pragma related interfaces.
   2    Copyright (C) 1995-2015 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 typedef enum pragma_kind {
  28   PRAGMA_NONE = 0,
  29
  30   PRAGMA_OACC_CACHE,
  31   PRAGMA_OACC_DATA,
  32   PRAGMA_OACC_ENTER_DATA,
  33   PRAGMA_OACC_EXIT_DATA,
  34   PRAGMA_OACC_KERNELS,
  35   PRAGMA_OACC_LOOP,
  36   PRAGMA_OACC_PARALLEL,
  37   PRAGMA_OACC_UPDATE,
  38   PRAGMA_OACC_WAIT,
  39   PRAGMA_OMP_ATOMIC,
  40   PRAGMA_OMP_BARRIER,
  41   PRAGMA_OMP_CANCEL,
  42   PRAGMA_OMP_CANCELLATION_POINT,
  43   PRAGMA_OMP_CRITICAL,
  44   PRAGMA_OMP_DECLARE_REDUCTION,
  45   PRAGMA_OMP_DISTRIBUTE,
  46   PRAGMA_OMP_END_DECLARE_TARGET,
  47   PRAGMA_OMP_FLUSH,
  48   PRAGMA_OMP_FOR,
  49   PRAGMA_OMP_MASTER,
  50   PRAGMA_OMP_ORDERED,
  51   PRAGMA_OMP_PARALLEL,
  52   PRAGMA_OMP_SECTION,
  53   PRAGMA_OMP_SECTIONS,
  54   PRAGMA_OMP_SIMD,
  55   PRAGMA_OMP_SINGLE,
  56   PRAGMA_OMP_TARGET,
  57   PRAGMA_OMP_TASK,
  58   PRAGMA_OMP_TASKGROUP,
  59   PRAGMA_OMP_TASKWAIT,
  60   PRAGMA_OMP_TASKYIELD,
  61   PRAGMA_OMP_THREADPRIVATE,
  62   PRAGMA_OMP_TEAMS,
  63
  64   /* Top level clause to handle all Cilk Plus pragma simd clauses.  */
  65   PRAGMA_CILK_SIMD,
  66
  67   /* This pragma handles setting of grainsize for a _Cilk_for.  */
  68   PRAGMA_CILK_GRAINSIZE,
  69
  70   PRAGMA_GCC_PCH_PREPROCESS,
  71   PRAGMA_IVDEP,
  72
  73   PRAGMA_FIRST_EXTERNAL
  74 } pragma_kind;
  75
  76
  77 /* All clauses defined by OpenACC 2.0, and OpenMP 2.5, 3.0, 3.1, and 4.0.
  78    Used internally by both C and C++ parsers.  */
  79 typedef enum 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_DEPEND,
  88   PRAGMA_OMP_CLAUSE_DEVICE,
  89   PRAGMA_OMP_CLAUSE_DIST_SCHEDULE,
  90   PRAGMA_OMP_CLAUSE_FINAL,
  91   PRAGMA_OMP_CLAUSE_FIRSTPRIVATE,
  92   PRAGMA_OMP_CLAUSE_FOR,
  93   PRAGMA_OMP_CLAUSE_FROM,
  94   PRAGMA_OMP_CLAUSE_IF,
  95   PRAGMA_OMP_CLAUSE_INBRANCH,
  96   PRAGMA_OMP_CLAUSE_LASTPRIVATE,
  97   PRAGMA_OMP_CLAUSE_LINEAR,
  98   PRAGMA_OMP_CLAUSE_MAP,
  99   PRAGMA_OMP_CLAUSE_MERGEABLE,
 100   PRAGMA_OMP_CLAUSE_NOTINBRANCH,
 101   PRAGMA_OMP_CLAUSE_NOWAIT,
 102   PRAGMA_OMP_CLAUSE_NUM_TEAMS,
 103   PRAGMA_OMP_CLAUSE_NUM_THREADS,
 104   PRAGMA_OMP_CLAUSE_ORDERED,
 105   PRAGMA_OMP_CLAUSE_PARALLEL,
 106   PRAGMA_OMP_CLAUSE_PRIVATE,
 107   PRAGMA_OMP_CLAUSE_PROC_BIND,
 108   PRAGMA_OMP_CLAUSE_REDUCTION,
 109   PRAGMA_OMP_CLAUSE_SAFELEN,
 110   PRAGMA_OMP_CLAUSE_SCHEDULE,
 111   PRAGMA_OMP_CLAUSE_SECTIONS,
 112   PRAGMA_OMP_CLAUSE_SHARED,
 113   PRAGMA_OMP_CLAUSE_SIMDLEN,
 114   PRAGMA_OMP_CLAUSE_TASKGROUP,
 115   PRAGMA_OMP_CLAUSE_THREAD_LIMIT,
 116   PRAGMA_OMP_CLAUSE_TO,
 117   PRAGMA_OMP_CLAUSE_UNIFORM,
 118   PRAGMA_OMP_CLAUSE_UNTIED,
 119
 120   /* Clauses for Cilk Plus SIMD-enabled function.  */
 121   PRAGMA_CILK_CLAUSE_NOMASK,
 122   PRAGMA_CILK_CLAUSE_MASK,
 123   PRAGMA_CILK_CLAUSE_VECTORLENGTH,
 124   PRAGMA_CILK_CLAUSE_NONE = PRAGMA_OMP_CLAUSE_NONE,
 125   PRAGMA_CILK_CLAUSE_LINEAR = PRAGMA_OMP_CLAUSE_LINEAR,
 126   PRAGMA_CILK_CLAUSE_PRIVATE = PRAGMA_OMP_CLAUSE_PRIVATE,
 127   PRAGMA_CILK_CLAUSE_FIRSTPRIVATE = PRAGMA_OMP_CLAUSE_FIRSTPRIVATE,
 128   PRAGMA_CILK_CLAUSE_LASTPRIVATE = PRAGMA_OMP_CLAUSE_LASTPRIVATE,
 129   PRAGMA_CILK_CLAUSE_REDUCTION = PRAGMA_OMP_CLAUSE_REDUCTION,
 130   PRAGMA_CILK_CLAUSE_UNIFORM = PRAGMA_OMP_CLAUSE_UNIFORM,
 131
 132   /* Clauses for OpenACC.  */
 133   PRAGMA_OACC_CLAUSE_ASYNC = PRAGMA_CILK_CLAUSE_VECTORLENGTH + 1,
 134   PRAGMA_OACC_CLAUSE_AUTO,
 135   PRAGMA_OACC_CLAUSE_COPY,
 136   PRAGMA_OACC_CLAUSE_COPYOUT,
 137   PRAGMA_OACC_CLAUSE_CREATE,
 138   PRAGMA_OACC_CLAUSE_DELETE,
 139   PRAGMA_OACC_CLAUSE_DEVICEPTR,
 140   PRAGMA_OACC_CLAUSE_GANG,
 141   PRAGMA_OACC_CLAUSE_HOST,
 142   PRAGMA_OACC_CLAUSE_NUM_GANGS,
 143   PRAGMA_OACC_CLAUSE_NUM_WORKERS,
 144   PRAGMA_OACC_CLAUSE_PRESENT,
 145   PRAGMA_OACC_CLAUSE_PRESENT_OR_COPY,
 146   PRAGMA_OACC_CLAUSE_PRESENT_OR_COPYIN,
 147   PRAGMA_OACC_CLAUSE_PRESENT_OR_COPYOUT,
 148   PRAGMA_OACC_CLAUSE_PRESENT_OR_CREATE,
 149   PRAGMA_OACC_CLAUSE_SELF,
 150   PRAGMA_OACC_CLAUSE_SEQ,
 151   PRAGMA_OACC_CLAUSE_VECTOR,
 152   PRAGMA_OACC_CLAUSE_VECTOR_LENGTH,
 153   PRAGMA_OACC_CLAUSE_WAIT,
 154   PRAGMA_OACC_CLAUSE_WORKER,
 155   PRAGMA_OACC_CLAUSE_COLLAPSE = PRAGMA_OMP_CLAUSE_COLLAPSE,
 156   PRAGMA_OACC_CLAUSE_COPYIN = PRAGMA_OMP_CLAUSE_COPYIN,
 157   PRAGMA_OACC_CLAUSE_DEVICE = PRAGMA_OMP_CLAUSE_DEVICE,
 158   PRAGMA_OACC_CLAUSE_FIRSTPRIVATE = PRAGMA_OMP_CLAUSE_FIRSTPRIVATE,
 159   PRAGMA_OACC_CLAUSE_IF = PRAGMA_OMP_CLAUSE_IF,
 160   PRAGMA_OACC_CLAUSE_PRIVATE = PRAGMA_OMP_CLAUSE_PRIVATE,
 161   PRAGMA_OACC_CLAUSE_REDUCTION = PRAGMA_OMP_CLAUSE_REDUCTION
 162 } pragma_omp_clause;
 163
 164 extern struct cpp_reader* parse_in;
 165
 166 /* It's safe to always leave visibility pragma enabled as if
 167    visibility is not supported on the host OS platform the
 168    statements are ignored.  */
 169 extern void push_visibility (const char *, int);
 170 extern bool pop_visibility (int);
 171
 172 extern void init_pragma (void);
 173
 174 /* Front-end wrappers for pragma registration.  */
 175 typedef void (*pragma_handler_1arg)(struct cpp_reader *);
 176 /* A second pragma handler, which adds a void * argument allowing to pass extra
 177    data to the handler.  */
 178 typedef void (*pragma_handler_2arg)(struct cpp_reader *, void *);
 179
 180 /* This union allows to abstract the different handlers.  */
 181 union gen_pragma_handler {
 182   pragma_handler_1arg handler_1arg;
 183   pragma_handler_2arg handler_2arg;
 184 };
 185 /* Internally used to keep the data of the handler.  */
 186 struct internal_pragma_handler_d {
 187   union gen_pragma_handler handler;
 188   /* Permits to know if handler is a pragma_handler_1arg (extra_data is false)
 189      or a pragma_handler_2arg (extra_data is true).  */
 190   bool extra_data;
 191   /* A data field which can be used when extra_data is true.  */
 192   void * data;
 193 };
 194 typedef struct internal_pragma_handler_d internal_pragma_handler;
 195
 196 extern void c_register_pragma (const char *space, const char *name,
 197                                pragma_handler_1arg handler);
 198 extern void c_register_pragma_with_data (const char *space, const char *name,
 199                                          pragma_handler_2arg handler,
 200                                          void *data);
 201
 202 extern void c_register_pragma_with_expansion (const char *space,
 203                                               const char *name,
 204                                               pragma_handler_1arg handler);
 205 extern void c_register_pragma_with_expansion_and_data (const char *space,
 206                                                        const char *name,
 207                                                    pragma_handler_2arg handler,
 208                                                        void *data);
 209 extern void c_invoke_pragma_handler (unsigned int);
 210
 211 extern void maybe_apply_pragma_weak (tree);
 212 extern void maybe_apply_pending_pragma_weaks (void);
 213 extern tree maybe_apply_renaming_pragma (tree, tree);
 214 extern void add_to_renaming_pragma_list (tree, tree);
 215
 216 extern enum cpp_ttype pragma_lex (tree *);
 217
 218 /* Flags for use with c_lex_with_flags.  The values here were picked
 219    so that 0 means to translate and join strings.  */
 220 #define C_LEX_STRING_NO_TRANSLATE 1 /* Do not lex strings into
 221                                        execution character set.  */
 222 #define C_LEX_STRING_NO_JOIN      2 /* Do not concatenate strings
 223                                        nor translate them into execution
 224                                        character set.  */
 225
 226 /* This is not actually available to pragma parsers.  It's merely a
 227    convenient location to declare this function for c-lex, after
 228    having enum cpp_ttype declared.  */
 229 extern enum cpp_ttype c_lex_with_flags (tree *, location_t *, unsigned char *,
 230                                         int);
 231
 232 extern void c_pp_lookup_pragma (unsigned int, const char **, const char **);
 233
 234 extern GTY(()) tree pragma_extern_prefix;
 235
 236 #endif /* GCC_C_PRAGMA_H */