gcc/coretypes.h

   1 /* GCC core type declarations.
   2    Copyright (C) 2002-2014 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 Under Section 7 of GPL version 3, you are granted additional
  17 permissions described in the GCC Runtime Library Exception, version
  18 3.1, as published by the Free Software Foundation.
  19
  20 You should have received a copy of the GNU General Public License and
  21 a copy of the GCC Runtime Library Exception along with this program;
  22 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  23 <http://www.gnu.org/licenses/>.  */
  24
  25 /* Provide forward declarations of core types which are referred to by
  26    most of the compiler.  This allows header files to use these types
  27    (e.g. in function prototypes) without concern for whether the full
  28    definitions are visible.  Some other declarations that need to be
  29    universally visible are here, too.
  30
  31    In the context of tconfig.h, most of these have special definitions
  32    which prevent them from being used except in further type
  33    declarations.  This is a kludge; the right thing is to avoid
  34    including the "tm.h" header set in the context of tconfig.h, but
  35    we're not there yet.  */
  36
  37 #ifndef GCC_CORETYPES_H
  38 #define GCC_CORETYPES_H
  39
  40 #ifndef GTY
  41 #define GTY(x)  /* nothing - marker for gengtype */
  42 #endif
  43
  44 #ifndef USED_FOR_TARGET
  45
  46 typedef int64_t gcov_type;
  47 typedef uint64_t gcov_type_unsigned;
  48
  49 struct bitmap_head;
  50 typedef struct bitmap_head *bitmap;
  51 typedef const struct bitmap_head *const_bitmap;
  52 struct simple_bitmap_def;
  53 typedef struct simple_bitmap_def *sbitmap;
  54 typedef const struct simple_bitmap_def *const_sbitmap;
  55 struct rtx_def;
  56 typedef struct rtx_def *rtx;
  57 typedef const struct rtx_def *const_rtx;
  58
  59 /* Subclasses of rtx_def, using indentation to show the class
  60    hierarchy, along with the relevant invariant.
  61    Where possible, keep this list in the same order as in rtl.def.  */
  62 class rtx_def;
  63   class rtx_expr_list;           /* GET_CODE (X) == EXPR_LIST */
  64   class rtx_insn_list;           /* GET_CODE (X) == INSN_LIST */
  65   class rtx_sequence;            /* GET_CODE (X) == SEQUENCE */
  66   class rtx_insn;
  67     class rtx_debug_insn;      /* DEBUG_INSN_P (X) */
  68     class rtx_nonjump_insn;    /* NONJUMP_INSN_P (X) */
  69     class rtx_jump_insn;       /* JUMP_P (X) */
  70     class rtx_call_insn;       /* CALL_P (X) */
  71     class rtx_jump_table_data; /* JUMP_TABLE_DATA_P (X) */
  72     class rtx_barrier;         /* BARRIER_P (X) */
  73     class rtx_code_label;      /* LABEL_P (X) */
  74     class rtx_note;            /* NOTE_P (X) */
  75
  76 struct rtvec_def;
  77 typedef struct rtvec_def *rtvec;
  78 typedef const struct rtvec_def *const_rtvec;
  79 struct hwivec_def;
  80 typedef struct hwivec_def *hwivec;
  81 typedef const struct hwivec_def *const_hwivec;
  82 union tree_node;
  83 typedef union tree_node *tree;
  84 typedef const union tree_node *const_tree;
  85 typedef struct gimple_statement_base *gimple;
  86 typedef const struct gimple_statement_base *const_gimple;
  87 typedef gimple gimple_seq;
  88 struct gimple_stmt_iterator;
  89
  90 /* Typedefs for leaf gimple subclasses (for individual gimple codes).
  91    Keep this in the same order as the corresponding codes in gimple.def.  */
  92
  93 struct gimple_statement_cond;
  94 typedef struct gimple_statement_cond *gimple_cond;
  95 typedef const struct gimple_statement_cond *const_gimple_cond;
  96
  97 struct gimple_statement_debug;
  98 typedef struct gimple_statement_debug *gimple_debug;
  99 typedef const struct gimple_statement_debug *const_gimple_debug;
 100
 101 struct gimple_statement_goto;
 102 typedef struct gimple_statement_goto *gimple_goto;
 103 typedef const struct gimple_statement_goto *const_gimple_goto;
 104
 105 struct gimple_statement_label;
 106 typedef struct gimple_statement_label *gimple_label;
 107 typedef const struct gimple_statement_label *const_gimple_label;
 108
 109 struct gimple_statement_switch;
 110 typedef struct gimple_statement_switch *gimple_switch;
 111 typedef const struct gimple_statement_switch *const_gimple_switch;
 112
 113 struct gimple_statement_assign;
 114 typedef struct gimple_statement_assign *gimple_assign;
 115 typedef const struct gimple_statement_assign *const_gimple_assign;
 116
 117 struct gimple_statement_asm;
 118 typedef struct gimple_statement_asm *gimple_asm;
 119 typedef const struct gimple_statement_asm *const_gimple_asm;
 120
 121 struct gimple_statement_call;
 122 typedef struct gimple_statement_call *gimple_call;
 123 typedef const struct gimple_statement_call *const_gimple_call;
 124
 125 struct gimple_statement_transaction;
 126 typedef struct gimple_statement_transaction *gimple_transaction;
 127 typedef const struct gimple_statement_transaction *const_gimple_transaction;
 128
 129 struct gimple_statement_return;
 130 typedef struct gimple_statement_return *gimple_return;
 131 typedef const struct gimple_statement_return *const_gimple_return;
 132
 133 struct gimple_statement_bind;
 134 typedef struct gimple_statement_bind *gimple_bind;
 135 typedef const struct gimple_statement_bind *const_gimple_bind;
 136
 137 struct gimple_statement_catch;
 138 typedef struct gimple_statement_catch *gimple_catch;
 139 typedef const struct gimple_statement_catch *const_gimple_catch;
 140
 141 struct gimple_statement_eh_filter;
 142 typedef struct gimple_statement_eh_filter *gimple_eh_filter;
 143 typedef const struct gimple_statement_eh_filter *const_gimple_eh_filter;
 144
 145 struct gimple_statement_eh_mnt;
 146 typedef struct gimple_statement_eh_mnt *gimple_eh_must_not_throw;
 147 typedef const struct gimple_statement_eh_mnt *const_gimple_eh_must_not_throw;
 148
 149 struct gimple_statement_eh_else;
 150 typedef struct gimple_statement_eh_else *gimple_eh_else;
 151 typedef const struct gimple_statement_eh_else *const_gimple_eh_else;
 152
 153 struct gimple_statement_resx;
 154 typedef struct gimple_statement_resx *gimple_resx;
 155 typedef const struct gimple_statement_resx *const_gimple_resx;
 156
 157 struct gimple_statement_eh_dispatch;
 158 typedef struct gimple_statement_eh_dispatch *gimple_eh_dispatch;
 159 typedef const struct gimple_statement_eh_dispatch *const_gimple_eh_dispatch;
 160
 161 struct gimple_statement_phi;
 162 typedef struct gimple_statement_phi *gimple_phi;
 163 typedef const struct gimple_statement_phi *const_gimple_phi;
 164
 165 struct gimple_statement_try;
 166 typedef struct gimple_statement_try *gimple_try;
 167 typedef const struct gimple_statement_try *const_gimple_try;
 168
 169 struct gimple_statement_omp_atomic_load;
 170 typedef struct gimple_statement_omp_atomic_load *gimple_omp_atomic_load;
 171 typedef const struct gimple_statement_omp_atomic_load *
 172   const_gimple_omp_atomic_load;
 173
 174 struct gimple_statement_omp_atomic_store;
 175 typedef struct gimple_statement_omp_atomic_store *gimple_omp_atomic_store;
 176 typedef const struct gimple_statement_omp_atomic_store *
 177   const_gimple_omp_atomic_store;
 178
 179 struct gimple_statement_omp_continue;
 180 typedef struct gimple_statement_omp_continue *gimple_omp_continue;
 181 typedef const struct gimple_statement_omp_continue *const_gimple_omp_continue;
 182
 183 struct gimple_statement_omp_critical;
 184 typedef struct gimple_statement_omp_critical *gimple_omp_critical;
 185 typedef const struct gimple_statement_omp_critical *const_gimple_omp_critical;
 186
 187 struct gimple_statement_omp_for;
 188 typedef struct gimple_statement_omp_for *gimple_omp_for;
 189 typedef const struct gimple_statement_omp_for *const_gimple_omp_for;
 190
 191 struct gimple_statement_omp_parallel;
 192 typedef struct gimple_statement_omp_parallel *gimple_omp_parallel;
 193 typedef const struct gimple_statement_omp_parallel *const_gimple_omp_parallel;
 194
 195 struct gimple_statement_omp_task;
 196 typedef struct gimple_statement_omp_task *gimple_omp_task;
 197 typedef const struct gimple_statement_omp_task *const_gimple_omp_task;
 198
 199 struct gimple_statement_omp_sections;
 200 typedef struct gimple_statement_omp_sections *gimple_omp_sections;
 201 typedef const struct gimple_statement_omp_sections *const_gimple_omp_sections;
 202
 203 struct gimple_statement_omp_single;
 204 typedef struct gimple_statement_omp_single *gimple_omp_single;
 205 typedef const struct gimple_statement_omp_single *const_gimple_omp_single;
 206
 207 struct gimple_statement_omp_target;
 208 typedef struct gimple_statement_omp_target *gimple_omp_target;
 209 typedef const struct gimple_statement_omp_target *const_gimple_omp_target;
 210
 211 struct gimple_statement_omp_teams;
 212 typedef struct gimple_statement_omp_teams *gimple_omp_teams;
 213 typedef const struct gimple_statement_omp_teams *const_gimple_omp_teams;
 214
 215 union section;
 216 typedef union section section;
 217 struct gcc_options;
 218 struct cl_target_option;
 219 struct cl_optimization;
 220 struct cl_option;
 221 struct cl_decoded_option;
 222 struct cl_option_handlers;
 223 struct diagnostic_context;
 224 struct pretty_printer;
 225
 226 /* Address space number for named address space support.  */
 227 typedef unsigned char addr_space_t;
 228
 229 /* The value of addr_space_t that represents the generic address space.  */
 230 #define ADDR_SPACE_GENERIC 0
 231 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
 232
 233 /* The major intermediate representations of GCC.  */
 234 enum ir_type {
 235   IR_GIMPLE,
 236   IR_RTL_CFGRTL,
 237   IR_RTL_CFGLAYOUT
 238 };
 239
 240 /* Provide forward struct declaration so that we don't have to include
 241    all of cpplib.h whenever a random prototype includes a pointer.
 242    Note that the cpp_reader and cpp_token typedefs remain part of
 243    cpplib.h.  */
 244
 245 struct cpp_reader;
 246 struct cpp_token;
 247
 248 /* The thread-local storage model associated with a given VAR_DECL
 249    or SYMBOL_REF.  This isn't used much, but both trees and RTL refer
 250    to it, so it's here.  */
 251 enum tls_model {
 252   TLS_MODEL_NONE,
 253   TLS_MODEL_EMULATED,
 254   TLS_MODEL_REAL,
 255   TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
 256   TLS_MODEL_LOCAL_DYNAMIC,
 257   TLS_MODEL_INITIAL_EXEC,
 258   TLS_MODEL_LOCAL_EXEC
 259 };
 260
 261 /* Types of unwind/exception handling info that can be generated.  */
 262
 263 enum unwind_info_type
 264 {
 265   UI_NONE,
 266   UI_SJLJ,
 267   UI_DWARF2,
 268   UI_TARGET,
 269   UI_SEH
 270 };
 271
 272 /* Callgraph node profile representation.  */
 273 enum node_frequency {
 274   /* This function most likely won't be executed at all.
 275      (set only when profile feedback is available or via function attribute). */
 276   NODE_FREQUENCY_UNLIKELY_EXECUTED,
 277   /* For functions that are known to be executed once (i.e. constructors, destructors
 278      and main function.  */
 279   NODE_FREQUENCY_EXECUTED_ONCE,
 280   /* The default value.  */
 281   NODE_FREQUENCY_NORMAL,
 282   /* Optimize this function hard
 283      (set only when profile feedback is available or via function attribute). */
 284   NODE_FREQUENCY_HOT
 285 };
 286
 287 /* Possible initialization status of a variable.   When requested
 288    by the user, this information is tracked and recorded in the DWARF
 289    debug information, along with the variable's location.  */
 290 enum var_init_status
 291 {
 292   VAR_INIT_STATUS_UNKNOWN,
 293   VAR_INIT_STATUS_UNINITIALIZED,
 294   VAR_INIT_STATUS_INITIALIZED
 295 };
 296
 297
 298 struct edge_def;
 299 typedef struct edge_def *edge;
 300 typedef const struct edge_def *const_edge;
 301 struct basic_block_def;
 302 typedef struct basic_block_def *basic_block;
 303 typedef const struct basic_block_def *const_basic_block;
 304
 305 #define obstack_chunk_alloc     ((void *(*) (long)) xmalloc)
 306 #define obstack_chunk_free      ((void (*) (void *)) free)
 307 #define OBSTACK_CHUNK_SIZE      0
 308 #define gcc_obstack_init(OBSTACK)                       \
 309   _obstack_begin ((OBSTACK), OBSTACK_CHUNK_SIZE, 0,     \
 310                   obstack_chunk_alloc,                  \
 311                   obstack_chunk_free)
 312
 313 /* enum reg_class is target specific, so it should not appear in
 314    target-independent code or interfaces, like the target hook declarations
 315    in target.h.  */
 316 typedef int reg_class_t;
 317
 318 class rtl_opt_pass;
 319
 320 namespace gcc {
 321   class context;
 322 }
 323
 324 #else
 325
 326 struct _dont_use_rtx_here_;
 327 struct _dont_use_rtvec_here_;
 328 struct _dont_use_rtx_insn_here_;
 329 union _dont_use_tree_here_;
 330 #define rtx struct _dont_use_rtx_here_ *
 331 #define const_rtx struct _dont_use_rtx_here_ *
 332 #define rtvec struct _dont_use_rtvec_here *
 333 #define const_rtvec struct _dont_use_rtvec_here *
 334 #define rtx_insn struct _dont_use_rtx_insn_here_
 335 #define tree union _dont_use_tree_here_ *
 336 #define const_tree union _dont_use_tree_here_ *
 337
 338 #endif
 339
 340 /* Classes of functions that compiler needs to check
 341    whether they are present at the runtime or not.  */
 342 enum function_class {
 343   function_c94,
 344   function_c99_misc,
 345   function_c99_math_complex,
 346   function_sincos,
 347   function_c11_misc
 348 };
 349
 350 /* Memory model types for the __atomic* builtins.
 351    This must match the order in libstdc++-v3/include/bits/atomic_base.h.  */
 352 enum memmodel
 353 {
 354   MEMMODEL_RELAXED = 0,
 355   MEMMODEL_CONSUME = 1,
 356   MEMMODEL_ACQUIRE = 2,
 357   MEMMODEL_RELEASE = 3,
 358   MEMMODEL_ACQ_REL = 4,
 359   MEMMODEL_SEQ_CST = 5,
 360   MEMMODEL_LAST = 6
 361 };
 362
 363 /* Suppose that higher bits are target dependent. */
 364 #define MEMMODEL_MASK ((1<<16)-1)
 365
 366 /* Support for user-provided GGC and PCH markers.  The first parameter
 367    is a pointer to a pointer, the second a cookie.  */
 368 typedef void (*gt_pointer_operator) (void *, void *);
 369
 370 #if !defined (HAVE_UCHAR)
 371 typedef unsigned char uchar;
 372 #endif
 373
 374 #endif /* coretypes.h */