gcc/genattr.c

   1 /* Generate attribute information (insn-attr.h) from machine description.
   2    Copyright (C) 1991, 1994, 1996, 1998, 1999, 2000, 2003, 2004
   3    Free Software Foundation, Inc.
   4    Contributed by Richard Kenner (kenner@vlsi1.ultra.nyu.edu)
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 2, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING.  If not, write to the Free
  20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  21 02111-1307, USA.  */
  22
  23
  24 #include "bconfig.h"
  25 #include "system.h"
  26 #include "coretypes.h"
  27 #include "tm.h"
  28 #include "rtl.h"
  29 #include "errors.h"
  30 #include "gensupport.h"
  31
  32
  33 static void write_upcase (const char *);
  34 static void gen_attr (rtx);
  35
  36 static void
  37 write_upcase (const char *str)
  38 {
  39   for (; *str; str++)
  40     putchar (TOUPPER(*str));
  41 }
  42
  43 static void
  44 gen_attr (rtx attr)
  45 {
  46   const char *p, *tag;
  47   int is_const = GET_CODE (XEXP (attr, 2)) == CONST;
  48
  49   printf ("#define HAVE_ATTR_%s\n", XSTR (attr, 0));
  50
  51   /* If numeric attribute, don't need to write an enum.  */
  52   p = XSTR (attr, 1);
  53   if (*p == '\0')
  54     printf ("extern int get_attr_%s (%s);\n", XSTR (attr, 0),
  55             (is_const ? "void" : "rtx"));
  56   else
  57     {
  58       printf ("enum attr_%s {", XSTR (attr, 0));
  59
  60       while ((tag = scan_comma_elt (&p)) != 0)
  61         {
  62           write_upcase (XSTR (attr, 0));
  63           putchar ('_');
  64           while (tag != p)
  65             putchar (TOUPPER (*tag++));
  66           if (*p == ',')
  67             fputs (", ", stdout);
  68         }
  69
  70       fputs ("};\n", stdout);
  71       printf ("extern enum attr_%s get_attr_%s (%s);\n\n",
  72               XSTR (attr, 0), XSTR (attr, 0), (is_const ? "void" : "rtx"));
  73     }
  74
  75   /* If `length' attribute, write additional function definitions and define
  76      variables used by `insn_current_length'.  */
  77   if (! strcmp (XSTR (attr, 0), "length"))
  78     {
  79       puts ("\
  80 extern void shorten_branches (rtx);\n\
  81 extern int insn_default_length (rtx);\n\
  82 extern int insn_variable_length_p (rtx);\n\
  83 extern int insn_current_length (rtx);\n\n\
  84 #include \"insn-addr.h\"\n");
  85     }
  86 }
  87
  88 int
  89 main (int argc, char **argv)
  90 {
  91   rtx desc;
  92   int have_delay = 0;
  93   int have_annul_true = 0;
  94   int have_annul_false = 0;
  95   int num_insn_reservations = 0;
  96   int i;
  97
  98   progname = "genattr";
  99
 100   if (argc <= 1)
 101     fatal ("no input file name");
 102
 103   if (init_md_reader_args (argc, argv) != SUCCESS_EXIT_CODE)
 104     return (FATAL_EXIT_CODE);
 105
 106   puts ("/* Generated automatically by the program `genattr'");
 107   puts ("   from the machine description file `md'.  */\n");
 108   puts ("#ifndef GCC_INSN_ATTR_H");
 109   puts ("#define GCC_INSN_ATTR_H\n");
 110
 111   /* For compatibility, define the attribute `alternative', which is just
 112      a reference to the variable `which_alternative'.  */
 113
 114   puts ("#define HAVE_ATTR_alternative");
 115   puts ("#define get_attr_alternative(insn) which_alternative");
 116
 117   /* Read the machine description.  */
 118
 119   while (1)
 120     {
 121       int line_no, insn_code_number;
 122
 123       desc = read_md_rtx (&line_no, &insn_code_number);
 124       if (desc == NULL)
 125         break;
 126
 127       if (GET_CODE (desc) == DEFINE_ATTR)
 128         gen_attr (desc);
 129
 130       else if (GET_CODE (desc) == DEFINE_DELAY)
 131         {
 132           if (! have_delay)
 133             {
 134               printf ("#define DELAY_SLOTS\n");
 135               printf ("extern int num_delay_slots (rtx);\n");
 136               printf ("extern int eligible_for_delay (rtx, int, rtx, int);\n\n");
 137               printf ("extern int const_num_delay_slots (rtx);\n\n");
 138               have_delay = 1;
 139             }
 140
 141           for (i = 0; i < XVECLEN (desc, 1); i += 3)
 142             {
 143               if (XVECEXP (desc, 1, i + 1) && ! have_annul_true)
 144                 {
 145                   printf ("#define ANNUL_IFTRUE_SLOTS\n");
 146                   printf ("extern int eligible_for_annul_true (rtx, int, rtx, int);\n");
 147                   have_annul_true = 1;
 148                 }
 149
 150               if (XVECEXP (desc, 1, i + 2) && ! have_annul_false)
 151                 {
 152                   printf ("#define ANNUL_IFFALSE_SLOTS\n");
 153                   printf ("extern int eligible_for_annul_false (rtx, int, rtx, int);\n");
 154                   have_annul_false = 1;
 155                 }
 156             }
 157         }
 158
 159       else if (GET_CODE (desc) == DEFINE_INSN_RESERVATION)
 160         num_insn_reservations++;
 161     }
 162
 163   if (num_insn_reservations > 0)
 164     {
 165       /* Output interface for pipeline hazards recognition based on
 166          DFA (deterministic finite state automata.  */
 167       printf ("\n#define INSN_SCHEDULING\n");
 168       printf ("\n/* DFA based pipeline interface.  */");
 169       printf ("\n#ifndef AUTOMATON_ALTS\n");
 170       printf ("#define AUTOMATON_ALTS 0\n");
 171       printf ("#endif\n\n");
 172       printf ("\n#ifndef AUTOMATON_STATE_ALTS\n");
 173       printf ("#define AUTOMATON_STATE_ALTS 0\n");
 174       printf ("#endif\n\n");
 175       printf ("#ifndef CPU_UNITS_QUERY\n");
 176       printf ("#define CPU_UNITS_QUERY 0\n");
 177       printf ("#endif\n\n");
 178       /* Interface itself: */
 179       printf ("extern int max_dfa_issue_rate;\n\n");
 180       printf ("/* The following macro value is calculated from the\n");
 181       printf ("   automaton based pipeline description and is equal to\n");
 182       printf ("   maximal number of all insns described in constructions\n");
 183       printf ("   `define_insn_reservation' which can be issued on the\n");
 184       printf ("   same processor cycle. */\n");
 185       printf ("#define MAX_DFA_ISSUE_RATE max_dfa_issue_rate\n\n");
 186       printf ("/* Insn latency time defined in define_insn_reservation. */\n");
 187       printf ("extern int insn_default_latency (rtx);\n\n");
 188       printf ("/* Return nonzero if there is a bypass for given insn\n");
 189       printf ("   which is a data producer.  */\n");
 190       printf ("extern int bypass_p (rtx);\n\n");
 191       printf ("/* Insn latency time on data consumed by the 2nd insn.\n");
 192       printf ("   Use the function if bypass_p returns nonzero for\n");
 193       printf ("   the 1st insn. */\n");
 194       printf ("extern int insn_latency (rtx, rtx);\n\n");
 195       printf ("\n#if AUTOMATON_ALTS\n");
 196       printf ("/* The following function returns number of alternative\n");
 197       printf ("   reservations of given insn.  It may be used for better\n");
 198       printf ("   insns scheduling heuristics. */\n");
 199       printf ("extern int insn_alts (rtx);\n\n");
 200       printf ("#endif\n\n");
 201       printf ("/* Maximal possible number of insns waiting results being\n");
 202       printf ("   produced by insns whose execution is not finished. */\n");
 203       printf ("extern int max_insn_queue_index;\n\n");
 204       printf ("/* Pointer to data describing current state of DFA.  */\n");
 205       printf ("typedef void *state_t;\n\n");
 206       printf ("/* Size of the data in bytes.  */\n");
 207       printf ("extern int state_size (void);\n\n");
 208       printf ("/* Initiate given DFA state, i.e. Set up the state\n");
 209       printf ("   as all functional units were not reserved.  */\n");
 210       printf ("extern void state_reset (state_t);\n");
 211       printf ("/* The following function returns negative value if given\n");
 212       printf ("   insn can be issued in processor state described by given\n");
 213       printf ("   DFA state.  In this case, the DFA state is changed to\n");
 214       printf ("   reflect the current and future reservations by given\n");
 215       printf ("   insn.  Otherwise the function returns minimal time\n");
 216       printf ("   delay to issue the insn.  This delay may be zero\n");
 217       printf ("   for superscalar or VLIW processors.  If the second\n");
 218       printf ("   parameter is NULL the function changes given DFA state\n");
 219       printf ("   as new processor cycle started.  */\n");
 220       printf ("extern int state_transition (state_t, rtx);\n");
 221       printf ("\n#if AUTOMATON_STATE_ALTS\n");
 222       printf ("/* The following function returns number of possible\n");
 223       printf ("   alternative reservations of given insn in given\n");
 224       printf ("   DFA state.  It may be used for better insns scheduling\n");
 225       printf ("   heuristics.  By default the function is defined if\n");
 226       printf ("   macro AUTOMATON_STATE_ALTS is defined because its\n");
 227       printf ("   implementation may require much memory.  */\n");
 228       printf ("extern int state_alts (state_t, rtx);\n");
 229       printf ("#endif\n\n");
 230       printf ("extern int min_issue_delay (state_t, rtx);\n");
 231       printf ("/* The following function returns nonzero if no one insn\n");
 232       printf ("   can be issued in current DFA state. */\n");
 233       printf ("extern int state_dead_lock_p (state_t);\n");
 234       printf ("/* The function returns minimal delay of issue of the 2nd\n");
 235       printf ("   insn after issuing the 1st insn in given DFA state.\n");
 236       printf ("   The 1st insn should be issued in given state (i.e.\n");
 237       printf ("    state_transition should return negative value for\n");
 238       printf ("    the insn and the state).  Data dependencies between\n");
 239       printf ("    the insns are ignored by the function.  */\n");
 240       printf
 241         ("extern int min_insn_conflict_delay (state_t, rtx, rtx);\n");
 242       printf ("/* The following function outputs reservations for given\n");
 243       printf ("   insn as they are described in the corresponding\n");
 244       printf ("   define_insn_reservation.  */\n");
 245       printf ("extern void print_reservation (FILE *, rtx);\n");
 246       printf ("\n#if CPU_UNITS_QUERY\n");
 247       printf ("/* The following function returns code of functional unit\n");
 248       printf ("   with given name (see define_cpu_unit). */\n");
 249       printf ("extern int get_cpu_unit_code (const char *);\n");
 250       printf ("/* The following function returns nonzero if functional\n");
 251       printf ("   unit with given code is currently reserved in given\n");
 252       printf ("   DFA state.  */\n");
 253       printf ("extern int cpu_unit_reservation_p (state_t, int);\n");
 254       printf ("#endif\n\n");
 255       printf ("/* Clean insn code cache.  It should be called if there\n");
 256       printf ("   is a chance that condition value in a\n");
 257       printf ("   define_insn_reservation will be changed after\n");
 258       printf ("   last call of dfa_start.  */\n");
 259       printf ("extern void dfa_clean_insn_cache (void);\n\n");
 260       printf ("/* Initiate and finish work with DFA.  They should be\n");
 261       printf ("   called as the first and the last interface\n");
 262       printf ("   functions.  */\n");
 263       printf ("extern void dfa_start (void);\n");
 264       printf ("extern void dfa_finish (void);\n");
 265     }
 266   else
 267     {
 268       /* Otherwise we do no scheduling, but we need these typedefs
 269          in order to avoid uglifying other code with more ifdefs.  */
 270       printf ("typedef void *state_t;\n\n");
 271     }
 272
 273   /* Output flag masks for use by reorg.
 274
 275      Flags are used to hold branch direction and prediction information
 276      for use by eligible_for_...  */
 277   printf("\n#define ATTR_FLAG_forward\t0x1\n");
 278   printf("#define ATTR_FLAG_backward\t0x2\n");
 279   printf("#define ATTR_FLAG_likely\t0x4\n");
 280   printf("#define ATTR_FLAG_very_likely\t0x8\n");
 281   printf("#define ATTR_FLAG_unlikely\t0x10\n");
 282   printf("#define ATTR_FLAG_very_unlikely\t0x20\n");
 283
 284   puts("\n#endif /* GCC_INSN_ATTR_H */");
 285
 286   if (ferror (stdout) || fflush (stdout) || fclose (stdout))
 287     return FATAL_EXIT_CODE;
 288
 289   return SUCCESS_EXIT_CODE;
 290 }
 291
 292 /* Define this so we can link with print-rtl.o to get debug_rtx function.  */
 293 const char *
 294 get_insn_name (int code ATTRIBUTE_UNUSED)
 295 {
 296   return NULL;
 297 }