1 /* Generate code from to output assembler insns as recognized from rtl.
2 Copyright (C) 1987, 1988, 1992, 1994, 1995, 1997, 1998, 1999, 2000
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
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
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
23 /* This program reads the machine description for the compiler target machine
24 and produces a file containing these things:
26 1. An array of `struct insn_data', which is indexed by insn code number,
29 a. `name' is the name for that pattern. Nameless patterns are
32 b. `output' hold either the output template, an array of output
33 templates, or an output function.
35 c. `genfun' is the function to generate a body for that pattern,
36 given operands as arguments.
38 d. `n_operands' is the number of distinct operands in the pattern
41 e. `n_dups' is the number of match_dup's that appear in the insn's
42 pattern. This says how many elements of `recog_data.dup_loc' are
43 significant after an insn has been recognized.
45 f. `n_alternatives' is the number of alternatives in the constraints
48 g. `output_format' tells what type of thing `output' is.
50 h. `operand' is the base of an array of operand data for the insn.
52 2. An array of `struct insn_operand data', used by `operand' above.
54 a. `predicate', an int-valued function, is the match_operand predicate
57 b. `constraint' is the constraint for this operand. This exists
58 only if register constraints appear in match_operand rtx's.
60 c. `address_p' indicates that the operand appears within ADDRESS
61 rtx's. This exists only if there are *no* register constraints
62 in the match_operand rtx's.
64 d. `mode' is the machine mode that that operand is supposed to have.
66 e. `strict_low', is nonzero for operands contained in a STRICT_LOW_PART.
68 f. `eliminable', is nonzero for operands that are matched normally by
69 MATCH_OPERAND; it is zero for operands that should not be changed during
70 register elimination such as MATCH_OPERATORs.
72 The code number of an insn is simply its position in the machine
73 description; code numbers are assigned sequentially to entries in
74 the description, starting with code number 0.
76 Thus, the following entry in the machine description
79 [(set (match_operand:DF 0 "general_operand" "")
84 assuming it is the 25th entry present, would cause
85 insn_data[24].template to be "clrd %0", and
86 insn_data[24].n_operands to be 1. */
90 #include "coretypes.h"
94 #include "gensupport.h"
96 /* No instruction can have more operands than this. Sorry for this
97 arbitrary limit, but what machine will have an instruction with
98 this many operands? */
100 #define MAX_MAX_OPERANDS 40
102 static int n_occurrences PARAMS ((int, const char *));
103 static const char *strip_whitespace PARAMS ((const char *));
105 /* insns in the machine description are assigned sequential code numbers
106 that are used by insn-recog.c (produced by genrecog) to communicate
107 to insn-output.c (produced by this program). */
109 static int next_code_number;
111 /* This counts all definitions in the md file,
112 for the sake of error messages. */
114 static int next_index_number;
116 /* This counts all operands used in the md file. The first is null. */
118 static int next_operand_number = 1;
120 /* Record in this chain all information about the operands we will output. */
124 struct operand_data *next;
126 const char *predicate;
127 const char *constraint;
128 enum machine_mode mode;
129 unsigned char n_alternatives;
136 /* Begin with a null operand at index 0. */
138 static struct operand_data null_operand =
140 0, 0, "", "", VOIDmode, 0, 0, 0, 0, 0
143 static struct operand_data *odata = &null_operand;
144 static struct operand_data **odata_end = &null_operand.next;
146 /* Must match the constants in recog.h. */
148 #define INSN_OUTPUT_FORMAT_NONE 0 /* abort */
149 #define INSN_OUTPUT_FORMAT_SINGLE 1 /* const char * */
150 #define INSN_OUTPUT_FORMAT_MULTI 2 /* const char * const * */
151 #define INSN_OUTPUT_FORMAT_FUNCTION 3 /* const char * (*)(...) */
153 /* Record in this chain all information that we will output,
154 associated with the code number of the insn. */
160 const char *template;
164 int n_operands; /* Number of operands this insn recognizes */
165 int n_dups; /* Number times match_dup appears in pattern */
166 int n_alternatives; /* Number of alternatives in each constraint */
167 int operand_number; /* Operand index in the big array. */
168 int output_format; /* INSN_OUTPUT_FORMAT_*. */
169 struct operand_data operand[MAX_MAX_OPERANDS];
172 /* This variable points to the first link in the insn chain. */
174 static struct data *idata, **idata_end = &idata;
176 static void output_prologue PARAMS ((void));
177 static void output_predicate_decls PARAMS ((void));
178 static void output_operand_data PARAMS ((void));
179 static void output_insn_data PARAMS ((void));
180 static void output_get_insn_name PARAMS ((void));
181 static void scan_operands PARAMS ((struct data *, rtx, int, int));
182 static int compare_operands PARAMS ((struct operand_data *,
183 struct operand_data *));
184 static void place_operands PARAMS ((struct data *));
185 static void process_template PARAMS ((struct data *, const char *));
186 static void validate_insn_alternatives PARAMS ((struct data *));
187 static void validate_insn_operands PARAMS ((struct data *));
188 static void gen_insn PARAMS ((rtx, int));
189 static void gen_peephole PARAMS ((rtx, int));
190 static void gen_expand PARAMS ((rtx, int));
191 static void gen_split PARAMS ((rtx, int));
194 get_insn_name (index)
197 static char buf[100];
199 struct data *i, *last_named = NULL;
200 for (i = idata; i ; i = i->next)
202 if (i->index_number == index)
209 sprintf(buf, "%s+%d", last_named->name, index - last_named->index_number);
211 sprintf(buf, "insn %d", index);
219 printf ("/* Generated automatically by the program `genoutput'\n\
220 from the machine description file `md'. */\n\n");
222 printf ("#include \"config.h\"\n");
223 printf ("#include \"system.h\"\n");
224 printf ("#include \"coretypes.h\"\n");
225 printf ("#include \"tm.h\"\n");
226 printf ("#include \"flags.h\"\n");
227 printf ("#include \"ggc.h\"\n");
228 printf ("#include \"rtl.h\"\n");
229 printf ("#include \"expr.h\"\n");
230 printf ("#include \"insn-codes.h\"\n");
231 printf ("#include \"tm_p.h\"\n");
232 printf ("#include \"function.h\"\n");
233 printf ("#include \"regs.h\"\n");
234 printf ("#include \"hard-reg-set.h\"\n");
235 printf ("#include \"real.h\"\n");
236 printf ("#include \"insn-config.h\"\n\n");
237 printf ("#include \"conditions.h\"\n");
238 printf ("#include \"insn-attr.h\"\n\n");
239 printf ("#include \"recog.h\"\n\n");
240 printf ("#include \"toplev.h\"\n");
241 printf ("#include \"output.h\"\n");
242 printf ("#include \"target.h\"\n");
246 /* We need to define all predicates used. Keep a list of those we
247 have defined so far. There normally aren't very many predicates
248 used, so a linked list should be fast enough. */
249 struct predicate { const char *name; struct predicate *next; };
252 output_predicate_decls ()
254 struct predicate *predicates = 0;
255 struct operand_data *d;
256 struct predicate *p, *next;
258 for (d = odata; d; d = d->next)
259 if (d->predicate && d->predicate[0])
261 for (p = predicates; p; p = p->next)
262 if (strcmp (p->name, d->predicate) == 0)
267 printf ("extern int %s PARAMS ((rtx, enum machine_mode));\n",
269 p = (struct predicate *) xmalloc (sizeof (struct predicate));
270 p->name = d->predicate;
271 p->next = predicates;
277 for (p = predicates; p; p = next)
285 output_operand_data ()
287 struct operand_data *d;
289 printf ("\nstatic const struct insn_operand_data operand_data[] = \n{\n");
291 for (d = odata; d; d = d->next)
296 d->predicate && d->predicate[0] ? d->predicate : "0");
298 printf (" \"%s\",\n", d->constraint ? d->constraint : "");
300 printf (" %smode,\n", GET_MODE_NAME (d->mode));
302 printf (" %d,\n", d->strict_low);
304 printf (" %d\n", d->eliminable);
316 int next_name_offset;
317 const char * last_name = 0;
318 const char * next_name = 0;
321 for (n = idata, next_name_offset = 1; n; n = n->next, next_name_offset++)
328 printf ("\nconst struct insn_data insn_data[] = \n{\n");
330 for (d = idata; d; d = d->next)
336 printf (" \"%s\",\n", d->name);
340 for (n = d->next, next_name_offset = 1; n;
341 n = n->next, next_name_offset++)
353 if (next_name && (last_name == 0
354 || name_offset > next_name_offset / 2))
355 printf (" \"%s-%d\",\n", next_name,
356 next_name_offset - name_offset);
358 printf (" \"%s+%d\",\n", last_name, name_offset);
361 switch (d->output_format)
363 case INSN_OUTPUT_FORMAT_NONE:
366 case INSN_OUTPUT_FORMAT_SINGLE:
368 const char *p = d->template;
374 if (IS_VSPACE (*p) && prev != '\\')
376 /* Preserve two consecutive \n's or \r's, but treat \r\n
377 as a single newline. */
378 if (*p == '\n' && prev != '\r')
389 case INSN_OUTPUT_FORMAT_MULTI:
390 case INSN_OUTPUT_FORMAT_FUNCTION:
391 printf (" (const PTR) output_%d,\n", d->code_number);
397 if (d->name && d->name[0] != '*')
398 printf (" (insn_gen_fn) gen_%s,\n", d->name);
402 printf (" &operand_data[%d],\n", d->operand_number);
403 printf (" %d,\n", d->n_operands);
404 printf (" %d,\n", d->n_dups);
405 printf (" %d,\n", d->n_alternatives);
406 printf (" %d\n", d->output_format);
414 output_get_insn_name ()
416 printf ("const char *\n");
417 printf ("get_insn_name (code)\n");
418 printf (" int code;\n");
420 printf (" return insn_data[code].name;\n");
425 /* Stores in max_opno the largest operand number present in `part', if
426 that is larger than the previous value of max_opno, and the rest of
427 the operand data into `d->operand[i]'.
429 THIS_ADDRESS_P is nonzero if the containing rtx was an ADDRESS.
430 THIS_STRICT_LOW is nonzero if the containing rtx was a STRICT_LOW_PART. */
436 scan_operands (d, part, this_address_p, this_strict_low)
443 const char *format_ptr;
449 switch (GET_CODE (part))
452 opno = XINT (part, 0);
455 if (max_opno >= MAX_MAX_OPERANDS)
457 message_with_line (d->lineno,
458 "maximum number of operands exceeded");
462 if (d->operand[opno].seen)
464 message_with_line (d->lineno,
465 "repeated operand number %d\n", opno);
469 d->operand[opno].seen = 1;
470 d->operand[opno].mode = GET_MODE (part);
471 d->operand[opno].strict_low = this_strict_low;
472 d->operand[opno].predicate = XSTR (part, 1);
473 d->operand[opno].constraint = strip_whitespace (XSTR (part, 2));
474 d->operand[opno].n_alternatives
475 = n_occurrences (',', d->operand[opno].constraint) + 1;
476 d->operand[opno].address_p = this_address_p;
477 d->operand[opno].eliminable = 1;
481 opno = XINT (part, 0);
484 if (max_opno >= MAX_MAX_OPERANDS)
486 message_with_line (d->lineno,
487 "maximum number of operands exceeded");
491 if (d->operand[opno].seen)
493 message_with_line (d->lineno,
494 "repeated operand number %d\n", opno);
498 d->operand[opno].seen = 1;
499 d->operand[opno].mode = GET_MODE (part);
500 d->operand[opno].strict_low = 0;
501 d->operand[opno].predicate = "scratch_operand";
502 d->operand[opno].constraint = strip_whitespace (XSTR (part, 1));
503 d->operand[opno].n_alternatives
504 = n_occurrences (',', d->operand[opno].constraint) + 1;
505 d->operand[opno].address_p = 0;
506 d->operand[opno].eliminable = 0;
511 opno = XINT (part, 0);
514 if (max_opno >= MAX_MAX_OPERANDS)
516 message_with_line (d->lineno,
517 "maximum number of operands exceeded");
521 if (d->operand[opno].seen)
523 message_with_line (d->lineno,
524 "repeated operand number %d\n", opno);
528 d->operand[opno].seen = 1;
529 d->operand[opno].mode = GET_MODE (part);
530 d->operand[opno].strict_low = 0;
531 d->operand[opno].predicate = XSTR (part, 1);
532 d->operand[opno].constraint = 0;
533 d->operand[opno].address_p = 0;
534 d->operand[opno].eliminable = 0;
535 for (i = 0; i < XVECLEN (part, 2); i++)
536 scan_operands (d, XVECEXP (part, 2, i), 0, 0);
546 scan_operands (d, XEXP (part, 0), 1, 0);
549 case STRICT_LOW_PART:
550 scan_operands (d, XEXP (part, 0), 0, 1);
557 format_ptr = GET_RTX_FORMAT (GET_CODE (part));
559 for (i = 0; i < GET_RTX_LENGTH (GET_CODE (part)); i++)
560 switch (*format_ptr++)
564 scan_operands (d, XEXP (part, i), 0, 0);
567 if (XVEC (part, i) != NULL)
568 for (j = 0; j < XVECLEN (part, i); j++)
569 scan_operands (d, XVECEXP (part, i, j), 0, 0);
574 /* Compare two operands for content equality. */
577 compare_operands (d0, d1)
578 struct operand_data *d0, *d1;
588 if (strcmp (p0, p1) != 0)
597 if (strcmp (p0, p1) != 0)
600 if (d0->mode != d1->mode)
603 if (d0->strict_low != d1->strict_low)
606 if (d0->eliminable != d1->eliminable)
612 /* Scan the list of operands we've already committed to output and either
613 find a subsequence that is the same, or allocate a new one at the end. */
619 struct operand_data *od, *od2;
622 if (d->n_operands == 0)
624 d->operand_number = 0;
628 /* Brute force substring search. */
629 for (od = odata, i = 0; od; od = od->next, i = 0)
630 if (compare_operands (od, &d->operand[0]))
636 if (i == d->n_operands)
640 if (! compare_operands (od2, &d->operand[i]))
642 ++i, od2 = od2->next;
646 /* Either partial match at the end of the list, or no match. In either
647 case, we tack on what operands are remaining to the end of the list. */
649 d->operand_number = next_operand_number - i;
650 for (; i < d->n_operands; ++i)
652 od2 = &d->operand[i];
654 odata_end = &od2->next;
655 od2->index = next_operand_number++;
661 d->operand_number = od->index;
666 /* Process an assembler template from a define_insn or a define_peephole.
667 It is either the assembler code template, a list of assembler code
668 templates, or C code to generate the assembler code template. */
671 process_template (d, template)
673 const char *template;
678 /* Templates starting with * contain straight code to be run. */
679 if (template[0] == '*')
682 d->output_format = INSN_OUTPUT_FORMAT_FUNCTION;
684 printf ("\nstatic const char *output_%d PARAMS ((rtx *, rtx));\n",
686 puts ("\nstatic const char *");
687 printf ("output_%d (operands, insn)\n", d->code_number);
688 puts (" rtx *operands ATTRIBUTE_UNUSED;");
689 puts (" rtx insn ATTRIBUTE_UNUSED;");
696 /* If the assembler code template starts with a @ it is a newline-separated
697 list of assembler code templates, one for each alternative. */
698 else if (template[0] == '@')
701 d->output_format = INSN_OUTPUT_FORMAT_MULTI;
703 printf ("\nstatic const char * const output_%d[] = {\n", d->code_number);
705 for (i = 0, cp = &template[1]; *cp; )
707 while (ISSPACE (*cp))
711 while (!IS_VSPACE (*cp) && *cp != '\0')
721 message_with_line (d->lineno,
722 "'@' is redundant for output template with single alternative");
723 if (i != d->n_alternatives)
725 message_with_line (d->lineno,
726 "wrong number of alternatives in the output template");
734 d->template = template;
735 d->output_format = INSN_OUTPUT_FORMAT_SINGLE;
739 /* Check insn D for consistency in number of constraint alternatives. */
742 validate_insn_alternatives (d)
747 /* Make sure all the operands have the same number of alternatives
748 in their constraints. Let N be that number. */
749 for (start = 0; start < d->n_operands; start++)
750 if (d->operand[start].n_alternatives > 0)
753 n = d->operand[start].n_alternatives;
754 else if (n != d->operand[start].n_alternatives)
756 message_with_line (d->lineno,
757 "wrong number of alternatives in operand %d",
763 /* Record the insn's overall number of alternatives. */
764 d->n_alternatives = n;
767 /* Verify that there are no gaps in operand numbers for INSNs. */
770 validate_insn_operands (d)
775 for (i = 0; i < d->n_operands; ++i)
776 if (d->operand[i].seen == 0)
778 message_with_line (d->lineno, "missing operand %d", i);
783 /* Look at a define_insn just read. Assign its code number. Record
784 on idata the template and the number of arguments. If the insn has
785 a hairy output action, output a function for now. */
788 gen_insn (insn, lineno)
792 struct data *d = (struct data *) xmalloc (sizeof (struct data));
795 d->code_number = next_code_number;
796 d->index_number = next_index_number;
798 if (XSTR (insn, 0)[0])
799 d->name = XSTR (insn, 0);
803 /* Build up the list in the same order as the insns are seen
804 in the machine description. */
807 idata_end = &d->next;
811 memset (d->operand, 0, sizeof (d->operand));
813 for (i = 0; i < XVECLEN (insn, 1); i++)
814 scan_operands (d, XVECEXP (insn, 1, i), 0, 0);
816 d->n_operands = max_opno + 1;
817 d->n_dups = num_dups;
819 validate_insn_operands (d);
820 validate_insn_alternatives (d);
822 process_template (d, XTMPL (insn, 3));
825 /* Look at a define_peephole just read. Assign its code number.
826 Record on idata the template and the number of arguments.
827 If the insn has a hairy output action, output it now. */
830 gen_peephole (peep, lineno)
834 struct data *d = (struct data *) xmalloc (sizeof (struct data));
837 d->code_number = next_code_number;
838 d->index_number = next_index_number;
842 /* Build up the list in the same order as the insns are seen
843 in the machine description. */
846 idata_end = &d->next;
850 memset (d->operand, 0, sizeof (d->operand));
852 /* Get the number of operands by scanning all the patterns of the
853 peephole optimizer. But ignore all the rest of the information
855 for (i = 0; i < XVECLEN (peep, 0); i++)
856 scan_operands (d, XVECEXP (peep, 0, i), 0, 0);
858 d->n_operands = max_opno + 1;
861 validate_insn_alternatives (d);
863 process_template (d, XTMPL (peep, 2));
866 /* Process a define_expand just read. Assign its code number,
867 only for the purposes of `insn_gen_function'. */
870 gen_expand (insn, lineno)
874 struct data *d = (struct data *) xmalloc (sizeof (struct data));
877 d->code_number = next_code_number;
878 d->index_number = next_index_number;
880 if (XSTR (insn, 0)[0])
881 d->name = XSTR (insn, 0);
885 /* Build up the list in the same order as the insns are seen
886 in the machine description. */
889 idata_end = &d->next;
893 memset (d->operand, 0, sizeof (d->operand));
895 /* Scan the operands to get the specified predicates and modes,
896 since expand_binop needs to know them. */
899 for (i = 0; i < XVECLEN (insn, 1); i++)
900 scan_operands (d, XVECEXP (insn, 1, i), 0, 0);
902 d->n_operands = max_opno + 1;
903 d->n_dups = num_dups;
905 d->output_format = INSN_OUTPUT_FORMAT_NONE;
907 validate_insn_alternatives (d);
911 /* Process a define_split just read. Assign its code number,
912 only for reasons of consistency and to simplify genrecog. */
915 gen_split (split, lineno)
919 struct data *d = (struct data *) xmalloc (sizeof (struct data));
922 d->code_number = next_code_number;
923 d->index_number = next_index_number;
927 /* Build up the list in the same order as the insns are seen
928 in the machine description. */
931 idata_end = &d->next;
935 memset (d->operand, 0, sizeof (d->operand));
937 /* Get the number of operands by scanning all the patterns of the
938 split patterns. But ignore all the rest of the information thus
940 for (i = 0; i < XVECLEN (split, 0); i++)
941 scan_operands (d, XVECEXP (split, 0, i), 0, 0);
943 d->n_operands = max_opno + 1;
945 d->n_alternatives = 0;
947 d->output_format = INSN_OUTPUT_FORMAT_NONE;
952 extern int main PARAMS ((int, char **));
961 progname = "genoutput";
964 fatal ("no input file name");
966 if (init_md_reader_args (argc, argv) != SUCCESS_EXIT_CODE)
967 return (FATAL_EXIT_CODE);
970 next_code_number = 0;
971 next_index_number = 0;
973 /* Read the machine description. */
979 desc = read_md_rtx (&line_no, &next_code_number);
983 if (GET_CODE (desc) == DEFINE_INSN)
984 gen_insn (desc, line_no);
985 if (GET_CODE (desc) == DEFINE_PEEPHOLE)
986 gen_peephole (desc, line_no);
987 if (GET_CODE (desc) == DEFINE_EXPAND)
988 gen_expand (desc, line_no);
989 if (GET_CODE (desc) == DEFINE_SPLIT
990 || GET_CODE (desc) == DEFINE_PEEPHOLE2)
991 gen_split (desc, line_no);
996 output_predicate_decls ();
997 output_operand_data ();
999 output_get_insn_name ();
1002 return (ferror (stdout) != 0 || have_error
1003 ? FATAL_EXIT_CODE : SUCCESS_EXIT_CODE);
1006 /* Return the number of occurrences of character C in string S or
1007 -1 if S is the null string. */
1010 n_occurrences (c, s)
1016 if (s == 0 || *s == '\0')
1025 /* Remove whitespace in `s' by moving up characters until the end.
1026 Return a new string. */
1029 strip_whitespace (s)
1038 p = q = xmalloc (strlen (s) + 1);
1039 while ((ch = *s++) != '\0')