gcc/genattr.c

   1 /* Generate attribute information (insn-attr.h) from machine description.
   2    Copyright (C) 1991, 1994, 1996, 1998, 1999 Free Software Foundation, Inc.
   3    Contributed by Richard Kenner (kenner@vlsi1.ultra.nyu.edu)
   4
   5 This file is part of GNU CC.
   6
   7 GNU CC is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU CC is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU CC; see the file COPYING.  If not, write to
  19 the Free Software Foundation, 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22
  23 #include "hconfig.h"
  24 #include "system.h"
  25 #include "rtl.h"
  26 #include "obstack.h"
  27 #include "errors.h"
  28
  29 static struct obstack obstack;
  30 struct obstack *rtl_obstack = &obstack;
  31
  32 #define obstack_chunk_alloc xmalloc
  33 #define obstack_chunk_free free
  34
  35 /* A range of values.  */
  36
  37 struct range
  38 {
  39   int min;
  40   int max;
  41 };
  42
  43 /* Record information about each function unit mentioned in a
  44    DEFINE_FUNCTION_UNIT.  */
  45
  46 struct function_unit
  47 {
  48   char *name;                   /* Function unit name.  */
  49   struct function_unit *next;   /* Next function unit.  */
  50   int multiplicity;             /* Number of units of this type.  */
  51   int simultaneity;             /* Maximum number of simultaneous insns
  52                                    on this function unit or 0 if unlimited.  */
  53   struct range ready_cost;      /* Range of ready cost values.  */
  54   struct range issue_delay;     /* Range of issue delay values.  */
  55 };
  56
  57 static void extend_range PROTO((struct range *, int, int));
  58 static void init_range PROTO((struct range *));
  59 static void write_upcase PROTO((const char *));
  60 static void gen_attr PROTO((rtx));
  61 static void write_units PROTO((int, struct range *, struct range *,
  62                                struct range *, struct range *,
  63                                struct range *));
  64 static void
  65 extend_range (range, min, max)
  66      struct range *range;
  67      int min;
  68      int max;
  69 {
  70   if (range->min > min) range->min = min;
  71   if (range->max < max) range->max = max;
  72 }
  73
  74 static void
  75 init_range (range)
  76      struct range *range;
  77 {
  78   range->min = 100000;
  79   range->max = -1;
  80 }
  81
  82 static void
  83 write_upcase (str)
  84     const char *str;
  85 {
  86   for (; *str; str++)
  87     putchar (TOUPPER(*str));
  88 }
  89
  90 static void
  91 gen_attr (attr)
  92      rtx attr;
  93 {
  94   char *p;
  95   int is_const = GET_CODE (XEXP (attr, 2)) == CONST;
  96
  97   printf ("#define HAVE_ATTR_%s\n", XSTR (attr, 0));
  98
  99   /* If numeric attribute, don't need to write an enum.  */
 100   if (*XSTR (attr, 1) == '\0')
 101     printf ("extern int get_attr_%s PROTO((%s));\n", XSTR (attr, 0),
 102             (is_const ? "void" : "rtx"));
 103   else
 104     {
 105       printf ("enum attr_%s {", XSTR (attr, 0));
 106       write_upcase (XSTR (attr, 0));
 107       printf ("_");
 108
 109       for (p = XSTR (attr, 1); *p != '\0'; p++)
 110         {
 111           if (*p == ',')
 112             {
 113               printf (", ");
 114               write_upcase (XSTR (attr, 0));
 115               printf ("_");
 116             }
 117           else
 118             putchar (TOUPPER(*p));
 119         }
 120
 121       printf ("};\n");
 122       printf ("extern enum attr_%s get_attr_%s PROTO((%s));\n\n",
 123               XSTR (attr, 0), XSTR (attr, 0), (is_const ? "void" : "rtx"));
 124     }
 125
 126   /* If `length' attribute, write additional function definitions and define
 127      variables used by `insn_current_length'.  */
 128   if (! strcmp (XSTR (attr, 0), "length"))
 129     {
 130       printf ("extern void shorten_branches PROTO((rtx));\n");
 131       printf ("extern int insn_default_length PROTO((rtx));\n");
 132       printf ("extern int insn_variable_length_p PROTO((rtx));\n");
 133       printf ("extern int insn_current_length PROTO((rtx));\n\n");
 134       printf ("extern int *insn_addresses;\n");
 135       printf ("extern int insn_current_address;\n\n");
 136     }
 137 }
 138
 139 static void
 140 write_units (num_units, multiplicity, simultaneity,
 141              ready_cost, issue_delay, blockage)
 142      int num_units;
 143      struct range *multiplicity;
 144      struct range *simultaneity;
 145      struct range *ready_cost;
 146      struct range *issue_delay;
 147      struct range *blockage;
 148 {
 149   int i, q_size;
 150
 151   printf ("#define INSN_SCHEDULING\n\n");
 152   printf ("extern int result_ready_cost PROTO((rtx));\n");
 153   printf ("extern int function_units_used PROTO((rtx));\n\n");
 154   printf ("extern struct function_unit_desc\n");
 155   printf ("{\n");
 156   printf ("  const char *name;\n");
 157   printf ("  int bitmask;\n");
 158   printf ("  int multiplicity;\n");
 159   printf ("  int simultaneity;\n");
 160   printf ("  int default_cost;\n");
 161   printf ("  int max_issue_delay;\n");
 162   printf ("  int (*ready_cost_function) PROTO ((rtx));\n");
 163   printf ("  int (*conflict_cost_function) PROTO ((rtx, rtx));\n");
 164   printf ("  int max_blockage;\n");
 165   printf ("  unsigned int (*blockage_range_function) PROTO ((rtx));\n");
 166   printf ("  int (*blockage_function) PROTO ((rtx, rtx));\n");
 167   printf ("} function_units[];\n\n");
 168   printf ("#define FUNCTION_UNITS_SIZE %d\n", num_units);
 169   printf ("#define MIN_MULTIPLICITY %d\n", multiplicity->min);
 170   printf ("#define MAX_MULTIPLICITY %d\n", multiplicity->max);
 171   printf ("#define MIN_SIMULTANEITY %d\n", simultaneity->min);
 172   printf ("#define MAX_SIMULTANEITY %d\n", simultaneity->max);
 173   printf ("#define MIN_READY_COST %d\n", ready_cost->min);
 174   printf ("#define MAX_READY_COST %d\n", ready_cost->max);
 175   printf ("#define MIN_ISSUE_DELAY %d\n", issue_delay->min);
 176   printf ("#define MAX_ISSUE_DELAY %d\n", issue_delay->max);
 177   printf ("#define MIN_BLOCKAGE %d\n", blockage->min);
 178   printf ("#define MAX_BLOCKAGE %d\n", blockage->max);
 179   for (i = 0; (1 << i) < blockage->max; i++)
 180     ;
 181   printf ("#define BLOCKAGE_BITS %d\n", i + 1);
 182
 183   /* INSN_QUEUE_SIZE is a power of two larger than MAX_BLOCKAGE and
 184      MAX_READY_COST.  This is the longest time an isnsn may be queued.  */
 185   i = MAX (blockage->max, ready_cost->max);
 186   for (q_size = 1; q_size <= i; q_size <<= 1)
 187     ;
 188   printf ("#define INSN_QUEUE_SIZE %d\n", q_size);
 189 }
 190
 191 PTR
 192 xmalloc (size)
 193   size_t size;
 194 {
 195   register PTR val = (PTR) malloc (size);
 196
 197   if (val == 0)
 198     fatal ("virtual memory exhausted");
 199   return val;
 200 }
 201
 202 PTR
 203 xrealloc (old, size)
 204   PTR old;
 205   size_t size;
 206 {
 207   register PTR ptr;
 208   if (old)
 209     ptr = (PTR) realloc (old, size);
 210   else
 211     ptr = (PTR) malloc (size);
 212   if (!ptr)
 213     fatal ("virtual memory exhausted");
 214   return ptr;
 215 }
 216
 217 extern int main PROTO ((int, char **));
 218
 219 int
 220 main (argc, argv)
 221      int argc;
 222      char **argv;
 223 {
 224   rtx desc;
 225   FILE *infile;
 226   register int c;
 227   int have_delay = 0;
 228   int have_annul_true = 0;
 229   int have_annul_false = 0;
 230   int num_units = 0;
 231   struct range all_simultaneity, all_multiplicity;
 232   struct range all_ready_cost, all_issue_delay, all_blockage;
 233   struct function_unit *units = 0, *unit;
 234   int i;
 235
 236   init_range (&all_multiplicity);
 237   init_range (&all_simultaneity);
 238   init_range (&all_ready_cost);
 239   init_range (&all_issue_delay);
 240   init_range (&all_blockage);
 241
 242   progname = "genattr";
 243   obstack_init (rtl_obstack);
 244
 245   if (argc <= 1)
 246     fatal ("No input file name.");
 247
 248   infile = fopen (argv[1], "r");
 249   if (infile == 0)
 250     {
 251       perror (argv[1]);
 252       return (FATAL_EXIT_CODE);
 253     }
 254   read_rtx_filename = argv[1];
 255
 256   printf ("/* Generated automatically by the program `genattr'\n\
 257 from the machine description file `md'.  */\n\n");
 258
 259   /* For compatibility, define the attribute `alternative', which is just
 260      a reference to the variable `which_alternative'.  */
 261
 262   printf ("#define HAVE_ATTR_alternative\n");
 263   printf ("#define get_attr_alternative(insn) which_alternative\n");
 264
 265   /* Read the machine description.  */
 266
 267   while (1)
 268     {
 269       c = read_skip_spaces (infile);
 270       if (c == EOF)
 271         break;
 272       ungetc (c, infile);
 273
 274       desc = read_rtx (infile);
 275       if (GET_CODE (desc) == DEFINE_ATTR)
 276         gen_attr (desc);
 277
 278       else if (GET_CODE (desc) == DEFINE_DELAY)
 279         {
 280           if (! have_delay)
 281             {
 282               printf ("#define DELAY_SLOTS\n");
 283               printf ("extern int num_delay_slots PROTO((rtx));\n");
 284               printf ("extern int eligible_for_delay PROTO((rtx, int, rtx, int));\n\n");
 285               printf ("extern int const_num_delay_slots PROTO((rtx));\n\n");
 286               have_delay = 1;
 287             }
 288
 289           for (i = 0; i < XVECLEN (desc, 1); i += 3)
 290             {
 291               if (XVECEXP (desc, 1, i + 1) && ! have_annul_true)
 292                 {
 293                   printf ("#define ANNUL_IFTRUE_SLOTS\n");
 294                   printf ("extern int eligible_for_annul_true PROTO ((rtx, int, rtx, int));\n");
 295                   have_annul_true = 1;
 296                 }
 297
 298               if (XVECEXP (desc, 1, i + 2) && ! have_annul_false)
 299                 {
 300                   printf ("#define ANNUL_IFFALSE_SLOTS\n");
 301                   printf ("extern int eligible_for_annul_false PROTO ((rtx, int, rtx, int));\n");
 302                   have_annul_false = 1;
 303                 }
 304             }
 305         }
 306
 307       else if (GET_CODE (desc) == DEFINE_FUNCTION_UNIT)
 308         {
 309           char *name = XSTR (desc, 0);
 310           int multiplicity = XINT (desc, 1);
 311           int simultaneity = XINT (desc, 2);
 312           int ready_cost = MAX (XINT (desc, 4), 1);
 313           int issue_delay = MAX (XINT (desc, 5), 1);
 314           int issueexp_p = (XVEC (desc, 6) != 0);
 315
 316           for (unit = units; unit; unit = unit->next)
 317             if (strcmp (unit->name, name) == 0)
 318               break;
 319
 320           if (unit == 0)
 321             {
 322               int len = strlen (name) + 1;
 323               unit = (struct function_unit *)
 324                 alloca (sizeof (struct function_unit));
 325               unit->name = (char *) alloca (len);
 326               bcopy (name, unit->name, len);
 327               unit->multiplicity = multiplicity;
 328               unit->simultaneity = simultaneity;
 329               unit->ready_cost.min = unit->ready_cost.max = ready_cost;
 330               unit->issue_delay.min = unit->issue_delay.max = issue_delay;
 331               unit->next = units;
 332               units = unit;
 333               num_units++;
 334
 335               extend_range (&all_multiplicity, multiplicity, multiplicity);
 336               extend_range (&all_simultaneity, simultaneity, simultaneity);
 337             }
 338           else if (unit->multiplicity != multiplicity
 339                    || unit->simultaneity != simultaneity)
 340             fatal ("Differing specifications given for `%s' function unit.",
 341                    unit->name);
 342
 343           extend_range (&unit->ready_cost, ready_cost, ready_cost);
 344           extend_range (&unit->issue_delay,
 345                         issueexp_p ? 1 : issue_delay, issue_delay);
 346           extend_range (&all_ready_cost,
 347                         unit->ready_cost.min, unit->ready_cost.max);
 348           extend_range (&all_issue_delay,
 349                         unit->issue_delay.min, unit->issue_delay.max);
 350         }
 351     }
 352
 353   if (num_units > 0)
 354     {
 355       /* Compute the range of blockage cost values.  See genattrtab.c
 356          for the derivation.  BLOCKAGE (E,C) when SIMULTANEITY is zero is
 357
 358              MAX (ISSUE-DELAY (E,C),
 359                   READY-COST (E) - (READY-COST (C) - 1))
 360
 361          and otherwise
 362
 363              MAX (ISSUE-DELAY (E,C),
 364                   READY-COST (E) - (READY-COST (C) - 1),
 365                   READY-COST (E) - FILL-TIME)  */
 366
 367       for (unit = units; unit; unit = unit->next)
 368         {
 369           struct range blockage;
 370
 371           blockage = unit->issue_delay;
 372           blockage.max = MAX (unit->ready_cost.max
 373                               - (unit->ready_cost.min - 1),
 374                               blockage.max);
 375           blockage.min = MAX (1, blockage.min);
 376
 377           if (unit->simultaneity != 0)
 378             {
 379               int fill_time = ((unit->simultaneity - 1)
 380                                * unit->issue_delay.min);
 381               blockage.min = MAX (unit->ready_cost.min - fill_time,
 382                                   blockage.min);
 383               blockage.max = MAX (unit->ready_cost.max - fill_time,
 384                                   blockage.max);
 385             }
 386           extend_range (&all_blockage, blockage.min, blockage.max);
 387         }
 388
 389       write_units (num_units, &all_multiplicity, &all_simultaneity,
 390                    &all_ready_cost, &all_issue_delay, &all_blockage);
 391     }
 392
 393   /* Output flag masks for use by reorg.
 394
 395      Flags are used to hold branch direction and prediction information
 396      for use by eligible_for_...  */
 397   printf("\n#define ATTR_FLAG_forward\t0x1\n");
 398   printf("#define ATTR_FLAG_backward\t0x2\n");
 399   printf("#define ATTR_FLAG_likely\t0x4\n");
 400   printf("#define ATTR_FLAG_very_likely\t0x8\n");
 401   printf("#define ATTR_FLAG_unlikely\t0x10\n");
 402   printf("#define ATTR_FLAG_very_unlikely\t0x20\n");
 403
 404   fflush (stdout);
 405   return (ferror (stdout) != 0 ? FATAL_EXIT_CODE : SUCCESS_EXIT_CODE);
 406 }
 407
 408 /* Define this so we can link with print-rtl.o to get debug_rtx function.  */
 409 const char *
 410 get_insn_name (code)
 411      int code ATTRIBUTE_UNUSED;
 412 {
 413   return NULL;
 414 }