gcc/genattr.c

   1 /* Generate attribute information (insn-attr.h) from machine description.
   2    Copyright (C) 1991, 1994, 1996, 1998, 1999, 2000, 2003
   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 /* A range of values.  */
  34
  35 struct range
  36 {
  37   int min;
  38   int max;
  39 };
  40
  41 /* Record information about each function unit mentioned in a
  42    DEFINE_FUNCTION_UNIT.  */
  43
  44 struct function_unit
  45 {
  46   char *name;                   /* Function unit name.  */
  47   struct function_unit *next;   /* Next function unit.  */
  48   int multiplicity;             /* Number of units of this type.  */
  49   int simultaneity;             /* Maximum number of simultaneous insns
  50                                    on this function unit or 0 if unlimited.  */
  51   struct range ready_cost;      /* Range of ready cost values.  */
  52   struct range issue_delay;     /* Range of issue delay values.  */
  53 };
  54
  55 static void extend_range (struct range *, int, int);
  56 static void init_range (struct range *);
  57 static void write_upcase (const char *);
  58 static void gen_attr (rtx);
  59 static void write_units (int, struct range *, struct range *,
  60                          struct range *, struct range *,
  61                          struct range *);
  62 static void
  63 extend_range (struct range *range, int min, int max)
  64 {
  65   if (range->min > min) range->min = min;
  66   if (range->max < max) range->max = max;
  67 }
  68
  69 static void
  70 init_range (struct range *range)
  71 {
  72   range->min = 100000;
  73   range->max = -1;
  74 }
  75
  76 static void
  77 write_upcase (const char *str)
  78 {
  79   for (; *str; str++)
  80     putchar (TOUPPER(*str));
  81 }
  82
  83 static void
  84 gen_attr (rtx attr)
  85 {
  86   const char *p, *tag;
  87   int is_const = GET_CODE (XEXP (attr, 2)) == CONST;
  88
  89   printf ("#define HAVE_ATTR_%s\n", XSTR (attr, 0));
  90
  91   /* If numeric attribute, don't need to write an enum.  */
  92   p = XSTR (attr, 1);
  93   if (*p == '\0')
  94     printf ("extern int get_attr_%s (%s);\n", XSTR (attr, 0),
  95             (is_const ? "void" : "rtx"));
  96   else
  97     {
  98       printf ("enum attr_%s {", XSTR (attr, 0));
  99
 100       while ((tag = scan_comma_elt (&p)) != 0)
 101         {
 102           write_upcase (XSTR (attr, 0));
 103           putchar ('_');
 104           while (tag != p)
 105             putchar (TOUPPER (*tag++));
 106           if (*p == ',')
 107             fputs (", ", stdout);
 108         }
 109
 110       fputs ("};\n", stdout);
 111       printf ("extern enum attr_%s get_attr_%s (%s);\n\n",
 112               XSTR (attr, 0), XSTR (attr, 0), (is_const ? "void" : "rtx"));
 113     }
 114
 115   /* If `length' attribute, write additional function definitions and define
 116      variables used by `insn_current_length'.  */
 117   if (! strcmp (XSTR (attr, 0), "length"))
 118     {
 119       puts ("\
 120 extern void shorten_branches (rtx);\n\
 121 extern int insn_default_length (rtx);\n\
 122 extern int insn_variable_length_p (rtx);\n\
 123 extern int insn_current_length (rtx);\n\n\
 124 #include \"insn-addr.h\"\n");
 125     }
 126 }
 127
 128 static void
 129 write_units (int num_units, struct range *multiplicity, struct range *simultaneity,
 130              struct range *ready_cost, struct range *issue_delay,
 131              struct range *blockage)
 132 {
 133   int i, q_size;
 134
 135   printf ("#define INSN_SCHEDULING\n\n");
 136   printf ("extern int result_ready_cost (rtx);\n");
 137   printf ("extern int function_units_used (rtx);\n\n");
 138   printf ("extern const struct function_unit_desc\n");
 139   printf ("{\n");
 140   printf ("  const char *const name;\n");
 141   printf ("  const int bitmask;\n");
 142   printf ("  const int multiplicity;\n");
 143   printf ("  const int simultaneity;\n");
 144   printf ("  const int default_cost;\n");
 145   printf ("  const int max_issue_delay;\n");
 146   printf ("  int (*const ready_cost_function) (rtx);\n");
 147   printf ("  int (*const conflict_cost_function) (rtx, rtx);\n");
 148   printf ("  const int max_blockage;\n");
 149   printf ("  unsigned int (*const blockage_range_function) (rtx);\n");
 150   printf ("  int (*const blockage_function) (rtx, rtx);\n");
 151   printf ("} function_units[];\n\n");
 152   printf ("#define FUNCTION_UNITS_SIZE %d\n", num_units);
 153   printf ("#define MIN_MULTIPLICITY %d\n", multiplicity->min);
 154   printf ("#define MAX_MULTIPLICITY %d\n", multiplicity->max);
 155   printf ("#define MIN_SIMULTANEITY %d\n", simultaneity->min);
 156   printf ("#define MAX_SIMULTANEITY %d\n", simultaneity->max);
 157   printf ("#define MIN_READY_COST %d\n", ready_cost->min);
 158   printf ("#define MAX_READY_COST %d\n", ready_cost->max);
 159   printf ("#define MIN_ISSUE_DELAY %d\n", issue_delay->min);
 160   printf ("#define MAX_ISSUE_DELAY %d\n", issue_delay->max);
 161   printf ("#define MIN_BLOCKAGE %d\n", blockage->min);
 162   printf ("#define MAX_BLOCKAGE %d\n", blockage->max);
 163   for (i = 0; (1 << i) < blockage->max; i++)
 164     ;
 165   printf ("#define BLOCKAGE_BITS %d\n", i + 1);
 166
 167   /* INSN_QUEUE_SIZE is a power of two larger than MAX_BLOCKAGE and
 168      MAX_READY_COST.  This is the longest time an isnsn may be queued.  */
 169   i = MAX (blockage->max, ready_cost->max);
 170   for (q_size = 1; q_size <= i; q_size <<= 1)
 171     ;
 172   printf ("#define INSN_QUEUE_SIZE %d\n", q_size);
 173 }
 174
 175 int
 176 main (int argc, char **argv)
 177 {
 178   rtx desc;
 179   int have_delay = 0;
 180   int have_annul_true = 0;
 181   int have_annul_false = 0;
 182   int num_insn_reservations = 0;
 183   int num_units = 0;
 184   struct range all_simultaneity, all_multiplicity;
 185   struct range all_ready_cost, all_issue_delay, all_blockage;
 186   struct function_unit *units = 0, *unit;
 187   int i;
 188
 189   init_range (&all_multiplicity);
 190   init_range (&all_simultaneity);
 191   init_range (&all_ready_cost);
 192   init_range (&all_issue_delay);
 193   init_range (&all_blockage);
 194
 195   progname = "genattr";
 196
 197   if (argc <= 1)
 198     fatal ("no input file name");
 199
 200   if (init_md_reader_args (argc, argv) != SUCCESS_EXIT_CODE)
 201     return (FATAL_EXIT_CODE);
 202
 203   puts ("/* Generated automatically by the program `genattr'");
 204   puts ("   from the machine description file `md'.  */\n");
 205   puts ("#ifndef GCC_INSN_ATTR_H");
 206   puts ("#define GCC_INSN_ATTR_H\n");
 207
 208   /* For compatibility, define the attribute `alternative', which is just
 209      a reference to the variable `which_alternative'.  */
 210
 211   puts ("#define HAVE_ATTR_alternative");
 212   puts ("#define get_attr_alternative(insn) which_alternative");
 213
 214   /* Read the machine description.  */
 215
 216   while (1)
 217     {
 218       int line_no, insn_code_number;
 219
 220       desc = read_md_rtx (&line_no, &insn_code_number);
 221       if (desc == NULL)
 222         break;
 223
 224       if (GET_CODE (desc) == DEFINE_ATTR)
 225         gen_attr (desc);
 226
 227       else if (GET_CODE (desc) == DEFINE_DELAY)
 228         {
 229           if (! have_delay)
 230             {
 231               printf ("#define DELAY_SLOTS\n");
 232               printf ("extern int num_delay_slots (rtx);\n");
 233               printf ("extern int eligible_for_delay (rtx, int, rtx, int);\n\n");
 234               printf ("extern int const_num_delay_slots (rtx);\n\n");
 235               have_delay = 1;
 236             }
 237
 238           for (i = 0; i < XVECLEN (desc, 1); i += 3)
 239             {
 240               if (XVECEXP (desc, 1, i + 1) && ! have_annul_true)
 241                 {
 242                   printf ("#define ANNUL_IFTRUE_SLOTS\n");
 243                   printf ("extern int eligible_for_annul_true (rtx, int, rtx, int);\n");
 244                   have_annul_true = 1;
 245                 }
 246
 247               if (XVECEXP (desc, 1, i + 2) && ! have_annul_false)
 248                 {
 249                   printf ("#define ANNUL_IFFALSE_SLOTS\n");
 250                   printf ("extern int eligible_for_annul_false (rtx, int, rtx, int);\n");
 251                   have_annul_false = 1;
 252                 }
 253             }
 254         }
 255
 256       else if (GET_CODE (desc) == DEFINE_FUNCTION_UNIT)
 257         {
 258           const char *name = XSTR (desc, 0);
 259           int multiplicity = XINT (desc, 1);
 260           int simultaneity = XINT (desc, 2);
 261           int ready_cost = MAX (XINT (desc, 4), 1);
 262           int issue_delay = MAX (XINT (desc, 5), 1);
 263           int issueexp_p = (XVEC (desc, 6) != 0);
 264
 265           for (unit = units; unit; unit = unit->next)
 266             if (strcmp (unit->name, name) == 0)
 267               break;
 268
 269           if (unit == 0)
 270             {
 271               unit = (struct function_unit *)
 272                 xmalloc (sizeof (struct function_unit));
 273               unit->name = xstrdup (name);
 274               unit->multiplicity = multiplicity;
 275               unit->simultaneity = simultaneity;
 276               unit->ready_cost.min = unit->ready_cost.max = ready_cost;
 277               unit->issue_delay.min = unit->issue_delay.max = issue_delay;
 278               unit->next = units;
 279               units = unit;
 280               num_units++;
 281
 282               extend_range (&all_multiplicity, multiplicity, multiplicity);
 283               extend_range (&all_simultaneity, simultaneity, simultaneity);
 284             }
 285           else if (unit->multiplicity != multiplicity
 286                    || unit->simultaneity != simultaneity)
 287             fatal ("Differing specifications given for `%s' function unit",
 288                    unit->name);
 289
 290           extend_range (&unit->ready_cost, ready_cost, ready_cost);
 291           extend_range (&unit->issue_delay,
 292                         issueexp_p ? 1 : issue_delay, issue_delay);
 293           extend_range (&all_ready_cost,
 294                         unit->ready_cost.min, unit->ready_cost.max);
 295           extend_range (&all_issue_delay,
 296                         unit->issue_delay.min, unit->issue_delay.max);
 297         }
 298       else if (GET_CODE (desc) == DEFINE_INSN_RESERVATION)
 299         num_insn_reservations++;
 300     }
 301
 302   if (num_units > 0 || num_insn_reservations > 0)
 303     {
 304       if (num_units > 0)
 305         printf ("#define TRADITIONAL_PIPELINE_INTERFACE 1\n");
 306
 307       if (num_insn_reservations > 0)
 308         printf ("#define DFA_PIPELINE_INTERFACE 1\n");
 309
 310       /* Compute the range of blockage cost values.  See genattrtab.c
 311          for the derivation.  BLOCKAGE (E,C) when SIMULTANEITY is zero is
 312
 313              MAX (ISSUE-DELAY (E,C),
 314                   READY-COST (E) - (READY-COST (C) - 1))
 315
 316          and otherwise
 317
 318              MAX (ISSUE-DELAY (E,C),
 319                   READY-COST (E) - (READY-COST (C) - 1),
 320                   READY-COST (E) - FILL-TIME)  */
 321
 322       for (unit = units; unit; unit = unit->next)
 323         {
 324           struct range blockage;
 325
 326           blockage = unit->issue_delay;
 327           blockage.max = MAX (unit->ready_cost.max
 328                               - (unit->ready_cost.min - 1),
 329                               blockage.max);
 330           blockage.min = MAX (1, blockage.min);
 331
 332           if (unit->simultaneity != 0)
 333             {
 334               int fill_time = ((unit->simultaneity - 1)
 335                                * unit->issue_delay.min);
 336               blockage.min = MAX (unit->ready_cost.min - fill_time,
 337                                   blockage.min);
 338               blockage.max = MAX (unit->ready_cost.max - fill_time,
 339                                   blockage.max);
 340             }
 341           extend_range (&all_blockage, blockage.min, blockage.max);
 342         }
 343
 344       write_units (num_units, &all_multiplicity, &all_simultaneity,
 345                    &all_ready_cost, &all_issue_delay, &all_blockage);
 346
 347       /* Output interface for pipeline hazards recognition based on
 348          DFA (deterministic finite state automata.  */
 349       printf ("\n/* DFA based pipeline interface.  */");
 350       printf ("\n#ifndef AUTOMATON_ALTS\n");
 351       printf ("#define AUTOMATON_ALTS 0\n");
 352       printf ("#endif\n\n");
 353       printf ("\n#ifndef AUTOMATON_STATE_ALTS\n");
 354       printf ("#define AUTOMATON_STATE_ALTS 0\n");
 355       printf ("#endif\n\n");
 356       printf ("#ifndef CPU_UNITS_QUERY\n");
 357       printf ("#define CPU_UNITS_QUERY 0\n");
 358       printf ("#endif\n\n");
 359       /* Interface itself: */
 360       printf ("extern int max_dfa_issue_rate;\n\n");
 361       printf ("/* The following macro value is calculated from the\n");
 362       printf ("   automaton based pipeline description and is equal to\n");
 363       printf ("   maximal number of all insns described in constructions\n");
 364       printf ("   `define_insn_reservation' which can be issued on the\n");
 365       printf ("   same processor cycle. */\n");
 366       printf ("#define MAX_DFA_ISSUE_RATE max_dfa_issue_rate\n\n");
 367       printf ("/* Insn latency time defined in define_insn_reservation. */\n");
 368       printf ("extern int insn_default_latency (rtx);\n\n");
 369       printf ("/* Return nonzero if there is a bypass for given insn\n");
 370       printf ("   which is a data producer.  */\n");
 371       printf ("extern int bypass_p (rtx);\n\n");
 372       printf ("/* Insn latency time on data consumed by the 2nd insn.\n");
 373       printf ("   Use the function if bypass_p returns nonzero for\n");
 374       printf ("   the 1st insn. */\n");
 375       printf ("extern int insn_latency (rtx, rtx);\n\n");
 376       printf ("\n#if AUTOMATON_ALTS\n");
 377       printf ("/* The following function returns number of alternative\n");
 378       printf ("   reservations of given insn.  It may be used for better\n");
 379       printf ("   insns scheduling heuristics. */\n");
 380       printf ("extern int insn_alts (rtx);\n\n");
 381       printf ("#endif\n\n");
 382       printf ("/* Maximal possible number of insns waiting results being\n");
 383       printf ("   produced by insns whose execution is not finished. */\n");
 384       printf ("extern int max_insn_queue_index;\n\n");
 385       printf ("/* Pointer to data describing current state of DFA.  */\n");
 386       printf ("typedef void *state_t;\n\n");
 387       printf ("/* Size of the data in bytes.  */\n");
 388       printf ("extern int state_size (void);\n\n");
 389       printf ("/* Initiate given DFA state, i.e. Set up the state\n");
 390       printf ("   as all functional units were not reserved.  */\n");
 391       printf ("extern void state_reset (state_t);\n");
 392       printf ("/* The following function returns negative value if given\n");
 393       printf ("   insn can be issued in processor state described by given\n");
 394       printf ("   DFA state.  In this case, the DFA state is changed to\n");
 395       printf ("   reflect the current and future reservations by given\n");
 396       printf ("   insn.  Otherwise the function returns minimal time\n");
 397       printf ("   delay to issue the insn.  This delay may be zero\n");
 398       printf ("   for superscalar or VLIW processors.  If the second\n");
 399       printf ("   parameter is NULL the function changes given DFA state\n");
 400       printf ("   as new processor cycle started.  */\n");
 401       printf ("extern int state_transition (state_t, rtx);\n");
 402       printf ("\n#if AUTOMATON_STATE_ALTS\n");
 403       printf ("/* The following function returns number of possible\n");
 404       printf ("   alternative reservations of given insn in given\n");
 405       printf ("   DFA state.  It may be used for better insns scheduling\n");
 406       printf ("   heuristics.  By default the function is defined if\n");
 407       printf ("   macro AUTOMATON_STATE_ALTS is defined because its\n");
 408       printf ("   implementation may require much memory.  */\n");
 409       printf ("extern int state_alts (state_t, rtx);\n");
 410       printf ("#endif\n\n");
 411       printf ("extern int min_issue_delay (state_t, rtx);\n");
 412       printf ("/* The following function returns nonzero if no one insn\n");
 413       printf ("   can be issued in current DFA state. */\n");
 414       printf ("extern int state_dead_lock_p (state_t);\n");
 415       printf ("/* The function returns minimal delay of issue of the 2nd\n");
 416       printf ("   insn after issuing the 1st insn in given DFA state.\n");
 417       printf ("   The 1st insn should be issued in given state (i.e.\n");
 418       printf ("    state_transition should return negative value for\n");
 419       printf ("    the insn and the state).  Data dependencies between\n");
 420       printf ("    the insns are ignored by the function.  */\n");
 421       printf
 422         ("extern int min_insn_conflict_delay (state_t, rtx, rtx);\n");
 423       printf ("/* The following function outputs reservations for given\n");
 424       printf ("   insn as they are described in the corresponding\n");
 425       printf ("   define_insn_reservation.  */\n");
 426       printf ("extern void print_reservation (FILE *, rtx);\n");
 427       printf ("\n#if CPU_UNITS_QUERY\n");
 428       printf ("/* The following function returns code of functional unit\n");
 429       printf ("   with given name (see define_cpu_unit). */\n");
 430       printf ("extern int get_cpu_unit_code (const char *);\n");
 431       printf ("/* The following function returns nonzero if functional\n");
 432       printf ("   unit with given code is currently reserved in given\n");
 433       printf ("   DFA state.  */\n");
 434       printf ("extern int cpu_unit_reservation_p (state_t, int);\n");
 435       printf ("#endif\n\n");
 436       printf ("/* Clean insn code cache.  It should be called if there\n");
 437       printf ("   is a chance that condition value in a\n");
 438       printf ("   define_insn_reservation will be changed after\n");
 439       printf ("   last call of dfa_start.  */\n");
 440       printf ("extern void dfa_clean_insn_cache (void);\n\n");
 441       printf ("/* Initiate and finish work with DFA.  They should be\n");
 442       printf ("   called as the first and the last interface\n");
 443       printf ("   functions.  */\n");
 444       printf ("extern void dfa_start (void);\n");
 445       printf ("extern void dfa_finish (void);\n");
 446     }
 447   else
 448     {
 449       /* Otherwise we do no scheduling, but we need these typedefs
 450          in order to avoid uglifying other code with more ifdefs.  */
 451       printf ("typedef void *state_t;\n\n");
 452     }
 453
 454   /* Output flag masks for use by reorg.
 455
 456      Flags are used to hold branch direction and prediction information
 457      for use by eligible_for_...  */
 458   printf("\n#define ATTR_FLAG_forward\t0x1\n");
 459   printf("#define ATTR_FLAG_backward\t0x2\n");
 460   printf("#define ATTR_FLAG_likely\t0x4\n");
 461   printf("#define ATTR_FLAG_very_likely\t0x8\n");
 462   printf("#define ATTR_FLAG_unlikely\t0x10\n");
 463   printf("#define ATTR_FLAG_very_unlikely\t0x20\n");
 464
 465   puts("\n#endif /* GCC_INSN_ATTR_H */");
 466
 467   if (ferror (stdout) || fflush (stdout) || fclose (stdout))
 468     return FATAL_EXIT_CODE;
 469
 470   return SUCCESS_EXIT_CODE;
 471 }
 472
 473 /* Define this so we can link with print-rtl.o to get debug_rtx function.  */
 474 const char *
 475 get_insn_name (int code ATTRIBUTE_UNUSED)
 476 {
 477   return NULL;
 478 }