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