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 /* Forward declaration for the benefit of prototypes.  */
  48 struct rtx_def;
  49
  50 struct gcc_target
  51 {
  52   /* Functions that output assembler for the target.  */
  53   struct asm_out
  54   {
  55     /* Opening and closing parentheses for asm expression grouping.  */
  56     const char *open_paren, *close_paren;
  57
  58     /* Output the assembler code for entry to a function.  */
  59     void (* function_prologue) PARAMS ((FILE *, HOST_WIDE_INT));
  60
  61     /* Output the assembler code for end of prologue.  */
  62     void (* function_end_prologue) PARAMS ((FILE *));
  63
  64     /* Output the assembler code for start of epilogue.  */
  65     void (* function_begin_epilogue) PARAMS ((FILE *));
  66
  67     /* Output the assembler code for function exit.  */
  68     void (* function_epilogue) PARAMS ((FILE *, HOST_WIDE_INT));
  69
  70     /* Switch to an arbitrary section NAME with attributes as
  71        specified by FLAGS.  */
  72     void (* named_section) PARAMS ((const char *, unsigned int));
  73
  74     /* Output a constructor for a symbol with a given priority.  */
  75     void (* constructor) PARAMS ((struct rtx_def *, int));
  76
  77     /* Output a destructor for a symbol with a given priority.  */
  78     void (* destructor) PARAMS ((struct rtx_def *, int));
  79   } asm_out;
  80
  81   /* Given two decls, merge their attributes and return the result.  */
  82   tree (* merge_decl_attributes) PARAMS ((tree, tree));
  83
  84   /* Given two types, merge their attributes and return the result.  */
  85   tree (* merge_type_attributes) PARAMS ((tree, tree));
  86
  87   /* Return nonzero if IDENTIFIER with arguments ARGS is a valid machine
  88      specific attribute for DECL.  The attributes in ATTRIBUTES have
  89      previously been assigned to DECL.  */
  90   int (* valid_decl_attribute) PARAMS ((tree decl, tree attributes,
  91                                         tree identifier, tree args));
  92
  93   /* Return nonzero if IDENTIFIER with arguments ARGS is a valid machine
  94      specific attribute for TYPE.  The attributes in ATTRIBUTES have
  95      previously been assigned to TYPE.  */
  96   int (* valid_type_attribute) PARAMS ((tree type, tree attributes,
  97                                         tree identifier, tree args));
  98
  99   /* Return zero if the attributes on TYPE1 and TYPE2 are incompatible,
 100      one if they are compatible and two if they are nearly compatible
 101      (which causes a warning to be generated).  */
 102   int (* comp_type_attributes) PARAMS ((tree type1, tree type2));
 103
 104   /* Assign default attributes to the newly defined TYPE.  */
 105   void (* set_default_type_attributes) PARAMS ((tree type));
 106
 107   /* Insert attributes on the newly created DECL.  */
 108   void (* insert_attributes) PARAMS ((tree decl, tree *attributes));
 109
 110   /* Set up target-specific built-in functions.  */
 111   void (* init_builtins) PARAMS ((void));
 112
 113   /* Expand a target-specific builtin.  */
 114   struct rtx_def * (* expand_builtin) PARAMS ((tree exp,
 115                                                struct rtx_def *target,
 116                                                struct rtx_def *subtarget,
 117                                                enum machine_mode mode,
 118                                                int ignore));
 119
 120   /* Given a decl, a section name, and whether the decl initializer
 121      has relocs, choose attributes for the section.  */
 122   /* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION.  */
 123   unsigned int (* section_type_flags) PARAMS ((tree, const char *, int));
 124
 125   /* True if arbitrary sections are supported.  */
 126   bool have_named_sections;
 127
 128   /* True if "native" constructors and destructors are supported,
 129      false if we're using collect2 for the job.  */
 130   bool have_ctors_dtors;
 131 };
 132
 133 extern struct gcc_target targetm;