2002-08-22 Paolo Carlini <pcarlini@unitus.it>
[official-gcc.git] / gcc / read-rtl.c
blob8c378d96abb53e89ee64a149858dcc81ef1b9b93
1 /* RTL reader for GNU C Compiler.
2 Copyright (C) 1987, 1988, 1991, 1994, 1997, 1998, 1999, 2000, 2001, 2002
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 2, 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 COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA. */
22 #include "hconfig.h"
23 #include "system.h"
24 #include "rtl.h"
25 #include "obstack.h"
26 #include "hashtab.h"
28 static htab_t md_constants;
30 static void fatal_with_file_and_line PARAMS ((FILE *, const char *, ...))
31 ATTRIBUTE_PRINTF_2 ATTRIBUTE_NORETURN;
32 static void fatal_expected_char PARAMS ((FILE *, int, int)) ATTRIBUTE_NORETURN;
33 static void read_name PARAMS ((char *, FILE *));
34 static char *read_string PARAMS ((struct obstack *, FILE *, int));
35 static char *read_quoted_string PARAMS ((struct obstack *, FILE *));
36 static char *read_braced_string PARAMS ((struct obstack *, FILE *));
37 static void read_escape PARAMS ((struct obstack *, FILE *));
38 static unsigned def_hash PARAMS ((const void *));
39 static int def_name_eq_p PARAMS ((const void *, const void *));
40 static void read_constants PARAMS ((FILE *infile, char *tmp_char));
41 static void validate_const_int PARAMS ((FILE *, const char *));
43 /* Subroutines of read_rtx. */
45 /* The current line number for the file. */
46 int read_rtx_lineno = 1;
48 /* The filename for aborting with file and line. */
49 const char *read_rtx_filename = "<unknown>";
51 static void
52 fatal_with_file_and_line VPARAMS ((FILE *infile, const char *msg, ...))
54 char context[64];
55 size_t i;
56 int c;
58 VA_OPEN (ap, msg);
59 VA_FIXEDARG (ap, FILE *, infile);
60 VA_FIXEDARG (ap, const char *, msg);
62 fprintf (stderr, "%s:%d: ", read_rtx_filename, read_rtx_lineno);
63 vfprintf (stderr, msg, ap);
64 putc ('\n', stderr);
66 /* Gather some following context. */
67 for (i = 0; i < sizeof (context)-1; ++i)
69 c = getc (infile);
70 if (c == EOF)
71 break;
72 if (c == '\r' || c == '\n')
73 break;
74 context[i] = c;
76 context[i] = '\0';
78 fprintf (stderr, "%s:%d: following context is `%s'\n",
79 read_rtx_filename, read_rtx_lineno, context);
81 VA_CLOSE (ap);
82 exit (1);
85 /* Dump code after printing a message. Used when read_rtx finds
86 invalid data. */
88 static void
89 fatal_expected_char (infile, expected_c, actual_c)
90 FILE *infile;
91 int expected_c, actual_c;
93 fatal_with_file_and_line (infile, "expected character `%c', found `%c'",
94 expected_c, actual_c);
97 /* Read chars from INFILE until a non-whitespace char
98 and return that. Comments, both Lisp style and C style,
99 are treated as whitespace.
100 Tools such as genflags use this function. */
103 read_skip_spaces (infile)
104 FILE *infile;
106 int c;
108 while (1)
110 c = getc (infile);
111 switch (c)
113 case '\n':
114 read_rtx_lineno++;
115 break;
117 case ' ': case '\t': case '\f': case '\r':
118 break;
120 case ';':
122 c = getc (infile);
123 while (c != '\n' && c != EOF);
124 read_rtx_lineno++;
125 break;
127 case '/':
129 int prevc;
130 c = getc (infile);
131 if (c != '*')
132 fatal_expected_char (infile, '*', c);
134 prevc = 0;
135 while ((c = getc (infile)) && c != EOF)
137 if (c == '\n')
138 read_rtx_lineno++;
139 else if (prevc == '*' && c == '/')
140 break;
141 prevc = c;
144 break;
146 default:
147 return c;
152 /* Read an rtx code name into the buffer STR[].
153 It is terminated by any of the punctuation chars of rtx printed syntax. */
155 static void
156 read_name (str, infile)
157 char *str;
158 FILE *infile;
160 char *p;
161 int c;
163 c = read_skip_spaces (infile);
165 p = str;
166 while (1)
168 if (c == ' ' || c == '\n' || c == '\t' || c == '\f' || c == '\r')
169 break;
170 if (c == ':' || c == ')' || c == ']' || c == '"' || c == '/'
171 || c == '(' || c == '[')
173 ungetc (c, infile);
174 break;
176 *p++ = c;
177 c = getc (infile);
179 if (p == str)
180 fatal_with_file_and_line (infile, "missing name or number");
181 if (c == '\n')
182 read_rtx_lineno++;
184 *p = 0;
186 if (md_constants)
188 /* Do constant expansion. */
189 struct md_constant *def;
191 p = str;
194 struct md_constant tmp_def;
196 tmp_def.name = p;
197 def = htab_find (md_constants, &tmp_def);
198 if (def)
199 p = def->value;
200 } while (def);
201 if (p != str)
202 strcpy (str, p);
206 /* Subroutine of the string readers. Handles backslash escapes.
207 Caller has read the backslash, but not placed it into the obstack. */
208 static void
209 read_escape (ob, infile)
210 struct obstack *ob;
211 FILE *infile;
213 int c = getc (infile);
215 switch (c)
217 /* Backslash-newline is replaced by nothing, as in C. */
218 case '\n':
219 read_rtx_lineno++;
220 return;
222 /* \" \' \\ are replaced by the second character. */
223 case '\\':
224 case '"':
225 case '\'':
226 break;
228 /* Standard C string escapes:
229 \a \b \f \n \r \t \v
230 \[0-7] \x
231 all are passed through to the output string unmolested.
232 In normal use these wind up in a string constant processed
233 by the C compiler, which will translate them appropriately.
234 We do not bother checking that \[0-7] are followed by up to
235 two octal digits, or that \x is followed by N hex digits.
236 \? \u \U are left out because they are not in traditional C. */
237 case 'a': case 'b': case 'f': case 'n': case 'r': case 't': case 'v':
238 case '0': case '1': case '2': case '3': case '4': case '5': case '6':
239 case '7': case 'x':
240 obstack_1grow (ob, '\\');
241 break;
243 /* \; makes stuff for a C string constant containing
244 newline and tab. */
245 case ';':
246 obstack_grow (ob, "\\n\\t", 4);
247 return;
249 /* pass anything else through, but issue a warning. */
250 default:
251 fprintf (stderr, "%s:%d: warning: unrecognized escape \\%c\n",
252 read_rtx_filename, read_rtx_lineno, c);
253 obstack_1grow (ob, '\\');
254 break;
257 obstack_1grow (ob, c);
261 /* Read a double-quoted string onto the obstack. Caller has scanned
262 the leading quote. */
263 static char *
264 read_quoted_string (ob, infile)
265 struct obstack *ob;
266 FILE *infile;
268 int c;
270 while (1)
272 c = getc (infile); /* Read the string */
273 if (c == '\n')
274 read_rtx_lineno++;
275 else if (c == '\\')
277 read_escape (ob, infile);
278 continue;
280 else if (c == '"')
281 break;
283 obstack_1grow (ob, c);
286 obstack_1grow (ob, 0);
287 return obstack_finish (ob);
290 /* Read a braced string (a la Tcl) onto the obstack. Caller has
291 scanned the leading brace. Note that unlike quoted strings,
292 the outermost braces _are_ included in the string constant. */
293 static char *
294 read_braced_string (ob, infile)
295 struct obstack *ob;
296 FILE *infile;
298 int c;
299 int brace_depth = 1; /* caller-processed */
301 obstack_1grow (ob, '{');
302 while (brace_depth)
304 c = getc (infile); /* Read the string */
305 if (c == '\n')
306 read_rtx_lineno++;
307 else if (c == '{')
308 brace_depth++;
309 else if (c == '}')
310 brace_depth--;
311 else if (c == '\\')
313 read_escape (ob, infile);
314 continue;
317 obstack_1grow (ob, c);
320 obstack_1grow (ob, 0);
321 return obstack_finish (ob);
324 /* Read some kind of string constant. This is the high-level routine
325 used by read_rtx. It handles surrounding parentheses, leading star,
326 and dispatch to the appropriate string constant reader. */
328 static char *
329 read_string (ob, infile, star_if_braced)
330 struct obstack *ob;
331 FILE *infile;
332 int star_if_braced;
334 char *stringbuf;
335 int saw_paren = 0;
336 int c;
338 c = read_skip_spaces (infile);
339 if (c == '(')
341 saw_paren = 1;
342 c = read_skip_spaces (infile);
345 if (c == '"')
346 stringbuf = read_quoted_string (ob, infile);
347 else if (c == '{')
349 if (star_if_braced)
350 obstack_1grow (ob, '*');
351 stringbuf = read_braced_string (ob, infile);
353 else
354 fatal_with_file_and_line (infile, "expected `\"' or `{', found `%c'", c);
356 if (saw_paren)
358 c = read_skip_spaces (infile);
359 if (c != ')')
360 fatal_expected_char (infile, ')', c);
363 return stringbuf;
366 /* Provide a version of a function to read a long long if the system does
367 not provide one. */
368 #if HOST_BITS_PER_WIDE_INT > HOST_BITS_PER_LONG && !defined(HAVE_ATOLL) && !defined(HAVE_ATOQ)
369 HOST_WIDE_INT
370 atoll (p)
371 const char *p;
373 int neg = 0;
374 HOST_WIDE_INT tmp_wide;
376 while (ISSPACE (*p))
377 p++;
378 if (*p == '-')
379 neg = 1, p++;
380 else if (*p == '+')
381 p++;
383 tmp_wide = 0;
384 while (ISDIGIT (*p))
386 HOST_WIDE_INT new_wide = tmp_wide*10 + (*p - '0');
387 if (new_wide < tmp_wide)
389 /* Return INT_MAX equiv on overflow. */
390 tmp_wide = (~(unsigned HOST_WIDE_INT) 0) >> 1;
391 break;
393 tmp_wide = new_wide;
394 p++;
397 if (neg)
398 tmp_wide = -tmp_wide;
399 return tmp_wide;
401 #endif
403 /* Given a constant definition, return a hash code for its name. */
404 static unsigned
405 def_hash (def)
406 const void *def;
408 unsigned result, i;
409 const char *string = ((const struct md_constant *) def)->name;
411 for (result = i = 0;*string++ != '\0'; i++)
412 result += ((unsigned char) *string << (i % CHAR_BIT));
413 return result;
416 /* Given two constant definitions, return true if they have the same name. */
417 static int
418 def_name_eq_p (def1, def2)
419 const void *def1, *def2;
421 return ! strcmp (((const struct md_constant *) def1)->name,
422 ((const struct md_constant *) def2)->name);
425 /* INFILE is a FILE pointer to read text from. TMP_CHAR is a buffer suitable
426 to read a name or number into. Process a define_constants directive,
427 starting with the optional space after the "define_constants". */
428 static void
429 read_constants (infile, tmp_char)
430 FILE *infile;
431 char *tmp_char;
433 int c;
434 htab_t defs;
436 c = read_skip_spaces (infile);
437 if (c != '[')
438 fatal_expected_char (infile, '[', c);
439 defs = md_constants;
440 if (! defs)
441 defs = htab_create (32, def_hash, def_name_eq_p, (htab_del) 0);
442 /* Disable constant expansion during definition processing. */
443 md_constants = 0;
444 while ( (c = read_skip_spaces (infile)) != ']')
446 struct md_constant *def;
447 void **entry_ptr;
449 if (c != '(')
450 fatal_expected_char (infile, '(', c);
451 def = xmalloc (sizeof (struct md_constant));
452 def->name = tmp_char;
453 read_name (tmp_char, infile);
454 entry_ptr = htab_find_slot (defs, def, TRUE);
455 if (! *entry_ptr)
456 def->name = xstrdup (tmp_char);
457 c = read_skip_spaces (infile);
458 ungetc (c, infile);
459 read_name (tmp_char, infile);
460 if (! *entry_ptr)
462 def->value = xstrdup (tmp_char);
463 *entry_ptr = def;
465 else
467 def = *entry_ptr;
468 if (strcmp (def->value, tmp_char))
469 fatal_with_file_and_line (infile,
470 "redefinition of %s, was %s, now %s",
471 def->name, def->value, tmp_char);
473 c = read_skip_spaces (infile);
474 if (c != ')')
475 fatal_expected_char (infile, ')', c);
477 md_constants = defs;
478 c = read_skip_spaces (infile);
479 if (c != ')')
480 fatal_expected_char (infile, ')', c);
483 /* For every constant definition, call CALLBACK with two arguments:
484 a pointer a pointer to the constant definition and INFO.
485 Stops when CALLBACK returns zero. */
486 void
487 traverse_md_constants (callback, info)
488 htab_trav callback;
489 void *info;
491 if (md_constants)
492 htab_traverse (md_constants, callback, info);
495 static void
496 validate_const_int (infile, string)
497 FILE *infile;
498 const char *string;
500 const char *cp;
501 int valid = 1;
503 cp = string;
504 while (*cp && ISSPACE (*cp))
505 cp++;
506 if (*cp == '-' || *cp == '+')
507 cp++;
508 if (*cp == 0)
509 valid = 0;
510 for (; *cp; cp++)
511 if (! ISDIGIT (*cp))
512 valid = 0;
513 if (!valid)
514 fatal_with_file_and_line (infile, "invalid decimal constant \"%s\"\n", string);
517 /* Read an rtx in printed representation from INFILE
518 and return an actual rtx in core constructed accordingly.
519 read_rtx is not used in the compiler proper, but rather in
520 the utilities gen*.c that construct C code from machine descriptions. */
523 read_rtx (infile)
524 FILE *infile;
526 int i, j;
527 RTX_CODE tmp_code;
528 const char *format_ptr;
529 /* tmp_char is a buffer used for reading decimal integers
530 and names of rtx types and machine modes.
531 Therefore, 256 must be enough. */
532 char tmp_char[256];
533 rtx return_rtx;
534 int c;
535 int tmp_int;
536 HOST_WIDE_INT tmp_wide;
538 /* Obstack used for allocating RTL objects. */
539 static struct obstack rtl_obstack;
540 static int initialized;
542 /* Linked list structure for making RTXs: */
543 struct rtx_list
545 struct rtx_list *next;
546 rtx value; /* Value of this node. */
549 if (!initialized) {
550 obstack_init (&rtl_obstack);
551 initialized = 1;
554 again:
555 c = read_skip_spaces (infile); /* Should be open paren. */
556 if (c != '(')
557 fatal_expected_char (infile, '(', c);
559 read_name (tmp_char, infile);
561 tmp_code = UNKNOWN;
563 if (! strcmp (tmp_char, "define_constants"))
565 read_constants (infile, tmp_char);
566 goto again;
568 for (i = 0; i < NUM_RTX_CODE; i++)
569 if (! strcmp (tmp_char, GET_RTX_NAME (i)))
571 tmp_code = (RTX_CODE) i; /* get value for name */
572 break;
575 if (tmp_code == UNKNOWN)
576 fatal_with_file_and_line (infile, "unknown rtx code `%s'", tmp_char);
578 /* (NIL) stands for an expression that isn't there. */
579 if (tmp_code == NIL)
581 /* Discard the closeparen. */
582 while ((c = getc (infile)) && c != ')')
585 return 0;
588 /* If we end up with an insn expression then we free this space below. */
589 return_rtx = rtx_alloc (tmp_code);
590 format_ptr = GET_RTX_FORMAT (GET_CODE (return_rtx));
592 /* If what follows is `: mode ', read it and
593 store the mode in the rtx. */
595 i = read_skip_spaces (infile);
596 if (i == ':')
598 read_name (tmp_char, infile);
599 for (j = 0; j < NUM_MACHINE_MODES; j++)
600 if (! strcmp (GET_MODE_NAME (j), tmp_char))
601 break;
603 if (j == MAX_MACHINE_MODE)
604 fatal_with_file_and_line (infile, "unknown mode `%s'", tmp_char);
606 PUT_MODE (return_rtx, (enum machine_mode) j);
608 else
609 ungetc (i, infile);
611 for (i = 0; i < GET_RTX_LENGTH (GET_CODE (return_rtx)); i++)
612 switch (*format_ptr++)
614 /* 0 means a field for internal use only.
615 Don't expect it to be present in the input. */
616 case '0':
617 break;
619 case 'e':
620 case 'u':
621 XEXP (return_rtx, i) = read_rtx (infile);
622 break;
624 case 'V':
625 /* 'V' is an optional vector: if a closeparen follows,
626 just store NULL for this element. */
627 c = read_skip_spaces (infile);
628 ungetc (c, infile);
629 if (c == ')')
631 XVEC (return_rtx, i) = 0;
632 break;
634 /* Now process the vector. */
636 case 'E':
638 /* Obstack to store scratch vector in. */
639 struct obstack vector_stack;
640 int list_counter = 0;
641 rtvec return_vec = NULL_RTVEC;
643 c = read_skip_spaces (infile);
644 if (c != '[')
645 fatal_expected_char (infile, '[', c);
647 /* add expressions to a list, while keeping a count */
648 obstack_init (&vector_stack);
649 while ((c = read_skip_spaces (infile)) && c != ']')
651 ungetc (c, infile);
652 list_counter++;
653 obstack_ptr_grow (&vector_stack, (PTR) read_rtx (infile));
655 if (list_counter > 0)
657 return_vec = rtvec_alloc (list_counter);
658 memcpy (&return_vec->elem[0], obstack_finish (&vector_stack),
659 list_counter * sizeof (rtx));
661 XVEC (return_rtx, i) = return_vec;
662 obstack_free (&vector_stack, NULL);
663 /* close bracket gotten */
665 break;
667 case 'S':
668 /* 'S' is an optional string: if a closeparen follows,
669 just store NULL for this element. */
670 c = read_skip_spaces (infile);
671 ungetc (c, infile);
672 if (c == ')')
674 XSTR (return_rtx, i) = 0;
675 break;
678 case 'T':
679 case 's':
681 char *stringbuf;
683 /* The output template slot of a DEFINE_INSN,
684 DEFINE_INSN_AND_SPLIT, or DEFINE_PEEPHOLE automatically
685 gets a star inserted as its first character, if it is
686 written with a brace block instead of a string constant. */
687 int star_if_braced = (format_ptr[-1] == 'T');
689 stringbuf = read_string (&rtl_obstack, infile, star_if_braced);
691 /* For insn patterns, we want to provide a default name
692 based on the file and line, like "*foo.md:12", if the
693 given name is blank. These are only for define_insn and
694 define_insn_and_split, to aid debugging. */
695 if (*stringbuf == '\0'
696 && i == 0
697 && (GET_CODE (return_rtx) == DEFINE_INSN
698 || GET_CODE (return_rtx) == DEFINE_INSN_AND_SPLIT))
700 char line_name[20];
701 const char *fn = (read_rtx_filename ? read_rtx_filename : "rtx");
702 const char *slash;
703 for (slash = fn; *slash; slash ++)
704 if (*slash == '/' || *slash == '\\' || *slash == ':')
705 fn = slash + 1;
706 obstack_1grow (&rtl_obstack, '*');
707 obstack_grow (&rtl_obstack, fn, strlen (fn));
708 sprintf (line_name, ":%d", read_rtx_lineno);
709 obstack_grow (&rtl_obstack, line_name, strlen (line_name)+1);
710 stringbuf = (char *) obstack_finish (&rtl_obstack);
713 if (star_if_braced)
714 XTMPL (return_rtx, i) = stringbuf;
715 else
716 XSTR (return_rtx, i) = stringbuf;
718 break;
720 case 'w':
721 read_name (tmp_char, infile);
722 validate_const_int (infile, tmp_char);
723 #if HOST_BITS_PER_WIDE_INT == HOST_BITS_PER_INT
724 tmp_wide = atoi (tmp_char);
725 #else
726 #if HOST_BITS_PER_WIDE_INT == HOST_BITS_PER_LONG
727 tmp_wide = atol (tmp_char);
728 #else
729 /* Prefer atoll over atoq, since the former is in the ISO C99 standard.
730 But prefer not to use our hand-rolled function above either. */
731 #if defined(HAVE_ATOLL) || !defined(HAVE_ATOQ)
732 tmp_wide = atoll (tmp_char);
733 #else
734 tmp_wide = atoq (tmp_char);
735 #endif
736 #endif
737 #endif
738 XWINT (return_rtx, i) = tmp_wide;
739 break;
741 case 'i':
742 case 'n':
743 read_name (tmp_char, infile);
744 validate_const_int (infile, tmp_char);
745 tmp_int = atoi (tmp_char);
746 XINT (return_rtx, i) = tmp_int;
747 break;
749 default:
750 fprintf (stderr,
751 "switch format wrong in rtl.read_rtx(). format was: %c.\n",
752 format_ptr[-1]);
753 fprintf (stderr, "\tfile position: %ld\n", ftell (infile));
754 abort ();
757 c = read_skip_spaces (infile);
758 if (c != ')')
759 fatal_expected_char (infile, ')', c);
761 return return_rtx;