1 /* The IGEN simulator generator for GDB, the GNU Debugger.
3 Copyright 2002-2021 Free Software Foundation, Inc.
5 Contributed by Andrew Cagney.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
33 #include "ld-decode.h"
38 #include "gen-model.h"
39 #include "gen-icache.h"
40 #include "gen-itable.h"
41 #include "gen-idecode.h"
42 #include "gen-semantics.h"
43 #include "gen-engine.h"
44 #include "gen-support.h"
45 #include "gen-engine.h"
48 /****************************************************************/
51 /* Semantic functions */
54 print_semantic_function_formal (lf
*file
, int nr_prefetched_words
)
58 if (options
.gen
.icache
|| nr_prefetched_words
< 0)
60 nr
+= lf_printf (file
, "SIM_DESC sd,\n");
61 nr
+= lf_printf (file
, "%sidecode_cache *cache_entry,\n",
62 options
.module
.global
.prefix
.l
);
63 nr
+= lf_printf (file
, "%sinstruction_address cia",
64 options
.module
.global
.prefix
.l
);
66 else if (options
.gen
.smp
)
68 nr
+= lf_printf (file
, "sim_cpu *cpu,\n");
69 for (word_nr
= 0; word_nr
< nr_prefetched_words
; word_nr
++)
71 nr
+= lf_printf (file
, "%sinstruction_word instruction_%d,\n",
72 options
.module
.global
.prefix
.l
, word_nr
);
74 nr
+= lf_printf (file
, "%sinstruction_address cia",
75 options
.module
.global
.prefix
.l
);
79 nr
+= lf_printf (file
, "SIM_DESC sd,\n");
80 for (word_nr
= 0; word_nr
< nr_prefetched_words
; word_nr
++)
82 nr
+= lf_printf (file
, "%sinstruction_word instruction_%d,\n",
83 options
.module
.global
.prefix
.l
, word_nr
);
85 nr
+= lf_printf (file
, "%sinstruction_address cia",
86 options
.module
.global
.prefix
.l
);
92 print_semantic_function_actual (lf
*file
, int nr_prefetched_words
)
96 if (options
.gen
.icache
|| nr_prefetched_words
< 0)
98 nr
+= lf_printf (file
, "sd, cache_entry, cia");
103 nr
+= lf_printf (file
, "cpu");
105 nr
+= lf_printf (file
, "sd");
106 for (word_nr
= 0; word_nr
< nr_prefetched_words
; word_nr
++)
107 nr
+= lf_printf (file
, ", instruction_%d", word_nr
);
108 nr
+= lf_printf (file
, ", cia");
114 print_semantic_function_type (lf
*file
)
117 nr
+= lf_printf (file
, "%sinstruction_address",
118 options
.module
.global
.prefix
.l
);
123 /* Idecode functions */
126 print_icache_function_formal (lf
*file
, int nr_prefetched_words
)
131 nr
+= lf_printf (file
, "sim_cpu *cpu,\n");
133 nr
+= lf_printf (file
, "SIM_DESC sd,\n");
134 for (word_nr
= 0; word_nr
< nr_prefetched_words
; word_nr
++)
135 nr
+= lf_printf (file
, " %sinstruction_word instruction_%d,\n",
136 options
.module
.global
.prefix
.l
, word_nr
);
137 nr
+= lf_printf (file
, " %sinstruction_address cia,\n",
138 options
.module
.global
.prefix
.l
);
139 nr
+= lf_printf (file
, " %sidecode_cache *cache_entry",
140 options
.module
.global
.prefix
.l
);
145 print_icache_function_actual (lf
*file
, int nr_prefetched_words
)
150 nr
+= lf_printf (file
, "cpu");
152 nr
+= lf_printf (file
, "sd");
153 for (word_nr
= 0; word_nr
< nr_prefetched_words
; word_nr
++)
154 nr
+= lf_printf (file
, ", instruction_%d", word_nr
);
155 nr
+= lf_printf (file
, ", cia, cache_entry");
160 print_icache_function_type (lf
*file
)
163 if (options
.gen
.semantic_icache
)
165 nr
= print_semantic_function_type (file
);
169 nr
= lf_printf (file
, "%sidecode_semantic *",
170 options
.module
.global
.prefix
.l
);
179 print_opcode_bits (lf
*file
, opcode_bits
*bits
)
184 nr
+= lf_putchr (file
, '_');
185 nr
+= lf_putstr (file
, bits
->field
->val_string
);
186 if (bits
->opcode
->is_boolean
&& bits
->value
== 0)
187 nr
+= lf_putint (file
, bits
->opcode
->boolean_constant
);
188 else if (!bits
->opcode
->is_boolean
)
190 if (bits
->opcode
->last
< bits
->field
->last
)
193 bits
->value
<< (bits
->field
->last
- bits
->opcode
->last
));
195 nr
+= lf_putint (file
, bits
->value
);
197 nr
+= print_opcode_bits (file
, bits
->next
);
202 print_c_name (lf
*file
, const char *name
)
206 for (pos
= name
; *pos
!= '\0'; pos
++)
215 nr
+= lf_putchr (file
, '_');
218 nr
+= lf_putchr (file
, *pos
);
226 print_function_name (lf
*file
,
227 const char *basename
,
228 const char *format_name
,
229 const char *model_name
,
230 opcode_bits
*expanded_bits
,
231 lf_function_name_prefixes prefix
)
237 case function_name_prefix_semantics
:
238 nr
+= lf_printf (file
, "%s", options
.module
.semantics
.prefix
.l
);
239 nr
+= lf_printf (file
, "semantic_");
241 case function_name_prefix_idecode
:
242 nr
+= lf_printf (file
, "%s", options
.module
.idecode
.prefix
.l
);
243 nr
+= lf_printf (file
, "idecode_");
245 case function_name_prefix_itable
:
246 nr
+= lf_printf (file
, "%sitable_", options
.module
.itable
.prefix
.l
);
248 case function_name_prefix_icache
:
249 nr
+= lf_printf (file
, "%s", options
.module
.icache
.prefix
.l
);
250 nr
+= lf_printf (file
, "icache_");
252 case function_name_prefix_engine
:
253 nr
+= lf_printf (file
, "%s", options
.module
.engine
.prefix
.l
);
254 nr
+= lf_printf (file
, "engine_");
259 if (model_name
!= NULL
)
261 nr
+= print_c_name (file
, model_name
);
262 nr
+= lf_printf (file
, "_");
265 /* the function name */
266 nr
+= print_c_name (file
, basename
);
268 /* the format name if available */
269 if (format_name
!= NULL
)
271 nr
+= lf_printf (file
, "_");
272 nr
+= print_c_name (file
, format_name
);
276 nr
+= print_opcode_bits (file
, expanded_bits
);
283 print_my_defines (lf
*file
,
284 const char *basename
,
285 const char *format_name
, opcode_bits
*expanded_bits
)
287 /* #define MY_INDEX xxxxx */
288 lf_indent_suppress (file
);
289 lf_printf (file
, "#undef MY_INDEX\n");
290 lf_indent_suppress (file
);
291 lf_printf (file
, "#define MY_INDEX ");
292 print_function_name (file
,
293 basename
, format_name
, NULL
,
294 NULL
, function_name_prefix_itable
);
295 lf_printf (file
, "\n");
296 /* #define MY_PREFIX xxxxxx */
297 lf_indent_suppress (file
);
298 lf_printf (file
, "#undef ");
299 print_function_name (file
,
300 basename
, format_name
, NULL
,
301 expanded_bits
, function_name_prefix_none
);
302 lf_printf (file
, "\n");
303 lf_indent_suppress (file
);
304 lf_printf (file
, "#undef MY_PREFIX\n");
305 lf_indent_suppress (file
);
306 lf_printf (file
, "#define MY_PREFIX ");
307 print_function_name (file
,
308 basename
, format_name
, NULL
,
309 expanded_bits
, function_name_prefix_none
);
310 lf_printf (file
, "\n");
311 /* #define MY_NAME xxxxxx */
312 lf_indent_suppress (file
);
313 lf_indent_suppress (file
);
314 lf_printf (file
, "#undef MY_NAME\n");
315 lf_indent_suppress (file
);
316 lf_printf (file
, "#define MY_NAME \"");
317 print_function_name (file
,
318 basename
, format_name
, NULL
,
319 expanded_bits
, function_name_prefix_none
);
320 lf_printf (file
, "\"\n");
325 print_itrace_prefix (lf
*file
)
327 const char *prefix
= "trace_prefix (";
328 int indent
= strlen (prefix
);
329 lf_printf (file
, "%sSD, CPU, cia, CIA, TRACE_LINENUM_P (CPU), \\\n",
331 lf_indent (file
, +indent
);
332 lf_printf (file
, "%sitable[MY_INDEX].file, \\\n",
333 options
.module
.itable
.prefix
.l
);
334 lf_printf (file
, "%sitable[MY_INDEX].line_nr, \\\n",
335 options
.module
.itable
.prefix
.l
);
336 lf_printf (file
, "\"");
342 print_itrace_format (lf
*file
, insn_mnemonic_entry
*assembler
)
344 /* pass=1 is fmt string; pass=2 is arguments */
346 /* print the format string */
347 for (pass
= 1; pass
<= 2; pass
++)
349 const char *chp
= assembler
->format
;
350 chp
++; /* skip the leading quote */
351 /* write out the format/args */
354 if (chp
[0] == '\\' && (chp
[1] == '<' || chp
[1] == '>'))
357 lf_putchr (file
, chp
[1]);
360 else if (chp
[0] == '<' || chp
[0] == '%')
362 /* parse [ "%" ... ] "<" [ func "#" ] param ">" */
368 /* the "%" ... "<" format */
370 while (chp
[0] != '<' && chp
[0] != '\0')
373 error (assembler
->line
, "Missing `<' after `%%'\n");
375 /* [ "func" # ] OR "param" */
378 while (chp
[0] != '>' && chp
[0] != '#' && chp
[0] != '\0')
380 strlen_func
= chp
- func
;
385 while (chp
[0] != '>' && chp
[0] != '\0')
388 strlen_param
= chp
- param
;
390 error (assembler
->line
,
391 "Missing closing `>' in assembler string\n");
395 lf_printf (file
, ", \\\n");
396 if (strncmp (fmt
, "<", 1) == 0)
397 /* implicit long int format */
400 lf_printf (file
, "%%ld");
403 lf_printf (file
, "(long) ");
404 lf_write (file
, param
, strlen_param
);
407 else if (strncmp (fmt
, "%<", 2) == 0)
408 /* explicit format */
411 lf_printf (file
, "%%");
413 lf_write (file
, param
, strlen_param
);
415 else if (strncmp (fmt
, "%s<", 3) == 0)
419 lf_printf (file
, "%%s");
422 lf_printf (file
, "%sstr_",
423 options
.module
.global
.prefix
.l
);
424 lf_write (file
, func
, strlen_func
);
425 lf_printf (file
, " (SD_, ");
426 lf_write (file
, param
, strlen_param
);
427 lf_printf (file
, ")");
430 else if (strncmp (fmt
, "%lx<", 4) == 0)
434 lf_printf (file
, "%%lx");
437 lf_printf (file
, "(unsigned long) ");
438 lf_write (file
, param
, strlen_param
);
441 else if (strncmp (fmt
, "%#lx<", 5) == 0)
442 /* simple hex with 0x prefix */
445 lf_printf (file
, "%%#lx");
448 lf_printf (file
, "(unsigned long) ");
449 lf_write (file
, param
, strlen_param
);
452 else if (strncmp (fmt
, "%08lx<", 6) == 0)
456 lf_printf (file
, "%%08lx");
459 lf_printf (file
, "(unsigned long) ");
460 lf_write (file
, param
, strlen_param
);
464 error (assembler
->line
, "Unknown assembler string format\n");
469 lf_putchr (file
, chp
[0]);
474 lf_printf (file
, ");\n");
479 print_itrace (lf
*file
, insn_entry
* insn
, int idecode
)
481 /* NB: Here we escape each EOLN. This is so that the the compiler
482 treats a trace function call as a single line. Consequently any
483 errors in the line are refered back to the same igen assembler
485 const char *phase
= (idecode
) ? "DECODE" : "INSN";
486 lf_printf (file
, "\n");
487 lf_indent_suppress (file
);
488 lf_printf (file
, "#if defined (WITH_TRACE)\n");
489 lf_printf (file
, "/* generate a trace prefix if any tracing enabled */\n");
490 lf_printf (file
, "if (TRACE_ANY_P (CPU))\n");
491 lf_printf (file
, " {\n");
492 lf_indent (file
, +4);
494 if (insn
->mnemonics
!= NULL
)
496 insn_mnemonic_entry
*assembler
= insn
->mnemonics
;
500 if (assembler
->condition
!= NULL
)
503 lf_printf (file
, "%sif (%s)\n",
504 is_first
? "" : "else ", assembler
->condition
);
505 lf_indent (file
, +2);
506 lf_print__line_ref (file
, assembler
->line
);
507 indent
= print_itrace_prefix (file
);
508 print_itrace_format (file
, assembler
);
509 lf_print__internal_ref (file
);
510 lf_indent (file
, -indent
);
511 lf_indent (file
, -2);
512 if (assembler
->next
== NULL
)
513 error (assembler
->line
,
514 "Missing final unconditional assembler\n");
521 lf_printf (file
, "else\n");
522 lf_indent (file
, +2);
524 lf_print__line_ref (file
, assembler
->line
);
525 indent
= print_itrace_prefix (file
);
526 print_itrace_format (file
, assembler
);
527 lf_print__internal_ref (file
);
528 lf_indent (file
, -indent
);
530 lf_indent (file
, -2);
531 if (assembler
->next
!= NULL
)
532 error (assembler
->line
,
533 "Unconditional assembler is not last\n");
536 assembler
= assembler
->next
;
538 while (assembler
!= NULL
);
543 lf_indent (file
, +2);
544 lf_print__line_ref (file
, insn
->line
);
545 indent
= print_itrace_prefix (file
);
546 lf_printf (file
, "%%s\", \\\n");
547 lf_printf (file
, "itable[MY_INDEX].name);\n");
548 lf_print__internal_ref (file
);
549 lf_indent (file
, -indent
);
550 lf_indent (file
, -2);
552 lf_printf (file
, "/* trace the instruction execution if enabled */\n");
553 lf_printf (file
, "if (TRACE_%s_P (CPU))\n", phase
);
555 " trace_generic (SD, CPU, TRACE_%s_IDX, \" %%s\", itable[MY_INDEX].name);\n",
558 lf_indent (file
, -4);
559 lf_printf (file
, " }\n");
560 lf_indent_suppress (file
);
561 lf_printf (file
, "#endif\n");
566 print_sim_engine_abort (lf
*file
, const char *message
)
568 lf_printf (file
, "sim_engine_abort (SD, CPU, cia, ");
569 lf_printf (file
, "\"%s\"", message
);
570 lf_printf (file
, ");\n");
575 print_include (lf
*file
, igen_module module
)
577 lf_printf (file
, "#include \"%s%s.h\"\n", module
.prefix
.l
, module
.suffix
.l
);
581 print_include_inline (lf
*file
, igen_module module
)
583 lf_printf (file
, "#if C_REVEALS_MODULE_P (%s_INLINE)\n", module
.suffix
.u
);
584 lf_printf (file
, "#include \"%s%s.c\"\n", module
.prefix
.l
, module
.suffix
.l
);
585 lf_printf (file
, "#else\n");
586 print_include (file
, module
);
587 lf_printf (file
, "#endif\n");
588 lf_printf (file
, "\n");
592 print_includes (lf
*file
)
594 lf_printf (file
, "\n");
595 lf_printf (file
, "#include \"sim-inline.c\"\n");
596 lf_printf (file
, "\n");
597 print_include_inline (file
, options
.module
.itable
);
598 print_include_inline (file
, options
.module
.idecode
);
599 print_include_inline (file
, options
.module
.support
);
603 /****************************************************************/
607 gen_semantics_h (lf
*file
, insn_list
*semantics
, int max_nr_words
)
611 for (word_nr
= -1; word_nr
<= max_nr_words
; word_nr
++)
613 lf_printf (file
, "typedef ");
614 print_semantic_function_type (file
);
615 lf_printf (file
, " %sidecode_semantic", options
.module
.global
.prefix
.l
);
617 lf_printf (file
, "_%d", word_nr
);
618 lf_printf (file
, "\n(");
619 lf_indent (file
, +1);
620 print_semantic_function_formal (file
, word_nr
);
621 lf_indent (file
, -1);
622 lf_printf (file
, ");\n");
623 lf_printf (file
, "\n");
625 switch (options
.gen
.code
)
628 for (semantic
= semantics
; semantic
!= NULL
; semantic
= semantic
->next
)
630 /* Ignore any special/internal instructions */
631 if (semantic
->insn
->nr_words
== 0)
633 print_semantic_declaration (file
,
635 semantic
->expanded_bits
,
637 semantic
->nr_prefetched_words
);
641 lf_print__this_file_is_empty (file
, "generating jumps");
648 gen_semantics_c (lf
*file
, insn_list
*semantics
, cache_entry
*cache_rules
)
650 if (options
.gen
.code
== generate_calls
)
653 print_includes (file
);
654 print_include (file
, options
.module
.semantics
);
655 lf_printf (file
, "\n");
657 for (semantic
= semantics
; semantic
!= NULL
; semantic
= semantic
->next
)
659 /* Ignore any special/internal instructions */
660 if (semantic
->insn
->nr_words
== 0)
662 print_semantic_definition (file
,
664 semantic
->expanded_bits
,
667 semantic
->nr_prefetched_words
);
672 lf_print__this_file_is_empty (file
, "generating jump engine");
677 /****************************************************************/
681 gen_icache_h (lf
*file
,
683 function_entry
* functions
, int max_nr_words
)
686 for (word_nr
= 0; word_nr
<= max_nr_words
; word_nr
++)
688 lf_printf (file
, "typedef ");
689 print_icache_function_type (file
);
690 lf_printf (file
, " %sidecode_icache_%d\n(",
691 options
.module
.global
.prefix
.l
, word_nr
);
692 print_icache_function_formal (file
, word_nr
);
693 lf_printf (file
, ");\n");
694 lf_printf (file
, "\n");
696 if (options
.gen
.code
== generate_calls
&& options
.gen
.icache
)
698 function_entry_traverse (file
, functions
,
699 print_icache_internal_function_declaration
,
701 while (semantic
!= NULL
)
703 print_icache_declaration (file
,
705 semantic
->expanded_bits
,
707 semantic
->nr_prefetched_words
);
708 semantic
= semantic
->next
;
713 lf_print__this_file_is_empty (file
, "generating jump engine");
718 gen_icache_c (lf
*file
,
720 function_entry
* functions
, cache_entry
*cache_rules
)
722 /* output `internal' invalid/floating-point unavailable functions
724 if (options
.gen
.code
== generate_calls
&& options
.gen
.icache
)
726 lf_printf (file
, "\n");
727 lf_printf (file
, "#include \"cpu.h\"\n");
728 lf_printf (file
, "#include \"idecode.h\"\n");
729 lf_printf (file
, "#include \"semantics.h\"\n");
730 lf_printf (file
, "#include \"icache.h\"\n");
731 lf_printf (file
, "#include \"support.h\"\n");
732 lf_printf (file
, "\n");
733 function_entry_traverse (file
, functions
,
734 print_icache_internal_function_definition
,
736 lf_printf (file
, "\n");
737 while (semantic
!= NULL
)
739 print_icache_definition (file
,
741 semantic
->expanded_bits
,
744 semantic
->nr_prefetched_words
);
745 semantic
= semantic
->next
;
750 lf_print__this_file_is_empty (file
, "generating jump engine");
755 /****************************************************************/
759 gen_idecode_h (lf
*file
,
760 gen_table
*gen
, insn_table
*insns
, cache_entry
*cache_rules
)
762 lf_printf (file
, "typedef unsigned%d %sinstruction_word;\n",
763 options
.insn_bit_size
, options
.module
.global
.prefix
.l
);
764 if (options
.gen
.delayed_branch
)
766 lf_printf (file
, "typedef struct _%sinstruction_address {\n",
767 options
.module
.global
.prefix
.l
);
768 lf_printf (file
, " address_word ip; /* instruction pointer */\n");
769 lf_printf (file
, " address_word dp; /* delayed-slot pointer */\n");
770 lf_printf (file
, "} %sinstruction_address;\n",
771 options
.module
.global
.prefix
.l
);
775 lf_printf (file
, "typedef address_word %sinstruction_address;\n",
776 options
.module
.global
.prefix
.l
);
779 if (options
.gen
.nia
== nia_is_invalid
780 && strlen (options
.module
.global
.prefix
.u
) > 0)
782 lf_indent_suppress (file
);
783 lf_printf (file
, "#define %sINVALID_INSTRUCTION_ADDRESS ",
784 options
.module
.global
.prefix
.u
);
785 lf_printf (file
, "INVALID_INSTRUCTION_ADDRESS\n");
787 lf_printf (file
, "\n");
788 print_icache_struct (file
, insns
, cache_rules
);
789 lf_printf (file
, "\n");
790 if (options
.gen
.icache
)
792 ERROR ("FIXME - idecode with icache suffering from bit-rot");
797 for (entry
= gen
->tables
; entry
!= NULL
; entry
= entry
->next
)
799 print_idecode_issue_function_header (file
,
800 (options
.gen
.multi_sim
803 is_function_declaration
,
804 1 /*ALWAYS ONE WORD */ );
806 if (options
.gen
.multi_sim
)
808 print_idecode_issue_function_header (file
,
810 is_function_variable
,
811 1 /*ALWAYS ONE WORD */ );
818 gen_idecode_c (lf
*file
,
819 gen_table
*gen
, insn_table
*isa
, cache_entry
*cache_rules
)
822 print_includes (file
);
823 print_include_inline (file
, options
.module
.semantics
);
824 lf_printf (file
, "\n");
826 print_idecode_globals (file
);
827 lf_printf (file
, "\n");
829 switch (options
.gen
.code
)
834 for (entry
= gen
->tables
; entry
!= NULL
; entry
= entry
->next
)
836 print_idecode_lookups (file
, entry
->table
, cache_rules
);
838 /* output the main idecode routine */
839 if (!options
.gen
.icache
)
841 print_idecode_issue_function_header (file
,
842 (options
.gen
.multi_sim
845 1 /*is definition */ ,
846 1 /*ALWAYS ONE WORD */ );
847 lf_printf (file
, "{\n");
848 lf_indent (file
, +2);
849 lf_printf (file
, "%sinstruction_address nia;\n",
850 options
.module
.global
.prefix
.l
);
851 print_idecode_body (file
, entry
->table
, "nia =");
852 lf_printf (file
, "return nia;");
853 lf_indent (file
, -2);
854 lf_printf (file
, "}\n");
861 lf_print__this_file_is_empty (file
, "generating a jump engine");
868 /****************************************************************/
872 gen_run_c (lf
*file
, gen_table
*gen
)
875 lf_printf (file
, "#include \"sim-main.h\"\n");
876 lf_printf (file
, "#include \"engine.h\"\n");
877 lf_printf (file
, "#include \"idecode.h\"\n");
878 lf_printf (file
, "#include \"bfd.h\"\n");
879 lf_printf (file
, "\n");
881 if (options
.gen
.multi_sim
)
883 print_idecode_issue_function_header (file
, NULL
, is_function_variable
,
885 lf_printf (file
, "\n");
886 print_engine_run_function_header (file
, NULL
, is_function_variable
);
887 lf_printf (file
, "\n");
890 lf_printf (file
, "void\n");
891 lf_printf (file
, "sim_engine_run (SIM_DESC sd,\n");
892 lf_printf (file
, " int next_cpu_nr,\n");
893 lf_printf (file
, " int nr_cpus,\n");
894 lf_printf (file
, " int siggnal)\n");
895 lf_printf (file
, "{\n");
896 lf_indent (file
, +2);
897 if (options
.gen
.multi_sim
)
899 lf_printf (file
, "int mach;\n");
900 lf_printf (file
, "if (STATE_ARCHITECTURE (sd) == NULL)\n");
901 lf_printf (file
, " mach = 0;\n");
902 lf_printf (file
, "else\n");
903 lf_printf (file
, " mach = STATE_ARCHITECTURE (sd)->mach;\n");
904 lf_printf (file
, "switch (mach)\n");
905 lf_printf (file
, " {\n");
906 lf_indent (file
, +2);
907 for (entry
= gen
->tables
; entry
!= NULL
; entry
= entry
->next
)
909 if (options
.gen
.default_model
!= NULL
910 && (strcmp (entry
->model
->name
, options
.gen
.default_model
) == 0
911 || strcmp (entry
->model
->full_name
,
912 options
.gen
.default_model
) == 0))
913 lf_printf (file
, "default:\n");
914 lf_printf (file
, "case bfd_mach_%s:\n", entry
->model
->full_name
);
915 lf_indent (file
, +2);
916 print_function_name (file
, "issue", NULL
, /* format name */
917 NULL
, /* NO processor */
918 NULL
, /* expanded bits */
919 function_name_prefix_idecode
);
920 lf_printf (file
, " = ");
921 print_function_name (file
, "issue", NULL
, /* format name */
922 entry
->model
->name
, NULL
, /* expanded bits */
923 function_name_prefix_idecode
);
924 lf_printf (file
, ";\n");
925 print_function_name (file
, "run", NULL
, /* format name */
926 NULL
, /* NO processor */
927 NULL
, /* expanded bits */
928 function_name_prefix_engine
);
929 lf_printf (file
, " = ");
930 print_function_name (file
, "run", NULL
, /* format name */
931 entry
->model
->name
, NULL
, /* expanded bits */
932 function_name_prefix_engine
);
933 lf_printf (file
, ";\n");
934 lf_printf (file
, "break;\n");
935 lf_indent (file
, -2);
937 if (options
.gen
.default_model
== NULL
)
939 lf_printf (file
, "default:\n");
940 lf_indent (file
, +2);
941 lf_printf (file
, "sim_engine_abort (sd, NULL, NULL_CIA,\n");
943 " \"sim_engine_run - unknown machine\");\n");
944 lf_printf (file
, "break;\n");
945 lf_indent (file
, -2);
947 lf_indent (file
, -2);
948 lf_printf (file
, " }\n");
950 print_function_name (file
, "run", NULL
, /* format name */
951 NULL
, /* NO processor */
952 NULL
, /* expanded bits */
953 function_name_prefix_engine
);
954 lf_printf (file
, " (sd, next_cpu_nr, nr_cpus, siggnal);\n");
955 lf_indent (file
, -2);
956 lf_printf (file
, "}\n");
959 /****************************************************************/
962 do_gen (insn_table
*isa
, decode_table
*decode_rules
)
965 if (decode_rules
== NULL
)
966 error (NULL
, "Must specify a decode table\n");
968 error (NULL
, "Must specify an instruction table\n");
969 if (decode_table_max_word_nr (decode_rules
) > 0)
970 options
.gen
.multi_word
= decode_table_max_word_nr (decode_rules
);
971 gen
= make_gen_tables (isa
, decode_rules
);
972 gen_tables_expand_insns (gen
);
973 gen_tables_expand_semantics (gen
);
977 /****************************************************************/
979 igen_options options
;
982 main (int argc
, char **argv
, char **envp
)
984 cache_entry
*cache_rules
= NULL
;
985 lf_file_references file_references
= lf_include_references
;
986 decode_table
*decode_rules
= NULL
;
987 insn_table
*isa
= NULL
;
988 gen_table
*gen
= NULL
;
989 char *real_file_name
= NULL
;
993 lf_open ("-", "stdout", lf_omit_references
, lf_is_text
, "igen");
1001 printf (" igen <config-opts> ... <input-opts>... <output-opts>...\n");
1003 printf ("Config options:\n");
1005 printf (" -B <bit-size>\n");
1006 printf ("\t Set the number of bits in an instruction (deprecated).\n");
1008 ("\t This option can now be set directly in the instruction table.\n");
1010 printf (" -D <data-structure>\n");
1012 ("\t Dump the specified data structure to stdout. Valid structures include:\n");
1014 ("\t processor-names - list the names of all the processors (models)\n");
1016 printf (" -F <filter-list>\n");
1018 ("\t Filter out any instructions with a non-empty flags field that contains\n");
1019 printf ("\t a flag not listed in the <filter-list>.\n");
1021 printf (" -H <high-bit>\n");
1023 ("\t Set the number of the high (most significant) instruction bit (deprecated).\n");
1025 ("\t This option can now be set directly in the instruction table.\n");
1027 printf (" -I <directory>\n");
1029 ("\t Add <directory> to the list of directories searched when opening a file\n");
1031 printf (" -M <model-list>\n");
1033 ("\t Filter out any instructions that do not support at least one of the listed\n");
1035 ("\t models (An instructions with no model information is considered to support\n");
1036 printf ("\t all models.).\n");
1038 printf (" -N <nr-cpus>\n");
1039 printf ("\t Generate a simulator supporting <nr-cpus>\n");
1041 ("\t Specify `-N 0' to disable generation of the SMP. Specifying `-N 1' will\n");
1043 ("\t still generate an SMP enabled simulator but will only support one CPU.\n");
1045 printf (" -T <mechanism>\n");
1047 ("\t Override the decode mechanism specified by the decode rules\n");
1049 printf (" -P <prefix>\n");
1051 ("\t Prepend global names (except itable) with the string <prefix>.\n");
1053 ("\t Specify -P <module>=<prefix> to set a specific <module>'s prefix.\n");
1055 printf (" -S <suffix>\n");
1057 ("\t Replace a global name (suffix) (except itable) with the string <suffix>.\n");
1059 ("\t Specify -S <module>=<suffix> to change a specific <module>'s name (suffix).\n");
1061 printf (" -Werror\n");
1062 printf ("\t Make warnings errors\n");
1063 printf (" -Wnodiscard\n");
1065 ("\t Suppress warnings about discarded functions and instructions\n");
1066 printf (" -Wnowidth\n");
1068 ("\t Suppress warnings about instructions with invalid widths\n");
1069 printf (" -Wnounimplemented\n");
1070 printf ("\t Suppress warnings about unimplemented instructions\n");
1072 printf (" -G [!]<gen-option>\n");
1073 printf ("\t Any of the following options:\n");
1076 ("\t decode-duplicate - Override the decode rules, forcing the duplication of\n");
1077 printf ("\t semantic functions\n");
1079 ("\t decode-combine - Combine any duplicated entries within a table\n");
1081 ("\t decode-zero-reserved - Override the decode rules, forcing reserved bits to be\n");
1082 printf ("\t treated as zero.\n");
1084 ("\t decode-switch-is-goto - Overfide the padded-switch code type as a goto-switch\n");
1087 ("\t gen-conditional-issue - conditionally issue each instruction\n");
1089 ("\t gen-delayed-branch - need both cia and nia passed around\n");
1091 ("\t gen-direct-access - use #defines to directly access values\n");
1093 ("\t gen-zero-r<N> - arch assumes GPR(<N>) == 0, keep it that way\n");
1095 ("\t gen-icache[=<N> - generate an instruction cracking cache of size <N>\n");
1096 printf ("\t Default size is %d\n",
1097 options
.gen
.icache_size
);
1099 ("\t gen-insn-in-icache - save original instruction when cracking\n");
1101 ("\t gen-multi-sim[=MODEL] - generate multiple simulators - one per model\n");
1103 ("\t If specified MODEL is made the default architecture.\n");
1105 ("\t By default, a single simulator that will\n");
1107 ("\t execute any instruction is generated\n");
1109 ("\t gen-multi-word - generate code allowing for multi-word insns\n");
1111 ("\t gen-semantic-icache - include semantic code in cracking functions\n");
1113 ("\t gen-slot-verification - perform slot verification as part of decode\n");
1114 printf ("\t gen-nia-invalid - NIA defaults to nia_invalid\n");
1115 printf ("\t gen-nia-void - do not compute/return NIA\n");
1118 ("\t trace-combine - report combined entries a rule application\n");
1120 ("\t trace-entries - report entries after a rules application\n");
1121 printf ("\t trace-rule-rejection - report each rule as rejected\n");
1122 printf ("\t trace-rule-selection - report each rule as selected\n");
1124 ("\t trace-insn-insertion - report each instruction as it is inserted into a decode table\n");
1126 ("\t trace-rule-expansion - report each instruction as it is expanded (before insertion into a decode table)\n");
1127 printf ("\t trace-all - enable all trace options\n");
1130 ("\t field-widths - instruction formats specify widths (deprecated)\n");
1132 ("\t By default, an instruction format specifies bit\n");
1133 printf ("\t positions\n");
1135 ("\t This option can now be set directly in the\n");
1136 printf ("\t instruction table\n");
1138 ("\t jumps - use jumps instead of function calls\n");
1140 ("\t omit-line-numbers - do not include line number information in the output\n");
1142 printf ("Input options:\n");
1144 printf (" -k <cache-rules> (deprecated)\n");
1145 printf (" -o <decode-rules>\n");
1146 printf (" -i <instruction-table>\n");
1148 printf ("Output options:\n");
1150 printf (" -x Perform expansion (required)\n");
1152 (" -n <real-name> Specify the real name of the next output file\n");
1154 (" -h Generate the header (.h) file rather than the body (.c)\n");
1155 printf (" -c <output-file> output icache\n");
1156 printf (" -d <output-file> output idecode\n");
1157 printf (" -e <output-file> output engine\n");
1158 printf (" -f <output-file> output support functions\n");
1159 printf (" -m <output-file> output model\n");
1160 printf (" -r <output-file> output multi-sim run\n");
1161 printf (" -s <output-file> output schematic\n");
1162 printf (" -t <output-file> output itable\n");
1165 while ((ch
= getopt (argc
, argv
,
1166 "B:D:F:G:H:I:M:N:P:T:W:o:k:i:n:hc:d:e:m:r:s:t:f:x"))
1169 fprintf (stderr
, " -%c ", ch
);
1171 fprintf (stderr
, "%s ", optarg
);
1172 fprintf (stderr
, "\\\n");
1178 filter_parse (&options
.model_filter
, optarg
);
1182 if (strcmp (optarg
, "processor-names"))
1185 for (processor
= filter_next (options
.model_filter
, "");
1187 processor
= filter_next (options
.model_filter
, processor
))
1188 lf_printf (standard_out
, "%s\n", processor
);
1191 error (NULL
, "Unknown data structure %s, not dumped\n", optarg
);
1195 filter_parse (&options
.flags_filter
, optarg
);
1200 table_include
**dir
= &options
.include
;
1201 while ((*dir
) != NULL
)
1202 dir
= &(*dir
)->next
;
1203 (*dir
) = ZALLOC (table_include
);
1204 (*dir
)->dir
= strdup (optarg
);
1209 options
.insn_bit_size
= a2i (optarg
);
1210 if (options
.insn_bit_size
<= 0
1211 || options
.insn_bit_size
> max_insn_bit_size
)
1213 error (NULL
, "Instruction bitsize must be in range 1..%d\n",
1216 if (options
.hi_bit_nr
!= options
.insn_bit_size
- 1
1217 && options
.hi_bit_nr
!= 0)
1219 error (NULL
, "Conflict betweem hi-bit-nr and insn-bit-size\n");
1224 options
.hi_bit_nr
= a2i (optarg
);
1225 if (options
.hi_bit_nr
!= options
.insn_bit_size
- 1
1226 && options
.hi_bit_nr
!= 0)
1228 error (NULL
, "Conflict between hi-bit-nr and insn-bit-size\n");
1233 options
.gen
.smp
= a2i (optarg
);
1242 chp
= strchr (optarg
, '=');
1245 names
= &options
.module
.global
;
1250 chp
= chp
+ 1; /* skip `=' */
1252 if (strncmp (optarg
, "global=", chp
- optarg
) == 0)
1254 names
= &options
.module
.global
;
1256 if (strncmp (optarg
, "engine=", chp
- optarg
) == 0)
1258 names
= &options
.module
.engine
;
1260 if (strncmp (optarg
, "icache=", chp
- optarg
) == 0)
1262 names
= &options
.module
.icache
;
1264 if (strncmp (optarg
, "idecode=", chp
- optarg
) == 0)
1266 names
= &options
.module
.idecode
;
1268 if (strncmp (optarg
, "itable=", chp
- optarg
) == 0)
1270 names
= &options
.module
.itable
;
1272 if (strncmp (optarg
, "semantics=", chp
- optarg
) == 0)
1274 names
= &options
.module
.semantics
;
1276 if (strncmp (optarg
, "support=", chp
- optarg
) == 0)
1278 names
= &options
.module
.support
;
1282 error (NULL
, "Prefix `%s' unreconized\n", optarg
);
1288 name
= &names
->prefix
;
1291 name
= &names
->suffix
;
1294 abort (); /* Bad switch. */
1296 name
->u
= strdup (chp
);
1297 name
->l
= strdup (chp
);
1302 *chp
= toupper (*chp
);
1305 if (name
== &options
.module
.global
.prefix
)
1307 options
.module
.engine
.prefix
= options
.module
.global
.prefix
;
1308 options
.module
.icache
.prefix
= options
.module
.global
.prefix
;
1309 options
.module
.idecode
.prefix
= options
.module
.global
.prefix
;
1310 /* options.module.itable.prefix = options.module.global.prefix; */
1311 options
.module
.semantics
.prefix
=
1312 options
.module
.global
.prefix
;
1313 options
.module
.support
.prefix
= options
.module
.global
.prefix
;
1315 if (name
== &options
.module
.global
.suffix
)
1317 options
.module
.engine
.suffix
= options
.module
.global
.suffix
;
1318 options
.module
.icache
.suffix
= options
.module
.global
.suffix
;
1319 options
.module
.idecode
.suffix
= options
.module
.global
.suffix
;
1320 /* options.module.itable.suffix = options.module.global.suffix; */
1321 options
.module
.semantics
.suffix
=
1322 options
.module
.global
.suffix
;
1323 options
.module
.support
.suffix
= options
.module
.global
.suffix
;
1330 if (strcmp (optarg
, "error") == 0)
1331 options
.warning
= error
;
1332 else if (strcmp (optarg
, "nodiscard") == 0)
1333 options
.warn
.discard
= 0;
1334 else if (strcmp (optarg
, "discard") == 0)
1335 options
.warn
.discard
= 1;
1336 else if (strcmp (optarg
, "nowidth") == 0)
1337 options
.warn
.width
= 0;
1338 else if (strcmp (optarg
, "width") == 0)
1339 options
.warn
.width
= 1;
1340 else if (strcmp (optarg
, "nounimplemented") == 0)
1341 options
.warn
.unimplemented
= 0;
1342 else if (strcmp (optarg
, "unimplemented") == 0)
1343 options
.warn
.unimplemented
= 1;
1345 error (NULL
, "Unknown -W argument `%s'\n", optarg
);
1354 if (strncmp (optarg
, "no-", strlen ("no-")) == 0)
1356 argp
= optarg
+ strlen ("no-");
1359 else if (strncmp (optarg
, "!", strlen ("!")) == 0)
1361 argp
= optarg
+ strlen ("no-");
1369 if (strcmp (argp
, "decode-duplicate") == 0)
1371 options
.decode
.duplicate
= enable_p
;
1373 else if (strcmp (argp
, "decode-combine") == 0)
1375 options
.decode
.combine
= enable_p
;
1377 else if (strcmp (argp
, "decode-zero-reserved") == 0)
1379 options
.decode
.zero_reserved
= enable_p
;
1382 else if (strcmp (argp
, "gen-conditional-issue") == 0)
1384 options
.gen
.conditional_issue
= enable_p
;
1386 else if (strcmp (argp
, "conditional-issue") == 0)
1388 options
.gen
.conditional_issue
= enable_p
;
1389 options
.warning (NULL
,
1390 "Option conditional-issue replaced by gen-conditional-issue\n");
1392 else if (strcmp (argp
, "gen-delayed-branch") == 0)
1394 options
.gen
.delayed_branch
= enable_p
;
1396 else if (strcmp (argp
, "delayed-branch") == 0)
1398 options
.gen
.delayed_branch
= enable_p
;
1399 options
.warning (NULL
,
1400 "Option delayed-branch replaced by gen-delayed-branch\n");
1402 else if (strcmp (argp
, "gen-direct-access") == 0)
1404 options
.gen
.direct_access
= enable_p
;
1406 else if (strcmp (argp
, "direct-access") == 0)
1408 options
.gen
.direct_access
= enable_p
;
1409 options
.warning (NULL
,
1410 "Option direct-access replaced by gen-direct-access\n");
1412 else if (strncmp (argp
, "gen-zero-r", strlen ("gen-zero-r")) == 0)
1414 options
.gen
.zero_reg
= enable_p
;
1415 options
.gen
.zero_reg_nr
= atoi (argp
+ strlen ("gen-zero-r"));
1417 else if (strncmp (argp
, "zero-r", strlen ("zero-r")) == 0)
1419 options
.gen
.zero_reg
= enable_p
;
1420 options
.gen
.zero_reg_nr
= atoi (argp
+ strlen ("zero-r"));
1421 options
.warning (NULL
,
1422 "Option zero-r<N> replaced by gen-zero-r<N>\n");
1424 else if (strncmp (argp
, "gen-icache", strlen ("gen-icache")) == 0)
1426 switch (argp
[strlen ("gen-icache")])
1429 options
.gen
.icache_size
=
1430 atoi (argp
+ strlen ("gen-icache") + 1);
1431 options
.gen
.icache
= enable_p
;
1434 options
.gen
.icache
= enable_p
;
1438 "Expecting -Ggen-icache or -Ggen-icache=<N>\n");
1441 else if (strcmp (argp
, "gen-insn-in-icache") == 0)
1443 options
.gen
.insn_in_icache
= enable_p
;
1445 else if (strncmp (argp
, "gen-multi-sim", strlen ("gen-multi-sim"))
1448 char *arg
= &argp
[strlen ("gen-multi-sim")];
1452 options
.gen
.multi_sim
= enable_p
;
1453 options
.gen
.default_model
= arg
+ 1;
1454 if (!filter_is_member
1455 (options
.model_filter
, options
.gen
.default_model
))
1456 error (NULL
, "multi-sim model %s unknown\n",
1457 options
.gen
.default_model
);
1460 options
.gen
.multi_sim
= enable_p
;
1461 options
.gen
.default_model
= NULL
;
1465 "Expecting -Ggen-multi-sim or -Ggen-multi-sim=<MODEL>\n");
1469 else if (strcmp (argp
, "gen-multi-word") == 0)
1471 options
.gen
.multi_word
= enable_p
;
1473 else if (strcmp (argp
, "gen-semantic-icache") == 0)
1475 options
.gen
.semantic_icache
= enable_p
;
1477 else if (strcmp (argp
, "gen-slot-verification") == 0)
1479 options
.gen
.slot_verification
= enable_p
;
1481 else if (strcmp (argp
, "verify-slot") == 0)
1483 options
.gen
.slot_verification
= enable_p
;
1484 options
.warning (NULL
,
1485 "Option verify-slot replaced by gen-slot-verification\n");
1487 else if (strcmp (argp
, "gen-nia-invalid") == 0)
1489 options
.gen
.nia
= nia_is_invalid
;
1491 else if (strcmp (argp
, "default-nia-minus-one") == 0)
1493 options
.gen
.nia
= nia_is_invalid
;
1494 options
.warning (NULL
,
1495 "Option default-nia-minus-one replaced by gen-nia-invalid\n");
1497 else if (strcmp (argp
, "gen-nia-void") == 0)
1499 options
.gen
.nia
= nia_is_void
;
1501 else if (strcmp (argp
, "trace-all") == 0)
1503 memset (&options
.trace
, enable_p
, sizeof (options
.trace
));
1505 else if (strcmp (argp
, "trace-combine") == 0)
1507 options
.trace
.combine
= enable_p
;
1509 else if (strcmp (argp
, "trace-entries") == 0)
1511 options
.trace
.entries
= enable_p
;
1513 else if (strcmp (argp
, "trace-rule-rejection") == 0)
1515 options
.trace
.rule_rejection
= enable_p
;
1517 else if (strcmp (argp
, "trace-rule-selection") == 0)
1519 options
.trace
.rule_selection
= enable_p
;
1521 else if (strcmp (argp
, "trace-insn-insertion") == 0)
1523 options
.trace
.insn_insertion
= enable_p
;
1525 else if (strcmp (argp
, "trace-insn-expansion") == 0)
1527 options
.trace
.insn_expansion
= enable_p
;
1529 else if (strcmp (argp
, "jumps") == 0)
1531 options
.gen
.code
= generate_jumps
;
1533 else if (strcmp (argp
, "field-widths") == 0)
1535 options
.insn_specifying_widths
= enable_p
;
1537 else if (strcmp (argp
, "omit-line-numbers") == 0)
1539 file_references
= lf_omit_references
;
1543 error (NULL
, "Unknown option %s\n", optarg
);
1549 isa
= load_insn_table (optarg
, cache_rules
);
1550 if (isa
->illegal_insn
== NULL
)
1551 error (NULL
, "illegal-instruction missing from insn table\n");
1555 gen
= do_gen (isa
, decode_rules
);
1559 decode_rules
= load_decode_table (optarg
);
1564 error (NULL
, "Cache file must appear before the insn file\n");
1565 cache_rules
= load_cache_table (optarg
);
1569 real_file_name
= strdup (optarg
);
1585 lf
*file
= lf_open (optarg
, real_file_name
, file_references
,
1586 (is_header
? lf_is_h
: lf_is_c
),
1588 if (gen
== NULL
&& ch
!= 't' && ch
!= 'm' && ch
!= 'f')
1590 options
.warning (NULL
,
1591 "Explicitly generate tables with -x option\n");
1592 gen
= do_gen (isa
, decode_rules
);
1594 lf_print__file_start (file
);
1599 gen_model_h (file
, isa
);
1601 gen_model_c (file
, isa
);
1605 gen_itable_h (file
, isa
);
1607 gen_itable_c (file
, isa
);
1611 gen_support_h (file
, isa
);
1613 gen_support_c (file
, isa
);
1617 options
.warning (NULL
, "-hr option ignored\n");
1619 gen_run_c (file
, gen
);
1623 gen_semantics_h (file
, gen
->semantics
, isa
->max_nr_words
);
1625 gen_semantics_c (file
, gen
->semantics
, isa
->caches
);
1629 gen_idecode_h (file
, gen
, isa
, cache_rules
);
1631 gen_idecode_c (file
, gen
, isa
, cache_rules
);
1635 gen_engine_h (file
, gen
, isa
, cache_rules
);
1637 gen_engine_c (file
, gen
, isa
, cache_rules
);
1643 isa
->functions
, isa
->max_nr_words
);
1646 gen
->semantics
, isa
->functions
, cache_rules
);
1649 lf_print__file_finish (file
);
1653 real_file_name
= NULL
;
1656 ERROR ("Bad switch");