gcc/coretypes.h

   1 /* GCC core type declarations.
   2    Copyright (C) 2002, 2004, 2007, 2008, 2009, 2010
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 Under Section 7 of GPL version 3, you are granted additional
  18 permissions described in the GCC Runtime Library Exception, version
  19 3.1, as published by the Free Software Foundation.
  20
  21 You should have received a copy of the GNU General Public License and
  22 a copy of the GCC Runtime Library Exception along with this program;
  23 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  24 <http://www.gnu.org/licenses/>.  */
  25
  26 /* Provide forward declarations of core types which are referred to by
  27    most of the compiler.  This allows header files to use these types
  28    (e.g. in function prototypes) without concern for whether the full
  29    definitions are visible.  Some other declarations that need to be
  30    universally visible are here, too.
  31
  32    In the context of tconfig.h, most of these have special definitions
  33    which prevent them from being used except in further type
  34    declarations.  This is a kludge; the right thing is to avoid
  35    including the "tm.h" header set in the context of tconfig.h, but
  36    we're not there yet.  */
  37
  38 #ifndef GCC_CORETYPES_H
  39 #define GCC_CORETYPES_H
  40
  41 #ifndef GTY
  42 #define GTY(x)  /* nothing - marker for gengtype */
  43 #endif
  44
  45 #ifndef USED_FOR_TARGET
  46
  47 struct bitmap_head_def;
  48 typedef struct bitmap_head_def *bitmap;
  49 typedef const struct bitmap_head_def *const_bitmap;
  50 struct simple_bitmap_def;
  51 typedef struct simple_bitmap_def *sbitmap;
  52 typedef const struct simple_bitmap_def *const_sbitmap;
  53 struct rtx_def;
  54 typedef struct rtx_def *rtx;
  55 typedef const struct rtx_def *const_rtx;
  56 struct rtvec_def;
  57 typedef struct rtvec_def *rtvec;
  58 typedef const struct rtvec_def *const_rtvec;
  59 union tree_node;
  60 typedef union tree_node *tree;
  61 union gimple_statement_d;
  62 typedef union gimple_statement_d *gimple;
  63 typedef const union tree_node *const_tree;
  64 typedef const union gimple_statement_d *const_gimple;
  65 union section;
  66 typedef union section section;
  67 struct cl_target_option;
  68 struct cl_optimization;
  69 struct cl_option;
  70 struct cl_decoded_option;
  71 struct cl_option_handlers;
  72 struct gimple_seq_d;
  73 typedef struct gimple_seq_d *gimple_seq;
  74 typedef const struct gimple_seq_d *const_gimple_seq;
  75
  76 /* Address space number for named address space support.  */
  77 typedef unsigned char addr_space_t;
  78
  79 /* The value of addr_space_t that represents the generic address space.  */
  80 #define ADDR_SPACE_GENERIC 0
  81 #define ADDR_SPACE_GENERIC_P(AS) ((AS) == ADDR_SPACE_GENERIC)
  82
  83 /* The major intermediate representations of GCC.  */
  84 enum ir_type {
  85   IR_GIMPLE,
  86   IR_RTL_CFGRTL,
  87   IR_RTL_CFGLAYOUT
  88 };
  89
  90 /* Provide forward struct declaration so that we don't have to include
  91    all of cpplib.h whenever a random prototype includes a pointer.
  92    Note that the cpp_reader and cpp_token typedefs remain part of
  93    cpplib.h.  */
  94
  95 struct cpp_reader;
  96 struct cpp_token;
  97
  98 /* The thread-local storage model associated with a given VAR_DECL
  99    or SYMBOL_REF.  This isn't used much, but both trees and RTL refer
 100    to it, so it's here.  */
 101 enum tls_model {
 102   TLS_MODEL_NONE,
 103   TLS_MODEL_EMULATED,
 104   TLS_MODEL_REAL,
 105   TLS_MODEL_GLOBAL_DYNAMIC = TLS_MODEL_REAL,
 106   TLS_MODEL_LOCAL_DYNAMIC,
 107   TLS_MODEL_INITIAL_EXEC,
 108   TLS_MODEL_LOCAL_EXEC
 109 };
 110
 111 struct edge_def;
 112 typedef struct edge_def *edge;
 113 typedef const struct edge_def *const_edge;
 114 struct basic_block_def;
 115 typedef struct basic_block_def *basic_block;
 116 typedef const struct basic_block_def *const_basic_block;
 117
 118 #define obstack_chunk_alloc     ((void *(*) (long)) xmalloc)
 119 #define obstack_chunk_free      ((void (*) (void *)) free)
 120 #define OBSTACK_CHUNK_SIZE      0
 121 #define gcc_obstack_init(OBSTACK)                       \
 122   _obstack_begin ((OBSTACK), OBSTACK_CHUNK_SIZE, 0,     \
 123                   obstack_chunk_alloc,                  \
 124                   obstack_chunk_free)
 125
 126 /* enum reg_class is target specific, so it should not appear in
 127    target-independent code or interfaces, like the target hook declarations
 128    in target.h.  */
 129 typedef int reg_class_t;
 130
 131 #else
 132
 133 struct _dont_use_rtx_here_;
 134 struct _dont_use_rtvec_here_;
 135 union _dont_use_tree_here_;
 136 #define rtx struct _dont_use_rtx_here_ *
 137 #define const_rtx struct _dont_use_rtx_here_ *
 138 #define rtvec struct _dont_use_rtvec_here *
 139 #define const_rtvec struct _dont_use_rtvec_here *
 140 #define tree union _dont_use_tree_here_ *
 141 #define const_tree union _dont_use_tree_here_ *
 142
 143 #endif
 144
 145 #endif /* coretypes.h */
 146