sdcc/support/cpp/gcc/target.h

   1 /* Data structure definitions for a generic GCC target.
   2    Copyright (C) 2001-2022 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify it
   5    under the terms of the GNU General Public License as published by the
   6    Free Software Foundation; either version 3, or (at your option) any
   7    later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; see the file COPYING3.  If not see
  16    <http://www.gnu.org/licenses/>.
  17
  18    In other words, you are welcome to use, share and improve this program.
  19    You are forbidden to forbid anyone else to use, share and improve
  20    what you give them.   Help stamp out software-hoarding!  */
  21
  22
  23 /* This file contains a data structure that describes a GCC target.
  24    At present it is incomplete, but in future it should grow to
  25    contain most or all target machine and target O/S specific
  26    information.
  27
  28    This structure has its initializer declared in target-def.h in the
  29    form of large macro TARGET_INITIALIZER that expands to many smaller
  30    macros.
  31
  32    The smaller macros each initialize one component of the structure,
  33    and each has a default.  Each target should have a file that
  34    includes target.h and target-def.h, and overrides any inappropriate
  35    defaults by undefining the relevant macro and defining a suitable
  36    replacement.  That file should then contain the definition of
  37    "targetm" like so:
  38
  39    struct gcc_target targetm = TARGET_INITIALIZER;
  40
  41    Doing things this way allows us to bring together everything that
  42    defines a GCC target.  By supplying a default that is appropriate
  43    to most targets, we can easily add new items without needing to
  44    edit dozens of target configuration files.  It should also allow us
  45    to gradually reduce the amount of conditional compilation that is
  46    scattered throughout GCC.  */
  47
  48 #ifndef GCC_TARGET_H
  49 #define GCC_TARGET_H
  50
  51 #include "insn-codes.h"
  52 #include "tm.h"
  53 #include "hard-reg-set.h"
  54
  55 #if 0 // sdcpp
  56
  57 #if CHECKING_P
  58
  59 struct cumulative_args_t { void *magic; void *p; };
  60
  61 #else /* !CHECKING_P */
  62
  63 /* When using a GCC build compiler, we could use
  64    __attribute__((transparent_union)) to get cumulative_args_t function
  65    arguments passed like scalars where the ABI would mandate a less
  66    efficient way of argument passing otherwise.  However, that would come
  67    at the cost of less type-safe !CHECKING_P compilation.  */
  68
  69 union cumulative_args_t { void *p; };
  70
  71 #endif /* !CHECKING_P */
  72
  73 /* Types of memory operation understood by the "by_pieces" infrastructure.
  74    Used by the TARGET_USE_BY_PIECES_INFRASTRUCTURE_P target hook and
  75    internally by the functions in expr.cc.  */
  76
  77 enum by_pieces_operation
  78 {
  79   CLEAR_BY_PIECES,
  80   MOVE_BY_PIECES,
  81   SET_BY_PIECES,
  82   STORE_BY_PIECES,
  83   COMPARE_BY_PIECES
  84 };
  85
  86 extern unsigned HOST_WIDE_INT by_pieces_ninsns (unsigned HOST_WIDE_INT,
  87                                                 unsigned int,
  88                                                 unsigned int,
  89                                                 by_pieces_operation);
  90
  91 /* An example implementation for ELF targets.  Defined in varasm.cc  */
  92 extern void elf_record_gcc_switches (const char *);
  93
  94 /* Some places still assume that all pointer or address modes are the
  95    standard Pmode and ptr_mode.  These optimizations become invalid if
  96    the target actually supports multiple different modes.  For now,
  97    we disable such optimizations on such targets, using this function.  */
  98 extern bool target_default_pointer_address_modes_p (void);
  99
 100 /* For hooks which use the MOVE_RATIO macro, this gives the legacy default
 101    behavior.  */
 102 extern unsigned int get_move_ratio (bool);
 103
 104 struct stdarg_info;
 105 struct spec_info_def;
 106 struct hard_reg_set_container;
 107 struct cgraph_node;
 108 struct cgraph_simd_clone;
 109
 110 /* The struct used by the secondary_reload target hook.  */
 111 struct secondary_reload_info
 112 {
 113   /* icode is actually an enum insn_code, but we don't want to force every
 114      file that includes target.h to include optabs.h .  */
 115   int icode;
 116   int extra_cost; /* Cost for using (a) scratch register(s) to be taken
 117                      into account by copy_cost.  */
 118   /* The next two members are for the use of the backward
 119      compatibility hook.  */
 120   struct secondary_reload_info *prev_sri;
 121   int t_icode; /* Actually an enum insn_code - see above.  */
 122 };
 123
 124 /* This is defined in sched-int.h .  */
 125 struct _dep;
 126
 127 /* This is defined in ddg.h .  */
 128 struct ddg;
 129
 130 /* This is defined in cfgloop.h .  */
 131 class loop;
 132
 133 /* This is defined in ifcvt.h.  */
 134 struct noce_if_info;
 135
 136 /* This is defined in tree-ssa-alias.h.  */
 137 class ao_ref;
 138
 139 /* This is defined in tree-vectorizer.h.  */
 140 class _stmt_vec_info;
 141
 142 /* This is defined in calls.h.  */
 143 class function_arg_info;
 144
 145 /* This is defined in function-abi.h.  */
 146 class predefined_function_abi;
 147
 148 /* These are defined in tree-vect-stmts.cc.  */
 149 extern tree stmt_vectype (class _stmt_vec_info *);
 150 extern bool stmt_in_inner_loop_p (class vec_info *, class _stmt_vec_info *);
 151
 152 /* Assembler instructions for creating various kinds of integer object.  */
 153
 154 struct asm_int_op
 155 {
 156   const char *hi;
 157   const char *psi;
 158   const char *si;
 159   const char *pdi;
 160   const char *di;
 161   const char *pti;
 162   const char *ti;
 163 };
 164
 165 /* Types of costs for vectorizer cost model.  */
 166 enum vect_cost_for_stmt
 167 {
 168   scalar_stmt,
 169   scalar_load,
 170   scalar_store,
 171   vector_stmt,
 172   vector_load,
 173   vector_gather_load,
 174   unaligned_load,
 175   unaligned_store,
 176   vector_store,
 177   vector_scatter_store,
 178   vec_to_scalar,
 179   scalar_to_vec,
 180   cond_branch_not_taken,
 181   cond_branch_taken,
 182   vec_perm,
 183   vec_promote_demote,
 184   vec_construct
 185 };
 186
 187 /* Separate locations for which the vectorizer cost model should
 188    track costs.  */
 189 enum vect_cost_model_location {
 190   vect_prologue = 0,
 191   vect_body = 1,
 192   vect_epilogue = 2
 193 };
 194
 195 class vec_perm_indices;
 196
 197 /* The type to use for lists of vector sizes.  */
 198 typedef vec<machine_mode> vector_modes;
 199
 200 /* Same, but can be used to construct local lists that are
 201    automatically freed.  */
 202 typedef auto_vec<machine_mode, 8> auto_vector_modes;
 203
 204 /* First argument of targetm.omp.device_kind_arch_isa.  */
 205 enum omp_device_kind_arch_isa {
 206   omp_device_kind,
 207   omp_device_arch,
 208   omp_device_isa
 209 };
 210
 211 /* Flags returned by TARGET_VECTORIZE_AUTOVECTORIZE_VECTOR_MODES:
 212
 213    VECT_COMPARE_COSTS
 214        Tells the loop vectorizer to try all the provided modes and
 215        pick the one with the lowest cost.  By default the vectorizer
 216        will choose the first mode that works.  */
 217 const unsigned int VECT_COMPARE_COSTS = 1U << 0;
 218
 219 /* The contexts in which the use of a type T can be checked by
 220    TARGET_VERIFY_TYPE_CONTEXT.  */
 221 enum type_context_kind {
 222   /* Directly measuring the size of T.  */
 223   TCTX_SIZEOF,
 224
 225   /* Directly measuring the alignment of T.  */
 226   TCTX_ALIGNOF,
 227
 228   /* Creating objects of type T with static storage duration.  */
 229   TCTX_STATIC_STORAGE,
 230
 231   /* Creating objects of type T with thread-local storage duration.  */
 232   TCTX_THREAD_STORAGE,
 233
 234   /* Creating a field of type T.  */
 235   TCTX_FIELD,
 236
 237   /* Creating an array with elements of type T.  */
 238   TCTX_ARRAY_ELEMENT,
 239
 240   /* Adding to or subtracting from a pointer to T, or computing the
 241      difference between two pointers when one of them is a pointer to T.  */
 242   TCTX_POINTER_ARITH,
 243
 244   /* Dynamically allocating objects of type T.  */
 245   TCTX_ALLOCATION,
 246
 247   /* Dynamically deallocating objects of type T.  */
 248   TCTX_DEALLOCATION,
 249
 250   /* Throwing or catching an object of type T.  */
 251   TCTX_EXCEPTIONS,
 252
 253   /* Capturing objects of type T by value in a closure.  */
 254   TCTX_CAPTURE_BY_COPY
 255 };
 256
 257 enum poly_value_estimate_kind
 258 {
 259   POLY_VALUE_MIN,
 260   POLY_VALUE_MAX,
 261   POLY_VALUE_LIKELY
 262 };
 263
 264 extern bool verify_type_context (location_t, type_context_kind, const_tree,
 265                                  bool = false);
 266
 267 /* The target structure.  This holds all the backend hooks.  */
 268 #define DEFHOOKPOD(NAME, DOC, TYPE, INIT) TYPE NAME;
 269 #define DEFHOOK(NAME, DOC, TYPE, PARAMS, INIT) TYPE (* NAME) PARAMS;
 270 #define DEFHOOK_UNDOC DEFHOOK
 271 #define HOOKSTRUCT(FRAGMENT) FRAGMENT
 272
 273 #include "target.def"
 274
 275 extern struct gcc_target targetm;
 276
 277 /* Return an estimate of the runtime value of X, for use in things
 278    like cost calculations or profiling frequencies.  Note that this
 279    function should never be used in situations where the actual
 280    runtime value is needed for correctness, since the function only
 281    provides a rough guess.  */
 282
 283 static inline HOST_WIDE_INT
 284 estimated_poly_value (poly_int64 x,
 285                       poly_value_estimate_kind kind = POLY_VALUE_LIKELY)
 286 {
 287   if (NUM_POLY_INT_COEFFS == 1)
 288     return x.coeffs[0];
 289   else
 290     return targetm.estimated_poly_value (x, kind);
 291 }
 292
 293 #ifdef GCC_TM_H
 294
 295 #ifndef CUMULATIVE_ARGS_MAGIC
 296 #define CUMULATIVE_ARGS_MAGIC ((void *) &targetm.calls)
 297 #endif
 298
 299 static inline CUMULATIVE_ARGS *
 300 get_cumulative_args (cumulative_args_t arg)
 301 {
 302 #if CHECKING_P
 303   gcc_assert (arg.magic == CUMULATIVE_ARGS_MAGIC);
 304 #endif /* CHECKING_P */
 305   return (CUMULATIVE_ARGS *) arg.p;
 306 }
 307
 308 static inline cumulative_args_t
 309 pack_cumulative_args (CUMULATIVE_ARGS *arg)
 310 {
 311   cumulative_args_t ret;
 312
 313 #if CHECKING_P
 314   ret.magic = CUMULATIVE_ARGS_MAGIC;
 315 #endif /* CHECKING_P */
 316   ret.p = (void *) arg;
 317   return ret;
 318 }
 319 #endif /* GCC_TM_H */
 320
 321 #endif // sdcpp
 322 #endif /* GCC_TARGET_H */