1/* Generate code to allocate RTL structures.
2   Copyright (C) 1997-2015 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along 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
24struct 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
36static 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
42static const char *formats[NUM_RTX_CODE];
43
44/* Decode a format letter into a C type string.  */
45
46static const char *
47type_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
76static const char *
77accessor_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
110static int
111special_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 nonzero if the RTL code given by index IDX is one that we should
120   generate a gen_rtx_raw_FOO macro for, not gen_rtx_FOO (because gen_rtx_FOO
121   is a wrapper in emit-rtl.c).  */
122
123static int
124special_rtx (int idx)
125{
126  return (strcmp (defs[idx].enumname, "EXPR_LIST") == 0
127	  || strcmp (defs[idx].enumname, "INSN_LIST") == 0
128	  || strcmp (defs[idx].enumname, "INSN") == 0
129	  || strcmp (defs[idx].enumname, "CONST_INT") == 0
130	  || strcmp (defs[idx].enumname, "REG") == 0
131	  || strcmp (defs[idx].enumname, "SUBREG") == 0
132	  || strcmp (defs[idx].enumname, "MEM") == 0
133	  || strcmp (defs[idx].enumname, "PC") == 0
134	  || strcmp (defs[idx].enumname, "CC0") == 0
135	  || strcmp (defs[idx].enumname, "RETURN") == 0
136	  || strcmp (defs[idx].enumname, "SIMPLE_RETURN") == 0
137	  || strcmp (defs[idx].enumname, "CONST_VECTOR") == 0);
138}
139
140/* Return nonzero if the RTL code given by index IDX is one that we should
141   generate no macro for at all (because gen_rtx_FOO is never used or
142   cannot have the obvious interface).  */
143
144static int
145excluded_rtx (int idx)
146{
147  return (strcmp (defs[idx].enumname, "VAR_LOCATION") == 0
148	  || strcmp (defs[idx].enumname, "CONST_DOUBLE") == 0
149	  || strcmp (defs[idx].enumname, "CONST_WIDE_INT") == 0
150	  || strcmp (defs[idx].enumname, "CONST_FIXED") == 0);
151}
152
153/* Place a list of all format specifiers we use into the array FORMAT.  */
154
155static void
156find_formats (void)
157{
158  unsigned int i;
159
160  for (i = 0; i < NUM_RTX_CODE; i++)
161    {
162      const char **f;
163
164      if (special_format (defs[i].format))
165	continue;
166
167      for (f = formats; *f; f++)
168	if (! strcmp (*f, defs[i].format))
169	  break;
170
171      if (*f == 0)
172	*f = defs[i].format;
173    }
174}
175
176
177/* Generate macros to generate RTL of code IDX using the functions we
178   write.  */
179
180static void
181genmacro (int idx)
182{
183  const char *p;
184  int i;
185
186  /* We write a macro that defines gen_rtx_RTLCODE to be an equivalent to
187     gen_rtx_fmt_FORMAT where FORMAT is the RTX_FORMAT of RTLCODE.  */
188
189  if (excluded_rtx (idx))
190    /* Don't define a macro for this code.  */
191    return;
192
193  printf ("#define gen_rtx_%s%s(MODE",
194	   special_rtx (idx) ? "raw_" : "", defs[idx].enumname);
195
196  for (p = defs[idx].format, i = 0; *p != 0; p++)
197    if (*p != '0')
198      printf (", ARG%d", i++);
199
200  printf (") \\\n  gen_rtx_fmt_%s (%s, (MODE)",
201	  defs[idx].format, defs[idx].enumname);
202
203  for (p = defs[idx].format, i = 0; *p != 0; p++)
204    if (*p != '0')
205      printf (", (ARG%d)", i++);
206
207  puts (")");
208}
209
210/* Generate the code for the function to generate RTL whose
211   format is FORMAT.  */
212
213static void
214gendef (const char *format)
215{
216  const char *p;
217  int i, j;
218
219  /* Start by writing the definition of the function name and the types
220     of the arguments.  */
221
222  printf ("static inline rtx\ngen_rtx_fmt_%s_stat (RTX_CODE code, machine_mode mode", format);
223  for (p = format, i = 0; *p != 0; p++)
224    if (*p != '0')
225      printf (",\n\t%sarg%d", type_from_format (*p), i++);
226
227  puts (" MEM_STAT_DECL)");
228
229  /* Now write out the body of the function itself, which allocates
230     the memory and initializes it.  */
231  puts ("{");
232  puts ("  rtx rt;");
233  puts ("  rt = rtx_alloc_stat (code PASS_MEM_STAT);\n");
234
235  puts ("  PUT_MODE (rt, mode);");
236
237  for (p = format, i = j = 0; *p ; ++p, ++i)
238    if (*p != '0')
239      printf ("  %s (rt, %d) = arg%d;\n", accessor_from_format (*p), i, j++);
240    else
241      printf ("  X0EXP (rt, %d) = NULL_RTX;\n", i);
242
243  puts ("\n  return rt;\n}\n");
244  printf ("#define gen_rtx_fmt_%s(c, m", format);
245  for (p = format, i = 0; *p != 0; p++)
246    if (*p != '0')
247      printf (", p%i",i++);
248  printf (")\\\n        gen_rtx_fmt_%s_stat (c, m", format);
249  for (p = format, i = 0; *p != 0; p++)
250    if (*p != '0')
251      printf (", p%i",i++);
252  printf (" MEM_STAT_INFO)\n\n");
253}
254
255/* Generate the documentation header for files we write.  */
256
257static void
258genlegend (void)
259{
260  puts ("/* Generated automatically by gengenrtl from rtl.def.  */\n");
261}
262
263/* Generate the text of the header file we make, genrtl.h.  */
264
265static void
266genheader (void)
267{
268  unsigned int i;
269  const char **fmt;
270
271  puts ("#ifndef GCC_GENRTL_H");
272  puts ("#define GCC_GENRTL_H\n");
273  puts ("#include \"statistics.h\"\n");
274
275  for (fmt = formats; *fmt; ++fmt)
276    gendef (*fmt);
277
278  putchar ('\n');
279
280  for (i = 0; i < NUM_RTX_CODE; i++)
281    if (! special_format (defs[i].format))
282      genmacro (i);
283
284  puts ("\n#endif /* GCC_GENRTL_H */");
285}
286
287/* This is the main program.  */
288
289int
290main (void)
291{
292  find_formats ();
293  genlegend ();
294
295  genheader ();
296
297  if (ferror (stdout) || fflush (stdout) || fclose (stdout))
298    return FATAL_EXIT_CODE;
299
300  return SUCCESS_EXIT_CODE;
301}
302