PR 48915 Update mixed-language programming documentation
[official-gcc.git] / gcc / gengenrtl.c
bloba61995876baf22c5845009cf979e782b4ee8028b
1 /* Generate code to allocate RTL structures.
2 Copyright (C) 1997, 1998, 1999, 2000, 2002, 2003, 2004, 2007, 2010
3 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
10 version.
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
22 #include "bconfig.h"
23 #include "system.h"
25 struct rtx_definition
27 const char *const enumname, *const name, *const format;
30 /* rtl.def needs CONST_DOUBLE_FORMAT, but we don't care what
31 CONST_DOUBLE_FORMAT is because we're not going to be generating
32 anything for CONST_DOUBLE anyway. */
33 #define CONST_DOUBLE_FORMAT ""
35 #define DEF_RTL_EXPR(ENUM, NAME, FORMAT, CLASS) { #ENUM, NAME, FORMAT },
37 static const struct rtx_definition defs[] =
39 #include "rtl.def" /* rtl expressions are documented here */
41 #define NUM_RTX_CODE ARRAY_SIZE(defs)
43 static const char *formats[NUM_RTX_CODE];
45 /* Decode a format letter into a C type string. */
47 static const char *
48 type_from_format (int c)
50 switch (c)
52 case 'i':
53 return "int ";
55 case 'w':
56 return "HOST_WIDE_INT ";
58 case 's':
59 return "const char *";
61 case 'e': case 'u':
62 return "rtx ";
64 case 'E':
65 return "rtvec ";
66 case 't':
67 return "union tree_node *"; /* tree - typedef not available */
68 case 'B':
69 return "struct basic_block_def *"; /* basic block - typedef not available */
70 default:
71 gcc_unreachable ();
75 /* Decode a format letter into the proper accessor function. */
77 static const char *
78 accessor_from_format (int c)
80 switch (c)
82 case 'i':
83 return "XINT";
85 case 'w':
86 return "XWINT";
88 case 's':
89 return "XSTR";
91 case 'e': case 'u':
92 return "XEXP";
94 case 'E':
95 return "XVEC";
97 case 't':
98 return "XTREE";
100 case 'B':
101 return "XBBDEF";
103 default:
104 gcc_unreachable ();
108 /* Return nonzero if we should ignore FMT, an RTL format, when making
109 the list of formats we write routines to create. */
111 static int
112 special_format (const char *fmt)
114 return (strchr (fmt, '*') != 0
115 || strchr (fmt, 'V') != 0
116 || strchr (fmt, 'S') != 0
117 || strchr (fmt, 'n') != 0);
120 /* Return nonzero if the RTL code given by index IDX is one that we should
121 generate a gen_rtx_raw_FOO macro for, not gen_rtx_FOO (because gen_rtx_FOO
122 is a wrapper in emit-rtl.c). */
124 static int
125 special_rtx (int idx)
127 return (strcmp (defs[idx].enumname, "CONST_INT") == 0
128 || strcmp (defs[idx].enumname, "REG") == 0
129 || strcmp (defs[idx].enumname, "SUBREG") == 0
130 || strcmp (defs[idx].enumname, "MEM") == 0
131 || strcmp (defs[idx].enumname, "PC") == 0
132 || strcmp (defs[idx].enumname, "CC0") == 0
133 || strcmp (defs[idx].enumname, "RETURN") == 0
134 || strcmp (defs[idx].enumname, "CONST_VECTOR") == 0);
137 /* Return nonzero if the RTL code given by index IDX is one that we should
138 generate no macro for at all (because gen_rtx_FOO is never used or
139 cannot have the obvious interface). */
141 static int
142 excluded_rtx (int idx)
144 return ((strcmp (defs[idx].enumname, "CONST_DOUBLE") == 0)
145 || (strcmp (defs[idx].enumname, "CONST_FIXED") == 0));
148 /* Place a list of all format specifiers we use into the array FORMAT. */
150 static void
151 find_formats (void)
153 unsigned int i;
155 for (i = 0; i < NUM_RTX_CODE; i++)
157 const char **f;
159 if (special_format (defs[i].format))
160 continue;
162 for (f = formats; *f; f++)
163 if (! strcmp (*f, defs[i].format))
164 break;
166 if (*f == 0)
167 *f = defs[i].format;
172 /* Generate macros to generate RTL of code IDX using the functions we
173 write. */
175 static void
176 genmacro (int idx)
178 const char *p;
179 int i;
181 /* We write a macro that defines gen_rtx_RTLCODE to be an equivalent to
182 gen_rtx_fmt_FORMAT where FORMAT is the RTX_FORMAT of RTLCODE. */
184 if (excluded_rtx (idx))
185 /* Don't define a macro for this code. */
186 return;
188 printf ("#define gen_rtx_%s%s(MODE",
189 special_rtx (idx) ? "raw_" : "", defs[idx].enumname);
191 for (p = defs[idx].format, i = 0; *p != 0; p++)
192 if (*p != '0')
193 printf (", ARG%d", i++);
195 printf (") \\\n gen_rtx_fmt_%s (%s, (MODE)",
196 defs[idx].format, defs[idx].enumname);
198 for (p = defs[idx].format, i = 0; *p != 0; p++)
199 if (*p != '0')
200 printf (", (ARG%d)", i++);
202 puts (")");
205 /* Generate the code for the function to generate RTL whose
206 format is FORMAT. */
208 static void
209 gendef (const char *format)
211 const char *p;
212 int i, j;
214 /* Start by writing the definition of the function name and the types
215 of the arguments. */
217 printf ("static inline rtx\ngen_rtx_fmt_%s_stat (RTX_CODE code, enum machine_mode mode", format);
218 for (p = format, i = 0; *p != 0; p++)
219 if (*p != '0')
220 printf (",\n\t%sarg%d", type_from_format (*p), i++);
222 puts (" MEM_STAT_DECL)");
224 /* Now write out the body of the function itself, which allocates
225 the memory and initializes it. */
226 puts ("{");
227 puts (" rtx rt;");
228 puts (" rt = rtx_alloc_stat (code PASS_MEM_STAT);\n");
230 puts (" PUT_MODE (rt, mode);");
232 for (p = format, i = j = 0; *p ; ++p, ++i)
233 if (*p != '0')
234 printf (" %s (rt, %d) = arg%d;\n", accessor_from_format (*p), i, j++);
235 else
236 printf (" X0EXP (rt, %d) = NULL_RTX;\n", i);
238 puts ("\n return rt;\n}\n");
239 printf ("#define gen_rtx_fmt_%s(c, m", format);
240 for (p = format, i = 0; *p != 0; p++)
241 if (*p != '0')
242 printf (", p%i",i++);
243 printf (")\\\n gen_rtx_fmt_%s_stat (c, m", format);
244 for (p = format, i = 0; *p != 0; p++)
245 if (*p != '0')
246 printf (", p%i",i++);
247 printf (" MEM_STAT_INFO)\n\n");
250 /* Generate the documentation header for files we write. */
252 static void
253 genlegend (void)
255 puts ("/* Generated automatically by gengenrtl from rtl.def. */\n");
258 /* Generate the text of the header file we make, genrtl.h. */
260 static void
261 genheader (void)
263 unsigned int i;
264 const char **fmt;
266 puts ("#ifndef GCC_GENRTL_H");
267 puts ("#define GCC_GENRTL_H\n");
268 puts ("#include \"statistics.h\"\n");
270 for (fmt = formats; *fmt; ++fmt)
271 gendef (*fmt);
273 putchar ('\n');
275 for (i = 0; i < NUM_RTX_CODE; i++)
276 if (! special_format (defs[i].format))
277 genmacro (i);
279 puts ("\n#endif /* GCC_GENRTL_H */");
282 /* This is the main program. */
285 main (void)
287 find_formats ();
288 genlegend ();
290 genheader ();
292 if (ferror (stdout) || fflush (stdout) || fclose (stdout))
293 return FATAL_EXIT_CODE;
295 return SUCCESS_EXIT_CODE;