gcc/genattr.c

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