1 /* The IGEN simulator generator for GDB, the GNU Debugger.
3 Copyright 2002-2024 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
, const 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 const 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
,
286 const opcode_bits
*expanded_bits
)
288 /* #define MY_INDEX xxxxx */
289 lf_indent_suppress (file
);
290 lf_printf (file
, "#undef MY_INDEX\n");
291 lf_indent_suppress (file
);
292 lf_printf (file
, "#define MY_INDEX ");
293 print_function_name (file
,
294 basename
, format_name
, NULL
,
295 NULL
, function_name_prefix_itable
);
296 lf_printf (file
, "\n");
297 /* #define MY_PREFIX xxxxxx */
298 lf_indent_suppress (file
);
299 lf_printf (file
, "#undef ");
300 print_function_name (file
,
301 basename
, format_name
, NULL
,
302 expanded_bits
, function_name_prefix_none
);
303 lf_printf (file
, "\n");
304 lf_indent_suppress (file
);
305 lf_printf (file
, "#undef MY_PREFIX\n");
306 lf_indent_suppress (file
);
307 lf_printf (file
, "#define MY_PREFIX ");
308 print_function_name (file
,
309 basename
, format_name
, NULL
,
310 expanded_bits
, function_name_prefix_none
);
311 lf_printf (file
, "\n");
312 /* #define MY_NAME xxxxxx */
313 lf_indent_suppress (file
);
314 lf_indent_suppress (file
);
315 lf_printf (file
, "#undef MY_NAME\n");
316 lf_indent_suppress (file
);
317 lf_printf (file
, "#define MY_NAME \"");
318 print_function_name (file
,
319 basename
, format_name
, NULL
,
320 expanded_bits
, function_name_prefix_none
);
321 lf_printf (file
, "\"\n");
326 print_itrace_prefix (lf
*file
)
328 const char *prefix
= "trace_prefix (";
329 int indent
= strlen (prefix
);
330 lf_printf (file
, "%sSD, CPU, cia, CIA, TRACE_LINENUM_P (CPU), \\\n",
332 lf_indent (file
, +indent
);
333 lf_printf (file
, "%sitable[MY_INDEX].file, \\\n",
334 options
.module
.itable
.prefix
.l
);
335 lf_printf (file
, "%sitable[MY_INDEX].line_nr, \\\n",
336 options
.module
.itable
.prefix
.l
);
337 lf_printf (file
, "\"");
343 print_itrace_format (lf
*file
, const insn_mnemonic_entry
*assembler
)
345 /* pass=1 is fmt string; pass=2 is arguments */
347 /* print the format string */
348 for (pass
= 1; pass
<= 2; pass
++)
350 const char *chp
= assembler
->format
;
351 chp
++; /* skip the leading quote */
352 /* write out the format/args */
355 if (chp
[0] == '\\' && (chp
[1] == '<' || chp
[1] == '>'))
358 lf_putchr (file
, chp
[1]);
361 else if (chp
[0] == '<' || chp
[0] == '%')
363 /* parse [ "%" ... ] "<" [ func "#" ] param ">" */
369 /* the "%" ... "<" format */
371 while (chp
[0] != '<' && chp
[0] != '\0')
374 error (assembler
->line
, "Missing `<' after `%%'\n");
376 /* [ "func" # ] OR "param" */
379 while (chp
[0] != '>' && chp
[0] != '#' && chp
[0] != '\0')
381 strlen_func
= chp
- func
;
386 while (chp
[0] != '>' && chp
[0] != '\0')
389 strlen_param
= chp
- param
;
391 error (assembler
->line
,
392 "Missing closing `>' in assembler string\n");
396 lf_printf (file
, ", \\\n");
397 if (strncmp (fmt
, "<", 1) == 0)
398 /* implicit long int format */
401 lf_printf (file
, "%%ld");
404 lf_printf (file
, "(long) ");
405 lf_write (file
, param
, strlen_param
);
408 else if (strncmp (fmt
, "%<", 2) == 0)
409 /* explicit format */
412 lf_printf (file
, "%%");
414 lf_write (file
, param
, strlen_param
);
416 else if (strncmp (fmt
, "%s<", 3) == 0)
420 lf_printf (file
, "%%s");
423 lf_printf (file
, "%sstr_",
424 options
.module
.global
.prefix
.l
);
425 lf_write (file
, func
, strlen_func
);
426 lf_printf (file
, " (SD_, ");
427 lf_write (file
, param
, strlen_param
);
428 lf_printf (file
, ")");
431 else if (strncmp (fmt
, "%lx<", 4) == 0)
435 lf_printf (file
, "%%lx");
438 lf_printf (file
, "(unsigned long) ");
439 lf_write (file
, param
, strlen_param
);
442 else if (strncmp (fmt
, "%#lx<", 5) == 0)
443 /* simple hex with 0x prefix */
446 lf_printf (file
, "%%#lx");
449 lf_printf (file
, "(unsigned long) ");
450 lf_write (file
, param
, strlen_param
);
453 else if (strncmp (fmt
, "%08lx<", 6) == 0)
457 lf_printf (file
, "%%08lx");
460 lf_printf (file
, "(unsigned long) ");
461 lf_write (file
, param
, strlen_param
);
465 error (assembler
->line
, "Unknown assembler string format\n");
470 lf_putchr (file
, chp
[0]);
475 lf_printf (file
, ");\n");
480 print_itrace (lf
*file
, const insn_entry
*insn
, int idecode
)
482 /* NB: Here we escape each EOLN. This is so that the the compiler
483 treats a trace function call as a single line. Consequently any
484 errors in the line are referred back to the same igen assembler
486 const char *phase
= (idecode
) ? "DECODE" : "INSN";
487 lf_printf (file
, "\n");
488 lf_indent_suppress (file
);
489 lf_printf (file
, "#if defined (WITH_TRACE)\n");
490 lf_printf (file
, "/* generate a trace prefix if any tracing enabled */\n");
491 lf_printf (file
, "if (TRACE_ANY_P (CPU))\n");
492 lf_printf (file
, " {\n");
493 lf_indent (file
, +4);
495 if (insn
->mnemonics
!= NULL
)
497 insn_mnemonic_entry
*assembler
= insn
->mnemonics
;
501 if (assembler
->condition
!= NULL
)
504 lf_printf (file
, "%sif (%s)\n",
505 is_first
? "" : "else ", assembler
->condition
);
506 lf_indent (file
, +2);
507 lf_print__line_ref (file
, assembler
->line
);
508 indent
= print_itrace_prefix (file
);
509 print_itrace_format (file
, assembler
);
510 lf_print__internal_ref (file
);
511 lf_indent (file
, -indent
);
512 lf_indent (file
, -2);
513 if (assembler
->next
== NULL
)
514 error (assembler
->line
,
515 "Missing final unconditional assembler\n");
522 lf_printf (file
, "else\n");
523 lf_indent (file
, +2);
525 lf_print__line_ref (file
, assembler
->line
);
526 indent
= print_itrace_prefix (file
);
527 print_itrace_format (file
, assembler
);
528 lf_print__internal_ref (file
);
529 lf_indent (file
, -indent
);
531 lf_indent (file
, -2);
532 if (assembler
->next
!= NULL
)
533 error (assembler
->line
,
534 "Unconditional assembler is not last\n");
537 assembler
= assembler
->next
;
539 while (assembler
!= NULL
);
544 lf_indent (file
, +2);
545 lf_print__line_ref (file
, insn
->line
);
546 indent
= print_itrace_prefix (file
);
547 lf_printf (file
, "%%s\", \\\n");
548 lf_printf (file
, "itable[MY_INDEX].name);\n");
549 lf_print__internal_ref (file
);
550 lf_indent (file
, -indent
);
551 lf_indent (file
, -2);
553 lf_printf (file
, "/* trace the instruction execution if enabled */\n");
554 lf_printf (file
, "if (TRACE_%s_P (CPU))\n", phase
);
556 " trace_generic (SD, CPU, TRACE_%s_IDX, \" %%s\", itable[MY_INDEX].name);\n",
559 lf_indent (file
, -4);
560 lf_printf (file
, " }\n");
561 lf_indent_suppress (file
);
562 lf_printf (file
, "#endif\n");
567 print_sim_engine_abort (lf
*file
, const char *message
)
569 lf_printf (file
, "sim_engine_abort (SD, CPU, cia, ");
570 lf_printf (file
, "\"%s\"", message
);
571 lf_printf (file
, ");\n");
576 print_include (lf
*file
, igen_module module
)
578 lf_printf (file
, "#include \"%s%s.h\"\n", module
.prefix
.l
, module
.suffix
.l
);
582 print_include_inline (lf
*file
, igen_module module
)
584 lf_printf (file
, "#if C_REVEALS_MODULE_P (%s_INLINE)\n", module
.suffix
.u
);
585 lf_printf (file
, "#include \"%s%s.c\"\n", module
.prefix
.l
, module
.suffix
.l
);
586 lf_printf (file
, "#else\n");
587 print_include (file
, module
);
588 lf_printf (file
, "#endif\n");
589 lf_printf (file
, "\n");
593 print_includes (lf
*file
)
595 lf_printf (file
, "\n");
596 lf_printf (file
, "#include \"sim-inline.c\"\n");
597 lf_printf (file
, "\n");
598 print_include_inline (file
, options
.module
.itable
);
599 print_include_inline (file
, options
.module
.idecode
);
600 print_include_inline (file
, options
.module
.support
);
604 /****************************************************************/
608 gen_semantics_h (lf
*file
, const insn_list
*semantics
, int max_nr_words
)
611 const insn_list
*semantic
;
612 for (word_nr
= -1; word_nr
<= max_nr_words
; word_nr
++)
614 lf_printf (file
, "typedef ");
615 print_semantic_function_type (file
);
616 lf_printf (file
, " %sidecode_semantic", options
.module
.global
.prefix
.l
);
618 lf_printf (file
, "_%d", word_nr
);
619 lf_printf (file
, "\n(");
620 lf_indent (file
, +1);
621 print_semantic_function_formal (file
, word_nr
);
622 lf_indent (file
, -1);
623 lf_printf (file
, ");\n");
624 lf_printf (file
, "\n");
626 switch (options
.gen
.code
)
629 for (semantic
= semantics
; semantic
!= NULL
; semantic
= semantic
->next
)
631 /* Ignore any special/internal instructions */
632 if (semantic
->insn
->nr_words
== 0)
634 print_semantic_declaration (file
,
636 semantic
->expanded_bits
,
638 semantic
->nr_prefetched_words
);
642 lf_print__this_file_is_empty (file
, "generating jumps");
649 gen_semantics_c (lf
*file
, const insn_list
*semantics
, cache_entry
*cache_rules
)
651 if (options
.gen
.code
== generate_calls
)
653 const insn_list
*semantic
;
654 print_includes (file
);
655 print_include (file
, options
.module
.semantics
);
656 lf_printf (file
, "\n");
658 for (semantic
= semantics
; semantic
!= NULL
; semantic
= semantic
->next
)
660 /* Ignore any special/internal instructions */
661 if (semantic
->insn
->nr_words
== 0)
663 print_semantic_definition (file
,
665 semantic
->expanded_bits
,
668 semantic
->nr_prefetched_words
);
673 lf_print__this_file_is_empty (file
, "generating jump engine");
678 /****************************************************************/
682 gen_icache_h (lf
*file
,
683 const insn_list
*semantic
,
684 const function_entry
*functions
, int max_nr_words
)
687 for (word_nr
= 0; word_nr
<= max_nr_words
; word_nr
++)
689 lf_printf (file
, "typedef ");
690 print_icache_function_type (file
);
691 lf_printf (file
, " %sidecode_icache_%d\n(",
692 options
.module
.global
.prefix
.l
, word_nr
);
693 print_icache_function_formal (file
, word_nr
);
694 lf_printf (file
, ");\n");
695 lf_printf (file
, "\n");
697 if (options
.gen
.code
== generate_calls
&& options
.gen
.icache
)
699 function_entry_traverse (file
, functions
,
700 print_icache_internal_function_declaration
,
702 while (semantic
!= NULL
)
704 print_icache_declaration (file
,
706 semantic
->expanded_bits
,
708 semantic
->nr_prefetched_words
);
709 semantic
= semantic
->next
;
714 lf_print__this_file_is_empty (file
, "generating jump engine");
719 gen_icache_c (lf
*file
,
720 const insn_list
*semantic
,
721 const function_entry
*functions
, cache_entry
*cache_rules
)
723 /* output `internal' invalid/floating-point unavailable functions
725 if (options
.gen
.code
== generate_calls
&& options
.gen
.icache
)
727 lf_printf (file
, "\n");
728 lf_printf (file
, "#include \"cpu.h\"\n");
729 lf_printf (file
, "#include \"idecode.h\"\n");
730 lf_printf (file
, "#include \"semantics.h\"\n");
731 lf_printf (file
, "#include \"icache.h\"\n");
732 lf_printf (file
, "#include \"support.h\"\n");
733 lf_printf (file
, "\n");
734 function_entry_traverse (file
, functions
,
735 print_icache_internal_function_definition
,
737 lf_printf (file
, "\n");
738 while (semantic
!= NULL
)
740 print_icache_definition (file
,
742 semantic
->expanded_bits
,
745 semantic
->nr_prefetched_words
);
746 semantic
= semantic
->next
;
751 lf_print__this_file_is_empty (file
, "generating jump engine");
756 /****************************************************************/
760 gen_idecode_h (lf
*file
,
761 const gen_table
*gen
,
762 const insn_table
*insns
,
763 cache_entry
*cache_rules
)
765 lf_printf (file
, "typedef uint%d_t %sinstruction_word;\n",
766 options
.insn_bit_size
, options
.module
.global
.prefix
.l
);
767 if (options
.gen
.delayed_branch
)
769 lf_printf (file
, "typedef struct _%sinstruction_address {\n",
770 options
.module
.global
.prefix
.l
);
771 lf_printf (file
, " address_word ip; /* instruction pointer */\n");
772 lf_printf (file
, " address_word dp; /* delayed-slot pointer */\n");
773 lf_printf (file
, "} %sinstruction_address;\n",
774 options
.module
.global
.prefix
.l
);
778 lf_printf (file
, "typedef address_word %sinstruction_address;\n",
779 options
.module
.global
.prefix
.l
);
782 if (options
.gen
.nia
== nia_is_invalid
783 && strlen (options
.module
.global
.prefix
.u
) > 0)
785 lf_indent_suppress (file
);
786 lf_printf (file
, "#define %sINVALID_INSTRUCTION_ADDRESS ",
787 options
.module
.global
.prefix
.u
);
788 lf_printf (file
, "INVALID_INSTRUCTION_ADDRESS\n");
790 lf_printf (file
, "\n");
791 print_icache_struct (file
, insns
, cache_rules
);
792 lf_printf (file
, "\n");
793 if (options
.gen
.icache
)
795 ERROR ("FIXME - idecode with icache suffering from bit-rot");
800 for (entry
= gen
->tables
; entry
!= NULL
; entry
= entry
->next
)
802 print_idecode_issue_function_header (file
,
803 (options
.gen
.multi_sim
806 is_function_declaration
,
807 1 /*ALWAYS ONE WORD */ );
809 if (options
.gen
.multi_sim
)
811 print_idecode_issue_function_header (file
,
813 is_function_variable
,
814 1 /*ALWAYS ONE WORD */ );
821 gen_idecode_c (lf
*file
,
822 const gen_table
*gen
,
823 const insn_table
*isa
,
824 cache_entry
*cache_rules
)
827 print_includes (file
);
828 print_include_inline (file
, options
.module
.semantics
);
829 lf_printf (file
, "\n");
831 print_idecode_globals (file
);
832 lf_printf (file
, "\n");
834 switch (options
.gen
.code
)
839 for (entry
= gen
->tables
; entry
!= NULL
; entry
= entry
->next
)
841 print_idecode_lookups (file
, entry
->table
, cache_rules
);
843 /* output the main idecode routine */
844 if (!options
.gen
.icache
)
846 print_idecode_issue_function_header (file
,
847 (options
.gen
.multi_sim
850 1 /*is definition */ ,
851 1 /*ALWAYS ONE WORD */ );
852 lf_printf (file
, "{\n");
853 lf_indent (file
, +2);
854 lf_printf (file
, "%sinstruction_address nia;\n",
855 options
.module
.global
.prefix
.l
);
856 print_idecode_body (file
, entry
->table
, "nia =");
857 lf_printf (file
, "return nia;");
858 lf_indent (file
, -2);
859 lf_printf (file
, "}\n");
866 lf_print__this_file_is_empty (file
, "generating a jump engine");
873 /****************************************************************/
877 gen_run_c (lf
*file
, const gen_table
*gen
)
880 lf_printf (file
, "#include \"sim-main.h\"\n");
881 lf_printf (file
, "#include \"engine.h\"\n");
882 lf_printf (file
, "#include \"idecode.h\"\n");
883 lf_printf (file
, "#include \"bfd.h\"\n");
884 lf_printf (file
, "\n");
886 if (options
.gen
.multi_sim
)
888 print_idecode_issue_function_header (file
, NULL
, is_function_variable
,
890 lf_printf (file
, "\n");
891 print_engine_run_function_header (file
, NULL
, is_function_variable
);
892 lf_printf (file
, "\n");
895 lf_printf (file
, "void\n");
896 lf_printf (file
, "sim_engine_run (SIM_DESC sd,\n");
897 lf_printf (file
, " int next_cpu_nr,\n");
898 lf_printf (file
, " int nr_cpus,\n");
899 lf_printf (file
, " int siggnal)\n");
900 lf_printf (file
, "{\n");
901 lf_indent (file
, +2);
902 if (options
.gen
.multi_sim
)
904 lf_printf (file
, "int mach;\n");
905 lf_printf (file
, "if (STATE_ARCHITECTURE (sd) == NULL)\n");
906 lf_printf (file
, " mach = 0;\n");
907 lf_printf (file
, "else\n");
908 lf_printf (file
, " mach = STATE_ARCHITECTURE (sd)->mach;\n");
909 lf_printf (file
, "switch (mach)\n");
910 lf_printf (file
, " {\n");
911 lf_indent (file
, +2);
912 for (entry
= gen
->tables
; entry
!= NULL
; entry
= entry
->next
)
914 if (options
.gen
.default_model
!= NULL
915 && (strcmp (entry
->model
->name
, options
.gen
.default_model
) == 0
916 || strcmp (entry
->model
->full_name
,
917 options
.gen
.default_model
) == 0))
918 lf_printf (file
, "default:\n");
919 lf_printf (file
, "case bfd_mach_%s:\n", entry
->model
->full_name
);
920 lf_indent (file
, +2);
921 print_function_name (file
, "issue", NULL
, /* format name */
922 NULL
, /* NO processor */
923 NULL
, /* expanded bits */
924 function_name_prefix_idecode
);
925 lf_printf (file
, " = ");
926 print_function_name (file
, "issue", NULL
, /* format name */
927 entry
->model
->name
, NULL
, /* expanded bits */
928 function_name_prefix_idecode
);
929 lf_printf (file
, ";\n");
930 print_function_name (file
, "run", NULL
, /* format name */
931 NULL
, /* NO processor */
932 NULL
, /* expanded bits */
933 function_name_prefix_engine
);
934 lf_printf (file
, " = ");
935 print_function_name (file
, "run", NULL
, /* format name */
936 entry
->model
->name
, NULL
, /* expanded bits */
937 function_name_prefix_engine
);
938 lf_printf (file
, ";\n");
939 lf_printf (file
, "break;\n");
940 lf_indent (file
, -2);
942 if (options
.gen
.default_model
== NULL
)
944 lf_printf (file
, "default:\n");
945 lf_indent (file
, +2);
946 lf_printf (file
, "sim_engine_abort (sd, NULL, NULL_CIA,\n");
948 " \"sim_engine_run - unknown machine\");\n");
949 lf_printf (file
, "break;\n");
950 lf_indent (file
, -2);
952 lf_indent (file
, -2);
953 lf_printf (file
, " }\n");
955 print_function_name (file
, "run", NULL
, /* format name */
956 NULL
, /* NO processor */
957 NULL
, /* expanded bits */
958 function_name_prefix_engine
);
959 lf_printf (file
, " (sd, next_cpu_nr, nr_cpus, siggnal);\n");
960 lf_indent (file
, -2);
961 lf_printf (file
, "}\n");
964 /****************************************************************/
967 do_gen (const insn_table
*isa
, const decode_table
*decode_rules
)
970 if (decode_rules
== NULL
)
971 error (NULL
, "Must specify a decode table\n");
973 error (NULL
, "Must specify an instruction table\n");
974 if (decode_table_max_word_nr (decode_rules
) > 0)
975 options
.gen
.multi_word
= decode_table_max_word_nr (decode_rules
);
976 gen
= make_gen_tables (isa
, decode_rules
);
977 gen_tables_expand_insns (gen
);
978 gen_tables_expand_semantics (gen
);
982 /****************************************************************/
984 igen_options options
;
987 main (int argc
, char **argv
, char **envp
)
989 cache_entry
*cache_rules
= NULL
;
990 lf_file_references file_references
= lf_include_references
;
991 decode_table
*decode_rules
= NULL
;
992 insn_table
*isa
= NULL
;
993 gen_table
*gen
= NULL
;
994 char *real_file_name
= NULL
;
997 static const struct option longopts
[] = { { 0 } };
999 lf_open ("-", "stdout", lf_omit_references
, lf_is_text
, "igen");
1005 printf ("Usage:\n");
1007 printf (" igen <config-opts> ... <input-opts>... <output-opts>...\n");
1009 printf ("Config options:\n");
1011 printf (" -B <bit-size>\n");
1012 printf ("\t Set the number of bits in an instruction (deprecated).\n");
1014 ("\t This option can now be set directly in the instruction table.\n");
1016 printf (" -D <data-structure>\n");
1018 ("\t Dump the specified data structure to stdout. Valid structures include:\n");
1020 ("\t processor-names - list the names of all the processors (models)\n");
1022 printf (" -F <filter-list>\n");
1024 ("\t Filter out any instructions with a non-empty flags field that contains\n");
1025 printf ("\t a flag not listed in the <filter-list>.\n");
1027 printf (" -H <high-bit>\n");
1029 ("\t Set the number of the high (most significant) instruction bit (deprecated).\n");
1031 ("\t This option can now be set directly in the instruction table.\n");
1033 printf (" -I <directory>\n");
1035 ("\t Add <directory> to the list of directories searched when opening a file\n");
1037 printf (" -M <model-list>\n");
1039 ("\t Filter out any instructions that do not support at least one of the listed\n");
1041 ("\t models (An instructions with no model information is considered to support\n");
1042 printf ("\t all models.).\n");
1044 printf (" -N <nr-cpus>\n");
1045 printf ("\t Generate a simulator supporting <nr-cpus>\n");
1047 ("\t Specify `-N 0' to disable generation of the SMP. Specifying `-N 1' will\n");
1049 ("\t still generate an SMP enabled simulator but will only support one CPU.\n");
1051 printf (" -T <mechanism>\n");
1053 ("\t Override the decode mechanism specified by the decode rules\n");
1055 printf (" -P <prefix>\n");
1057 ("\t Prepend global names (except itable) with the string <prefix>.\n");
1059 ("\t Specify -P <module>=<prefix> to set a specific <module>'s prefix.\n");
1061 printf (" -S <suffix>\n");
1063 ("\t Replace a global name (suffix) (except itable) with the string <suffix>.\n");
1065 ("\t Specify -S <module>=<suffix> to change a specific <module>'s name (suffix).\n");
1067 printf (" -Werror\n");
1068 printf ("\t Make warnings errors\n");
1069 printf (" -Wnodiscard\n");
1071 ("\t Suppress warnings about discarded functions and instructions\n");
1072 printf (" -Wnowidth\n");
1074 ("\t Suppress warnings about instructions with invalid widths\n");
1075 printf (" -Wnounimplemented\n");
1076 printf ("\t Suppress warnings about unimplemented instructions\n");
1078 printf (" -G [!]<gen-option>\n");
1079 printf ("\t Any of the following options:\n");
1082 ("\t decode-duplicate - Override the decode rules, forcing the duplication of\n");
1083 printf ("\t semantic functions\n");
1085 ("\t decode-combine - Combine any duplicated entries within a table\n");
1087 ("\t decode-zero-reserved - Override the decode rules, forcing reserved bits to be\n");
1088 printf ("\t treated as zero.\n");
1090 ("\t decode-switch-is-goto - Overfide the padded-switch code type as a goto-switch\n");
1093 ("\t gen-conditional-issue - conditionally issue each instruction\n");
1095 ("\t gen-delayed-branch - need both cia and nia passed around\n");
1097 ("\t gen-direct-access - use #defines to directly access values\n");
1099 ("\t gen-zero-r<N> - arch assumes GPR(<N>) == 0, keep it that way\n");
1101 ("\t gen-icache[=<N> - generate an instruction cracking cache of size <N>\n");
1102 printf ("\t Default size is %d\n",
1103 options
.gen
.icache_size
);
1105 ("\t gen-insn-in-icache - save original instruction when cracking\n");
1107 ("\t gen-multi-sim[=MODEL] - generate multiple simulators - one per model\n");
1109 ("\t If specified MODEL is made the default architecture.\n");
1111 ("\t By default, a single simulator that will\n");
1113 ("\t execute any instruction is generated\n");
1115 ("\t gen-multi-word - generate code allowing for multi-word insns\n");
1117 ("\t gen-semantic-icache - include semantic code in cracking functions\n");
1119 ("\t gen-slot-verification - perform slot verification as part of decode\n");
1120 printf ("\t gen-nia-invalid - NIA defaults to nia_invalid\n");
1121 printf ("\t gen-nia-void - do not compute/return NIA\n");
1124 ("\t trace-combine - report combined entries a rule application\n");
1126 ("\t trace-entries - report entries after a rules application\n");
1127 printf ("\t trace-rule-rejection - report each rule as rejected\n");
1128 printf ("\t trace-rule-selection - report each rule as selected\n");
1130 ("\t trace-insn-insertion - report each instruction as it is inserted into a decode table\n");
1132 ("\t trace-rule-expansion - report each instruction as it is expanded (before insertion into a decode table)\n");
1133 printf ("\t trace-all - enable all trace options\n");
1136 ("\t field-widths - instruction formats specify widths (deprecated)\n");
1138 ("\t By default, an instruction format specifies bit\n");
1139 printf ("\t positions\n");
1141 ("\t This option can now be set directly in the\n");
1142 printf ("\t instruction table\n");
1144 ("\t jumps - use jumps instead of function calls\n");
1146 ("\t omit-line-numbers - do not include line number information in the output\n");
1148 printf ("Input options:\n");
1150 printf (" -k <cache-rules> (deprecated)\n");
1151 printf (" -o <decode-rules>\n");
1152 printf (" -i <instruction-table>\n");
1154 printf ("Output options:\n");
1156 printf (" -x Perform expansion (required)\n");
1158 (" -n <real-name> Specify the real name of the next output file\n");
1160 (" -h Generate the header (.h) file rather than the body (.c)\n");
1161 printf (" -c <output-file> output icache\n");
1162 printf (" -d <output-file> output idecode\n");
1163 printf (" -e <output-file> output engine\n");
1164 printf (" -f <output-file> output support functions\n");
1165 printf (" -m <output-file> output model\n");
1166 printf (" -r <output-file> output multi-sim run\n");
1167 printf (" -s <output-file> output schematic\n");
1168 printf (" -t <output-file> output itable\n");
1171 while ((ch
= getopt_long (argc
, argv
,
1172 "B:D:F:G:H:I:M:N:P:T:W:o:k:i:n:hc:d:e:m:r:s:t:f:x",
1176 #if 0 /* For debugging. */
1177 fprintf (stderr
, " -%c ", ch
);
1179 fprintf (stderr
, "%s ", optarg
);
1180 fprintf (stderr
, "\\\n");
1187 filter_parse (&options
.model_filter
, optarg
);
1191 if (strcmp (optarg
, "processor-names"))
1193 const char *processor
;
1194 for (processor
= filter_next (options
.model_filter
, "");
1196 processor
= filter_next (options
.model_filter
, processor
))
1197 lf_printf (standard_out
, "%s\n", processor
);
1200 error (NULL
, "Unknown data structure %s, not dumped\n", optarg
);
1204 filter_parse (&options
.flags_filter
, optarg
);
1209 table_include
**dir
= &options
.include
;
1210 while ((*dir
) != NULL
)
1211 dir
= &(*dir
)->next
;
1212 (*dir
) = ZALLOC (table_include
);
1213 (*dir
)->dir
= strdup (optarg
);
1218 options
.insn_bit_size
= a2i (optarg
);
1219 if (options
.insn_bit_size
<= 0
1220 || options
.insn_bit_size
> max_insn_bit_size
)
1222 error (NULL
, "Instruction bitsize must be in range 1..%d\n",
1225 if (options
.hi_bit_nr
!= options
.insn_bit_size
- 1
1226 && options
.hi_bit_nr
!= 0)
1228 error (NULL
, "Conflict betweem hi-bit-nr and insn-bit-size\n");
1233 options
.hi_bit_nr
= a2i (optarg
);
1234 if (options
.hi_bit_nr
!= options
.insn_bit_size
- 1
1235 && options
.hi_bit_nr
!= 0)
1237 error (NULL
, "Conflict between hi-bit-nr and insn-bit-size\n");
1242 options
.gen
.smp
= a2i (optarg
);
1251 chp
= strchr (optarg
, '=');
1254 names
= &options
.module
.global
;
1259 chp
= chp
+ 1; /* skip `=' */
1261 if (strncmp (optarg
, "global=", chp
- optarg
) == 0)
1263 names
= &options
.module
.global
;
1265 if (strncmp (optarg
, "engine=", chp
- optarg
) == 0)
1267 names
= &options
.module
.engine
;
1269 if (strncmp (optarg
, "icache=", chp
- optarg
) == 0)
1271 names
= &options
.module
.icache
;
1273 if (strncmp (optarg
, "idecode=", chp
- optarg
) == 0)
1275 names
= &options
.module
.idecode
;
1277 if (strncmp (optarg
, "itable=", chp
- optarg
) == 0)
1279 names
= &options
.module
.itable
;
1281 if (strncmp (optarg
, "semantics=", chp
- optarg
) == 0)
1283 names
= &options
.module
.semantics
;
1285 if (strncmp (optarg
, "support=", chp
- optarg
) == 0)
1287 names
= &options
.module
.support
;
1291 error (NULL
, "Prefix `%s' unreconized\n", optarg
);
1297 name
= &names
->prefix
;
1300 name
= &names
->suffix
;
1303 abort (); /* Bad switch. */
1305 name
->u
= strdup (chp
);
1306 name
->l
= strdup (chp
);
1311 *chp
= toupper (*chp
);
1314 if (name
== &options
.module
.global
.prefix
)
1316 options
.module
.engine
.prefix
= options
.module
.global
.prefix
;
1317 options
.module
.icache
.prefix
= options
.module
.global
.prefix
;
1318 options
.module
.idecode
.prefix
= options
.module
.global
.prefix
;
1319 /* options.module.itable.prefix = options.module.global.prefix; */
1320 options
.module
.semantics
.prefix
=
1321 options
.module
.global
.prefix
;
1322 options
.module
.support
.prefix
= options
.module
.global
.prefix
;
1324 if (name
== &options
.module
.global
.suffix
)
1326 options
.module
.engine
.suffix
= options
.module
.global
.suffix
;
1327 options
.module
.icache
.suffix
= options
.module
.global
.suffix
;
1328 options
.module
.idecode
.suffix
= options
.module
.global
.suffix
;
1329 /* options.module.itable.suffix = options.module.global.suffix; */
1330 options
.module
.semantics
.suffix
=
1331 options
.module
.global
.suffix
;
1332 options
.module
.support
.suffix
= options
.module
.global
.suffix
;
1339 if (strcmp (optarg
, "error") == 0)
1340 options
.warning
= error
;
1341 else if (strcmp (optarg
, "nodiscard") == 0)
1342 options
.warn
.discard
= 0;
1343 else if (strcmp (optarg
, "discard") == 0)
1344 options
.warn
.discard
= 1;
1345 else if (strcmp (optarg
, "nowidth") == 0)
1346 options
.warn
.width
= 0;
1347 else if (strcmp (optarg
, "width") == 0)
1348 options
.warn
.width
= 1;
1349 else if (strcmp (optarg
, "nounimplemented") == 0)
1350 options
.warn
.unimplemented
= 0;
1351 else if (strcmp (optarg
, "unimplemented") == 0)
1352 options
.warn
.unimplemented
= 1;
1354 error (NULL
, "Unknown -W argument `%s'\n", optarg
);
1363 if (strncmp (optarg
, "no-", strlen ("no-")) == 0)
1365 argp
= optarg
+ strlen ("no-");
1368 else if (strncmp (optarg
, "!", strlen ("!")) == 0)
1370 argp
= optarg
+ strlen ("no-");
1378 if (strcmp (argp
, "decode-duplicate") == 0)
1380 options
.decode
.duplicate
= enable_p
;
1382 else if (strcmp (argp
, "decode-combine") == 0)
1384 options
.decode
.combine
= enable_p
;
1386 else if (strcmp (argp
, "decode-zero-reserved") == 0)
1388 options
.decode
.zero_reserved
= enable_p
;
1391 else if (strcmp (argp
, "gen-conditional-issue") == 0)
1393 options
.gen
.conditional_issue
= enable_p
;
1395 else if (strcmp (argp
, "conditional-issue") == 0)
1397 options
.gen
.conditional_issue
= enable_p
;
1398 options
.warning (NULL
,
1399 "Option conditional-issue replaced by gen-conditional-issue\n");
1401 else if (strcmp (argp
, "gen-delayed-branch") == 0)
1403 options
.gen
.delayed_branch
= enable_p
;
1405 else if (strcmp (argp
, "delayed-branch") == 0)
1407 options
.gen
.delayed_branch
= enable_p
;
1408 options
.warning (NULL
,
1409 "Option delayed-branch replaced by gen-delayed-branch\n");
1411 else if (strcmp (argp
, "gen-direct-access") == 0)
1413 options
.gen
.direct_access
= enable_p
;
1415 else if (strcmp (argp
, "direct-access") == 0)
1417 options
.gen
.direct_access
= enable_p
;
1418 options
.warning (NULL
,
1419 "Option direct-access replaced by gen-direct-access\n");
1421 else if (strncmp (argp
, "gen-zero-r", strlen ("gen-zero-r")) == 0)
1423 options
.gen
.zero_reg
= enable_p
;
1424 options
.gen
.zero_reg_nr
= atoi (argp
+ strlen ("gen-zero-r"));
1426 else if (strncmp (argp
, "zero-r", strlen ("zero-r")) == 0)
1428 options
.gen
.zero_reg
= enable_p
;
1429 options
.gen
.zero_reg_nr
= atoi (argp
+ strlen ("zero-r"));
1430 options
.warning (NULL
,
1431 "Option zero-r<N> replaced by gen-zero-r<N>\n");
1433 else if (strncmp (argp
, "gen-icache", strlen ("gen-icache")) == 0)
1435 switch (argp
[strlen ("gen-icache")])
1438 options
.gen
.icache_size
=
1439 atoi (argp
+ strlen ("gen-icache") + 1);
1440 options
.gen
.icache
= enable_p
;
1443 options
.gen
.icache
= enable_p
;
1447 "Expecting -Ggen-icache or -Ggen-icache=<N>\n");
1450 else if (strcmp (argp
, "gen-insn-in-icache") == 0)
1452 options
.gen
.insn_in_icache
= enable_p
;
1454 else if (strncmp (argp
, "gen-multi-sim", strlen ("gen-multi-sim"))
1457 char *arg
= &argp
[strlen ("gen-multi-sim")];
1461 options
.gen
.multi_sim
= enable_p
;
1462 options
.gen
.default_model
= arg
+ 1;
1463 if (!filter_is_member
1464 (options
.model_filter
, options
.gen
.default_model
))
1465 error (NULL
, "multi-sim model %s unknown\n",
1466 options
.gen
.default_model
);
1469 options
.gen
.multi_sim
= enable_p
;
1470 options
.gen
.default_model
= NULL
;
1474 "Expecting -Ggen-multi-sim or -Ggen-multi-sim=<MODEL>\n");
1478 else if (strcmp (argp
, "gen-multi-word") == 0)
1480 options
.gen
.multi_word
= enable_p
;
1482 else if (strcmp (argp
, "gen-semantic-icache") == 0)
1484 options
.gen
.semantic_icache
= enable_p
;
1486 else if (strcmp (argp
, "gen-slot-verification") == 0)
1488 options
.gen
.slot_verification
= enable_p
;
1490 else if (strcmp (argp
, "verify-slot") == 0)
1492 options
.gen
.slot_verification
= enable_p
;
1493 options
.warning (NULL
,
1494 "Option verify-slot replaced by gen-slot-verification\n");
1496 else if (strcmp (argp
, "gen-nia-invalid") == 0)
1498 options
.gen
.nia
= nia_is_invalid
;
1500 else if (strcmp (argp
, "default-nia-minus-one") == 0)
1502 options
.gen
.nia
= nia_is_invalid
;
1503 options
.warning (NULL
,
1504 "Option default-nia-minus-one replaced by gen-nia-invalid\n");
1506 else if (strcmp (argp
, "gen-nia-void") == 0)
1508 options
.gen
.nia
= nia_is_void
;
1510 else if (strcmp (argp
, "trace-all") == 0)
1512 memset (&options
.trace
, enable_p
, sizeof (options
.trace
));
1514 else if (strcmp (argp
, "trace-combine") == 0)
1516 options
.trace
.combine
= enable_p
;
1518 else if (strcmp (argp
, "trace-entries") == 0)
1520 options
.trace
.entries
= enable_p
;
1522 else if (strcmp (argp
, "trace-rule-rejection") == 0)
1524 options
.trace
.rule_rejection
= enable_p
;
1526 else if (strcmp (argp
, "trace-rule-selection") == 0)
1528 options
.trace
.rule_selection
= enable_p
;
1530 else if (strcmp (argp
, "trace-insn-insertion") == 0)
1532 options
.trace
.insn_insertion
= enable_p
;
1534 else if (strcmp (argp
, "trace-insn-expansion") == 0)
1536 options
.trace
.insn_expansion
= enable_p
;
1538 else if (strcmp (argp
, "jumps") == 0)
1540 options
.gen
.code
= generate_jumps
;
1542 else if (strcmp (argp
, "field-widths") == 0)
1544 options
.insn_specifying_widths
= enable_p
;
1546 else if (strcmp (argp
, "omit-line-numbers") == 0)
1548 file_references
= lf_omit_references
;
1552 error (NULL
, "Unknown option %s\n", optarg
);
1558 isa
= load_insn_table (optarg
, cache_rules
);
1559 if (isa
->illegal_insn
== NULL
)
1560 error (NULL
, "illegal-instruction missing from insn table\n");
1564 gen
= do_gen (isa
, decode_rules
);
1568 decode_rules
= load_decode_table (optarg
);
1573 error (NULL
, "Cache file must appear before the insn file\n");
1574 cache_rules
= load_cache_table (optarg
);
1578 real_file_name
= strdup (optarg
);
1594 lf
*file
= lf_open (optarg
, real_file_name
, file_references
,
1595 (is_header
? lf_is_h
: lf_is_c
),
1597 if (gen
== NULL
&& ch
!= 't' && ch
!= 'm' && ch
!= 'f')
1599 options
.warning (NULL
,
1600 "Explicitly generate tables with -x option\n");
1601 gen
= do_gen (isa
, decode_rules
);
1603 lf_print__file_start (file
);
1608 gen_model_h (file
, isa
);
1610 gen_model_c (file
, isa
);
1614 gen_itable_h (file
, isa
);
1616 gen_itable_c (file
, isa
);
1620 gen_support_h (file
, isa
);
1622 gen_support_c (file
, isa
);
1626 options
.warning (NULL
, "-hr option ignored\n");
1628 gen_run_c (file
, gen
);
1632 gen_semantics_h (file
, gen
->semantics
, isa
->max_nr_words
);
1634 gen_semantics_c (file
, gen
->semantics
, isa
->caches
);
1638 gen_idecode_h (file
, gen
, isa
, cache_rules
);
1640 gen_idecode_c (file
, gen
, isa
, cache_rules
);
1644 gen_engine_h (file
, gen
, isa
, cache_rules
);
1646 gen_engine_c (file
, gen
, isa
, cache_rules
);
1652 isa
->functions
, isa
->max_nr_words
);
1655 gen
->semantics
, isa
->functions
, cache_rules
);
1658 lf_print__file_finish (file
);
1662 real_file_name
= NULL
;
1665 ERROR ("Bad switch");