gcc/target.h

   1 /* Data structure definitions for a generic GCC target.
   2    Copyright (C) 2001 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 2, 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; if not, write to the Free Software
  16 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  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 /* This file contains a data structure that describes a GCC target.
  23    At present it is incomplete, but in future it should grow to
  24    contain most or all target machine and target O/S specific
  25    information.
  26
  27    This structure has its initializer declared in target-def.h in the
  28    form of large macro TARGET_INITIALIZER that expands to many smaller
  29    macros.
  30
  31    The smaller macros each initialize one component of the structure,
  32    and each has a default.  Each target should have a file that
  33    includes target.h and target-def.h, and overrides any inappropriate
  34    defaults by undefining the relevant macro and defining a suitable
  35    replacement.  That file should then contain the definition of
  36    "targetm" like so:
  37
  38    struct gcc_target targetm = TARGET_INITIALIZER;
  39
  40    Doing things this way allows us to bring together everything that
  41    defines a GCC target.  By supplying a default that is appropriate
  42    to most targets, we can easily add new items without needing to
  43    edit dozens of target configuration files.  It should also allow us
  44    to gradually reduce the amount of conditional compilation that is
  45    scattered throughout GCC.  */
  46
  47 struct gcc_target
  48 {
  49   /* Functions that output assembler for the target.  */
  50   struct asm_out
  51   {
  52     /* Opening and closing parentheses for asm expression grouping.  */
  53     const char *open_paren, *close_paren;
  54
  55     /* Output the assembler code for entry to a function.  */
  56     void (* function_prologue) PARAMS ((FILE *, HOST_WIDE_INT));
  57
  58     /* Output the assembler code for end of prologue.  */
  59     void (* function_end_prologue) PARAMS ((FILE *));
  60
  61     /* Output the assembler code for start of epilogue.  */
  62     void (* function_begin_epilogue) PARAMS ((FILE *));
  63
  64     /* Output the assembler code for function exit.  */
  65     void (* function_epilogue) PARAMS ((FILE *, HOST_WIDE_INT));
  66   } asm_out;
  67
  68   /* Given two decls, merge their attributes and return the result.  */
  69   tree (* merge_decl_attributes) PARAMS ((tree, tree));
  70
  71   /* Given two types, merge their attributes and return the result.  */
  72   tree (* merge_type_attributes) PARAMS ((tree, tree));
  73
  74   /* Return nonzero if IDENTIFIER with arguments ARGS is a valid machine
  75      specific attribute for DECL.  The attributes in ATTRIBUTES have
  76      previously been assigned to DECL.  */
  77   int (* valid_decl_attribute) PARAMS ((tree decl, tree attributes,
  78                                         tree identifier, tree args));
  79
  80   /* Return nonzero if IDENTIFIER with arguments ARGS is a valid machine
  81      specific attribute for TYPE.  The attributes in ATTRIBUTES have
  82      previously been assigned to TYPE.  */
  83   int (* valid_type_attribute) PARAMS ((tree type, tree attributes,
  84                                         tree identifier, tree args));
  85
  86   /* Return zero if the attributes on TYPE1 and TYPE2 are incompatible,
  87      one if they are compatible and two if they are nearly compatible
  88      (which causes a warning to be generated).  */
  89   int (* comp_type_attributes) PARAMS ((tree type1, tree type2));
  90
  91   /* Assign default attributes to the newly defined TYPE.  */
  92   void (* set_default_type_attributes) PARAMS ((tree type));
  93
  94   /* Insert attributes on the newly created DECL.  */
  95   void (* insert_attributes) PARAMS ((tree decl, tree *attributes));
  96 };
  97
  98 extern struct gcc_target targetm;