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