gcc/gengenrtl.c

   1 /* Generate code to allocate RTL structures.
   2    Copyright (C) 1997, 1998, 1999, 2000, 2002 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 2, or (at your option) any later
   9 version.
  10
  11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING.  If not, write to the Free
  18 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.  */
  20
  21
  22 #include "hconfig.h"
  23 #include "system.h"
  24
  25 #define NO_GENRTL_H
  26 #include "rtl.h"
  27 #undef abort
  28
  29 #include "real.h"
  30
  31 struct rtx_definition
  32 {
  33   const char *const enumname, *const name, *const format;
  34 };
  35
  36 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) { STRINGX(ENUM), NAME, FORMAT },
  37
  38 static const struct rtx_definition defs[] =
  39 {
  40 #include "rtl.def"              /* rtl expressions are documented here */
  41 };
  42
  43 static const char *formats[NUM_RTX_CODE];
  44
  45 static const char *type_from_format     PARAMS ((int));
  46 static const char *accessor_from_format PARAMS ((int));
  47 static int special_format               PARAMS ((const char *));
  48 static int special_rtx                  PARAMS ((int));
  49 static int excluded_rtx                 PARAMS ((int));
  50 static void find_formats                PARAMS ((void));
  51 static void gendecl                     PARAMS ((const char *));
  52 static void genmacro                    PARAMS ((int));
  53 static void gendef                      PARAMS ((const char *));
  54 static void genlegend                   PARAMS ((void));
  55 static void genheader                   PARAMS ((void));
  56 static void gencode                     PARAMS ((void));
  57 \f
  58 /* Decode a format letter into a C type string.  */
  59
  60 static const char *
  61 type_from_format (c)
  62      int c;
  63 {
  64   switch (c)
  65     {
  66     case 'i':
  67       return "int ";
  68
  69     case 'w':
  70       return "HOST_WIDE_INT ";
  71
  72     case 's':
  73       return "const char *";
  74
  75     case 'e':  case 'u':
  76       return "rtx ";
  77
  78     case 'E':
  79       return "rtvec ";
  80     case 'b':
  81       return "struct bitmap_head_def *";  /* bitmap - typedef not available */
  82     case 't':
  83       return "union tree_node *";  /* tree - typedef not available */
  84     case 'B':
  85       return "struct basic_block_def *";  /* basic block - typedef not available */
  86     default:
  87       abort ();
  88     }
  89 }
  90
  91 /* Decode a format letter into the proper accessor function.  */
  92
  93 static const char *
  94 accessor_from_format (c)
  95      int c;
  96 {
  97   switch (c)
  98     {
  99     case 'i':
 100       return "XINT";
 101
 102     case 'w':
 103       return "XWINT";
 104
 105     case 's':
 106       return "XSTR";
 107
 108     case 'e':  case 'u':
 109       return "XEXP";
 110
 111     case 'E':
 112       return "XVEC";
 113
 114     case 'b':
 115       return "XBITMAP";
 116
 117     case 't':
 118       return "XTREE";
 119
 120     case 'B':
 121       return "XBBDEF";
 122     }
 123 }
 124
 125 /* Return nonzero if we should ignore FMT, an RTL format, when making
 126    the list of formats we write routines to create.  */
 127
 128 static int
 129 special_format (fmt)
 130      const char *fmt;
 131 {
 132   return (strchr (fmt, '*') != 0
 133           || strchr (fmt, 'V') != 0
 134           || strchr (fmt, 'S') != 0
 135           || strchr (fmt, 'n') != 0);
 136 }
 137
 138 /* Return nonzero if the RTL code given by index IDX is one that we should
 139    generate a gen_rtx_raw_FOO macro for, not gen_rtx_FOO (because gen_rtx_FOO
 140    is a wrapper in emit-rtl.c).  */
 141
 142 static int
 143 special_rtx (idx)
 144      int idx;
 145 {
 146   return (strcmp (defs[idx].enumname, "CONST_INT") == 0
 147           || strcmp (defs[idx].enumname, "REG") == 0
 148           || strcmp (defs[idx].enumname, "SUBREG") == 0
 149           || strcmp (defs[idx].enumname, "MEM") == 0);
 150 }
 151
 152 /* Return nonzero if the RTL code given by index IDX is one that we should
 153    generate no macro for at all (because gen_rtx_FOO is never used or
 154    cannot have the obvious interface).  */
 155
 156 static int
 157 excluded_rtx (idx)
 158      int idx;
 159 {
 160   return (strcmp (defs[idx].enumname, "CONST_DOUBLE") == 0);
 161 }
 162
 163 /* Place a list of all format specifiers we use into the array FORMAT.  */
 164
 165 static void
 166 find_formats ()
 167 {
 168   int i;
 169
 170   for (i = 0; i < NUM_RTX_CODE; i++)
 171     {
 172       const char **f;
 173
 174       if (special_format (defs[i].format))
 175         continue;
 176
 177       for (f = formats; *f; f++)
 178         if (! strcmp (*f, defs[i].format))
 179           break;
 180
 181       if (*f == 0)
 182         *f = defs[i].format;
 183     }
 184 }
 185
 186 /* Write the declarations for the routine to allocate RTL with FORMAT.  */
 187
 188 static void
 189 gendecl (format)
 190      const char *format;
 191 {
 192   const char *p;
 193   int i, pos;
 194
 195   printf ("extern rtx gen_rtx_fmt_%s\tPARAMS ((RTX_CODE, ", format);
 196   printf ("enum machine_mode mode");
 197
 198   /* Write each parameter that is needed and start a new line when the line
 199      would overflow.  */
 200   for (p = format, i = 0, pos = 75; *p != 0; p++)
 201     if (*p != '0')
 202       {
 203         int ourlen = strlen (type_from_format (*p)) + 6 + (i > 9);
 204
 205         printf (",");
 206         if (pos + ourlen > 76)
 207           printf ("\n\t\t\t\t      "), pos = 39;
 208
 209         printf (" %sarg%d", type_from_format (*p), i++);
 210         pos += ourlen;
 211       }
 212
 213   printf ("));\n");
 214 }
 215
 216 /* Generate macros to generate RTL of code IDX using the functions we
 217    write.  */
 218
 219 static void
 220 genmacro (idx)
 221      int idx;
 222 {
 223   const char *p;
 224   int i;
 225
 226   /* We write a macro that defines gen_rtx_RTLCODE to be an equivalent to
 227      gen_rtx_fmt_FORMAT where FORMAT is the RTX_FORMAT of RTLCODE.  */
 228
 229   if (excluded_rtx (idx))
 230     /* Don't define a macro for this code.  */
 231     return;
 232
 233   printf ("#define gen_rtx_%s%s(MODE",
 234            special_rtx (idx) ? "raw_" : "", defs[idx].enumname);
 235
 236   for (p = defs[idx].format, i = 0; *p != 0; p++)
 237     if (*p != '0')
 238       printf (", ARG%d", i++);
 239
 240   printf (") \\\n  gen_rtx_fmt_%s (%s, (MODE)",
 241           defs[idx].format, defs[idx].enumname);
 242
 243   for (p = defs[idx].format, i = 0; *p != 0; p++)
 244     if (*p != '0')
 245       printf (", (ARG%d)", i++);
 246
 247   puts (")");
 248 }
 249
 250 /* Generate the code for the function to generate RTL whose
 251    format is FORMAT.  */
 252
 253 static void
 254 gendef (format)
 255      const char *format;
 256 {
 257   const char *p;
 258   int i, j;
 259
 260   /* Start by writing the definition of the function name and the types
 261      of the arguments.  */
 262
 263   printf ("rtx\ngen_rtx_fmt_%s (code, mode", format);
 264   for (p = format, i = 0; *p != 0; p++)
 265     if (*p != '0')
 266       printf (", arg%d", i++);
 267
 268   puts (")\n     RTX_CODE code;\n     enum machine_mode mode;");
 269   for (p = format, i = 0; *p != 0; p++)
 270     if (*p != '0')
 271       printf ("     %sarg%d;\n", type_from_format (*p), i++);
 272
 273   /* Now write out the body of the function itself, which allocates
 274      the memory and initializes it.  */
 275   puts ("{");
 276   puts ("  rtx rt;");
 277   printf ("  rt = ggc_alloc_rtx (%d);\n", (int) strlen (format));
 278
 279   puts ("  memset (rt, 0, sizeof (struct rtx_def) - sizeof (rtunion));\n");
 280   puts ("  PUT_CODE (rt, code);");
 281   puts ("  PUT_MODE (rt, mode);");
 282
 283   for (p = format, i = j = 0; *p ; ++p, ++i)
 284     if (*p != '0')
 285       printf ("  %s (rt, %d) = arg%d;\n", accessor_from_format (*p), i, j++);
 286     else
 287       printf ("  X0EXP (rt, %d) = NULL_RTX;\n", i);
 288
 289   puts ("\n  return rt;\n}\n");
 290 }
 291
 292 /* Generate the documentation header for files we write.  */
 293
 294 static void
 295 genlegend ()
 296 {
 297   puts ("/* Generated automatically by gengenrtl from rtl.def.  */\n");
 298 }
 299
 300 /* Generate the text of the header file we make, genrtl.h.  */
 301
 302 static void
 303 genheader ()
 304 {
 305   int i;
 306   const char **fmt;
 307
 308   puts ("#ifndef GCC_GENRTL_H");
 309   puts ("#define GCC_GENRTL_H\n");
 310
 311   for (fmt = formats; *fmt; ++fmt)
 312     gendecl (*fmt);
 313
 314   putchar ('\n');
 315
 316   for (i = 0; i < NUM_RTX_CODE; i++)
 317     if (! special_format (defs[i].format))
 318       genmacro (i);
 319
 320   puts ("\n#endif /* GCC_GENRTL_H */");
 321 }
 322
 323 /* Generate the text of the code file we write, genrtl.c.  */
 324
 325 static void
 326 gencode ()
 327 {
 328   const char **fmt;
 329
 330   puts ("#include \"config.h\"");
 331   puts ("#include \"system.h\"");
 332   puts ("#include \"obstack.h\"");
 333   puts ("#include \"rtl.h\"");
 334   puts ("#include \"ggc.h\"\n");
 335   puts ("extern struct obstack *rtl_obstack;\n");
 336   puts ("#define obstack_alloc_rtx(n)                                   \\");
 337   puts ("    ((rtx) obstack_alloc (rtl_obstack,                         \\");
 338   puts ("                         sizeof (struct rtx_def)               \\");
 339   puts ("                         + ((n) - 1) * sizeof (rtunion)))\n");
 340
 341   for (fmt = formats; *fmt != 0; fmt++)
 342     gendef (*fmt);
 343 }
 344
 345 /* This is the main program.  We accept only one argument, "-h", which
 346    says we are writing the genrtl.h file.  Otherwise we are writing the
 347    genrtl.c file.  */
 348 extern int main PARAMS ((int, char **));
 349
 350 int
 351 main (argc, argv)
 352      int argc;
 353      char **argv;
 354 {
 355   find_formats ();
 356   genlegend ();
 357
 358   if (argc == 2 && argv[1][0] == '-' && argv[1][1] == 'h')
 359     genheader ();
 360   else
 361     gencode ();
 362
 363   if (ferror (stdout) || fflush (stdout) || fclose (stdout))
 364     return FATAL_EXIT_CODE;
 365
 366   return SUCCESS_EXIT_CODE;
 367 }