gcc/gengenrtl.c

   1 /* Generate code to allocate RTL structures.
   2    Copyright (C) 1997-2015 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 3, 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 COPYING3.  If not see
  18 <http://www.gnu.org/licenses/>.  */
  19
  20
  21 #include "bconfig.h"
  22 #include "system.h"
  23
  24 struct rtx_definition
  25 {
  26   const char *const enumname, *const name, *const format;
  27 };
  28
  29 /* rtl.def needs CONST_DOUBLE_FORMAT, but we don't care what
  30    CONST_DOUBLE_FORMAT is because we're not going to be generating
  31    anything for CONST_DOUBLE anyway.  */
  32 #define CONST_DOUBLE_FORMAT ""
  33
  34 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) { #ENUM, NAME, FORMAT },
  35
  36 static const struct rtx_definition defs[] =
  37 {
  38 #include "rtl.def"              /* rtl expressions are documented here */
  39 };
  40 #define NUM_RTX_CODE ARRAY_SIZE (defs)
  41
  42 static const char *formats[NUM_RTX_CODE];
  43 \f
  44 /* Decode a format letter into a C type string.  */
  45
  46 static const char *
  47 type_from_format (int c)
  48 {
  49   switch (c)
  50     {
  51     case 'i':
  52       return "int ";
  53
  54     case 'w':
  55       return "HOST_WIDE_INT ";
  56
  57     case 's':
  58       return "const char *";
  59
  60     case 'e':  case 'u':
  61       return "rtx ";
  62
  63     case 'E':
  64       return "rtvec ";
  65     case 't':
  66       return "tree ";
  67     case 'B':
  68       return "basic_block ";
  69     default:
  70       gcc_unreachable ();
  71     }
  72 }
  73
  74 /* Decode a format letter into the proper accessor function.  */
  75
  76 static const char *
  77 accessor_from_format (int c)
  78 {
  79   switch (c)
  80     {
  81     case 'i':
  82       return "XINT";
  83
  84     case 'w':
  85       return "XWINT";
  86
  87     case 's':
  88       return "XSTR";
  89
  90     case 'e':  case 'u':
  91       return "XEXP";
  92
  93     case 'E':
  94       return "XVEC";
  95
  96     case 't':
  97       return "XTREE";
  98
  99     case 'B':
 100       return "XBBDEF";
 101
 102     default:
 103       gcc_unreachable ();
 104     }
 105 }
 106
 107 /* Return nonzero if we should ignore FMT, an RTL format, when making
 108    the list of formats we write routines to create.  */
 109
 110 static int
 111 special_format (const char *fmt)
 112 {
 113   return (strchr (fmt, '*') != 0
 114           || strchr (fmt, 'V') != 0
 115           || strchr (fmt, 'S') != 0
 116           || strchr (fmt, 'n') != 0);
 117 }
 118
 119 /* Return true if CODE always has VOIDmode.  */
 120
 121 static inline bool
 122 always_void_p (int idx)
 123 {
 124   return strcmp (defs[idx].enumname, "SET") == 0;
 125 }
 126
 127 /* Return nonzero if the RTL code given by index IDX is one that we should
 128    generate a gen_rtx_raw_FOO macro for, not gen_rtx_FOO (because gen_rtx_FOO
 129    is a wrapper in emit-rtl.c).  */
 130
 131 static int
 132 special_rtx (int idx)
 133 {
 134   return (strcmp (defs[idx].enumname, "EXPR_LIST") == 0
 135           || strcmp (defs[idx].enumname, "INSN_LIST") == 0
 136           || strcmp (defs[idx].enumname, "INSN") == 0
 137           || strcmp (defs[idx].enumname, "CONST_INT") == 0
 138           || strcmp (defs[idx].enumname, "REG") == 0
 139           || strcmp (defs[idx].enumname, "SUBREG") == 0
 140           || strcmp (defs[idx].enumname, "MEM") == 0
 141           || strcmp (defs[idx].enumname, "PC") == 0
 142           || strcmp (defs[idx].enumname, "CC0") == 0
 143           || strcmp (defs[idx].enumname, "RETURN") == 0
 144           || strcmp (defs[idx].enumname, "SIMPLE_RETURN") == 0
 145           || strcmp (defs[idx].enumname, "CONST_VECTOR") == 0);
 146 }
 147
 148 /* Return nonzero if the RTL code given by index IDX is one that we should
 149    generate no macro for at all (because gen_rtx_FOO is never used or
 150    cannot have the obvious interface).  */
 151
 152 static int
 153 excluded_rtx (int idx)
 154 {
 155   return (strcmp (defs[idx].enumname, "VAR_LOCATION") == 0
 156           || strcmp (defs[idx].enumname, "CONST_DOUBLE") == 0
 157           || strcmp (defs[idx].enumname, "CONST_WIDE_INT") == 0
 158           || strcmp (defs[idx].enumname, "CONST_FIXED") == 0);
 159 }
 160
 161 /* Place a list of all format specifiers we use into the array FORMAT.  */
 162
 163 static void
 164 find_formats (void)
 165 {
 166   unsigned 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
 185 /* Generate macros to generate RTL of code IDX using the functions we
 186    write.  */
 187
 188 static void
 189 genmacro (int idx)
 190 {
 191   const char *p;
 192   const char *sep = "";
 193   int i;
 194
 195   /* We write a macro that defines gen_rtx_RTLCODE to be an equivalent to
 196      gen_rtx_fmt_FORMAT where FORMAT is the RTX_FORMAT of RTLCODE.  */
 197
 198   if (excluded_rtx (idx))
 199     /* Don't define a macro for this code.  */
 200     return;
 201
 202   bool has_mode_p = !always_void_p (idx);
 203   printf ("#define gen_rtx_%s%s(",
 204            special_rtx (idx) ? "raw_" : "", defs[idx].enumname);
 205   if (has_mode_p)
 206     {
 207       printf ("MODE");
 208       sep = ", ";
 209     }
 210
 211   for (p = defs[idx].format, i = 0; *p != 0; p++)
 212     if (*p != '0')
 213       {
 214         printf ("%sARG%d", sep, i++);
 215         sep = ", ";
 216       }
 217
 218   printf (") \\\n  gen_rtx_fmt_%s (%s, %s",
 219           defs[idx].format, defs[idx].enumname,
 220           has_mode_p ? "(MODE)" : "VOIDmode");
 221
 222   for (p = defs[idx].format, i = 0; *p != 0; p++)
 223     if (*p != '0')
 224       printf (", (ARG%d)", i++);
 225
 226   puts (")");
 227 }
 228
 229 /* Generate the code for the function to generate RTL whose
 230    format is FORMAT.  */
 231
 232 static void
 233 gendef (const char *format)
 234 {
 235   const char *p;
 236   int i, j;
 237
 238   /* Start by writing the definition of the function name and the types
 239      of the arguments.  */
 240
 241   printf ("static inline rtx\ngen_rtx_fmt_%s_stat (RTX_CODE code, machine_mode mode", format);
 242   for (p = format, i = 0; *p != 0; p++)
 243     if (*p != '0')
 244       printf (",\n\t%sarg%d", type_from_format (*p), i++);
 245
 246   puts (" MEM_STAT_DECL)");
 247
 248   /* Now write out the body of the function itself, which allocates
 249      the memory and initializes it.  */
 250   puts ("{");
 251   puts ("  rtx rt;");
 252   puts ("  rt = rtx_alloc_stat (code PASS_MEM_STAT);\n");
 253
 254   puts ("  PUT_MODE (rt, mode);");
 255
 256   for (p = format, i = j = 0; *p ; ++p, ++i)
 257     if (*p != '0')
 258       printf ("  %s (rt, %d) = arg%d;\n", accessor_from_format (*p), i, j++);
 259     else
 260       printf ("  X0EXP (rt, %d) = NULL_RTX;\n", i);
 261
 262   puts ("\n  return rt;\n}\n");
 263   printf ("#define gen_rtx_fmt_%s(c, m", format);
 264   for (p = format, i = 0; *p != 0; p++)
 265     if (*p != '0')
 266       printf (", p%i",i++);
 267   printf (")\\\n        gen_rtx_fmt_%s_stat (c, m", format);
 268   for (p = format, i = 0; *p != 0; p++)
 269     if (*p != '0')
 270       printf (", p%i",i++);
 271   printf (" MEM_STAT_INFO)\n\n");
 272 }
 273
 274 /* Generate the documentation header for files we write.  */
 275
 276 static void
 277 genlegend (void)
 278 {
 279   puts ("/* Generated automatically by gengenrtl from rtl.def.  */\n");
 280 }
 281
 282 /* Generate the text of the header file we make, genrtl.h.  */
 283
 284 static void
 285 genheader (void)
 286 {
 287   unsigned int i;
 288   const char **fmt;
 289
 290   puts ("#ifndef GCC_GENRTL_H");
 291   puts ("#define GCC_GENRTL_H\n");
 292   puts ("#include \"statistics.h\"\n");
 293
 294   for (fmt = formats; *fmt; ++fmt)
 295     gendef (*fmt);
 296
 297   putchar ('\n');
 298
 299   for (i = 0; i < NUM_RTX_CODE; i++)
 300     if (! special_format (defs[i].format))
 301       genmacro (i);
 302
 303   puts ("\n#endif /* GCC_GENRTL_H */");
 304 }
 305
 306 /* This is the main program.  */
 307
 308 int
 309 main (void)
 310 {
 311   find_formats ();
 312   genlegend ();
 313
 314   genheader ();
 315
 316   if (ferror (stdout) || fflush (stdout) || fclose (stdout))
 317     return FATAL_EXIT_CODE;
 318
 319   return SUCCESS_EXIT_CODE;
 320 }