1 /* The IGEN simulator generator for GDB, the GNU Debugger.
3 Copyright 2002, 2007 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 2 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, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
37 #include "ld-decode.h"
42 #include "gen-model.h"
43 #include "gen-icache.h"
44 #include "gen-itable.h"
45 #include "gen-idecode.h"
46 #include "gen-semantics.h"
47 #include "gen-engine.h"
48 #include "gen-support.h"
49 #include "gen-engine.h"
52 /****************************************************************/
55 /* Semantic functions */
58 print_semantic_function_formal (lf *file, int nr_prefetched_words)
62 if (options.gen.icache || nr_prefetched_words < 0)
64 nr += lf_printf (file, "SIM_DESC sd,\n");
65 nr += lf_printf (file, "%sidecode_cache *cache_entry,\n",
66 options.module.global.prefix.l);
67 nr += lf_printf (file, "%sinstruction_address cia",
68 options.module.global.prefix.l);
70 else if (options.gen.smp)
72 nr += lf_printf (file, "sim_cpu *cpu,\n");
73 for (word_nr = 0; word_nr < nr_prefetched_words; word_nr++)
75 nr += lf_printf (file, "%sinstruction_word instruction_%d,\n",
76 options.module.global.prefix.l, word_nr);
78 nr += lf_printf (file, "%sinstruction_address cia",
79 options.module.global.prefix.l);
83 nr += lf_printf (file, "SIM_DESC sd,\n");
84 for (word_nr = 0; word_nr < nr_prefetched_words; word_nr++)
86 nr += lf_printf (file, "%sinstruction_word instruction_%d,\n",
87 options.module.global.prefix.l, word_nr);
89 nr += lf_printf (file, "%sinstruction_address cia",
90 options.module.global.prefix.l);
96 print_semantic_function_actual (lf *file, int nr_prefetched_words)
100 if (options.gen.icache || nr_prefetched_words < 0)
102 nr += lf_printf (file, "sd, cache_entry, cia");
107 nr += lf_printf (file, "cpu");
109 nr += lf_printf (file, "sd");
110 for (word_nr = 0; word_nr < nr_prefetched_words; word_nr++)
111 nr += lf_printf (file, ", instruction_%d", word_nr);
112 nr += lf_printf (file, ", cia");
118 print_semantic_function_type (lf *file)
121 nr += lf_printf (file, "%sinstruction_address",
122 options.module.global.prefix.l);
127 /* Idecode functions */
130 print_icache_function_formal (lf *file, int nr_prefetched_words)
135 nr += lf_printf (file, "sim_cpu *cpu,\n");
137 nr += lf_printf (file, "SIM_DESC sd,\n");
138 for (word_nr = 0; word_nr < nr_prefetched_words; word_nr++)
139 nr += lf_printf (file, " %sinstruction_word instruction_%d,\n",
140 options.module.global.prefix.l, word_nr);
141 nr += lf_printf (file, " %sinstruction_address cia,\n",
142 options.module.global.prefix.l);
143 nr += lf_printf (file, " %sidecode_cache *cache_entry",
144 options.module.global.prefix.l);
149 print_icache_function_actual (lf *file, int nr_prefetched_words)
154 nr += lf_printf (file, "cpu");
156 nr += lf_printf (file, "sd");
157 for (word_nr = 0; word_nr < nr_prefetched_words; word_nr++)
158 nr += lf_printf (file, ", instruction_%d", word_nr);
159 nr += lf_printf (file, ", cia, cache_entry");
164 print_icache_function_type (lf *file)
167 if (options.gen.semantic_icache)
169 nr = print_semantic_function_type (file);
173 nr = lf_printf (file, "%sidecode_semantic *",
174 options.module.global.prefix.l);
183 print_opcode_bits (lf *file, opcode_bits *bits)
188 nr += lf_putchr (file, '_');
189 nr += lf_putstr (file, bits->field->val_string);
190 if (bits->opcode->is_boolean && bits->value == 0)
191 nr += lf_putint (file, bits->opcode->boolean_constant);
192 else if (!bits->opcode->is_boolean)
194 if (bits->opcode->last < bits->field->last)
197 bits->value << (bits->field->last - bits->opcode->last));
199 nr += lf_putint (file, bits->value);
201 nr += print_opcode_bits (file, bits->next);
206 print_c_name (lf *file, const char *name)
210 for (pos = name; *pos != '\0'; pos++)
219 nr += lf_putchr (file, '_');
222 nr += lf_putchr (file, *pos);
230 print_function_name (lf *file,
231 const char *basename,
232 const char *format_name,
233 const char *model_name,
234 opcode_bits *expanded_bits,
235 lf_function_name_prefixes prefix)
241 case function_name_prefix_semantics:
242 nr += lf_printf (file, "%s", options.module.semantics.prefix.l);
243 nr += lf_printf (file, "semantic_");
245 case function_name_prefix_idecode:
246 nr += lf_printf (file, "%s", options.module.idecode.prefix.l);
247 nr += lf_printf (file, "idecode_");
249 case function_name_prefix_itable:
250 nr += lf_printf (file, "%sitable_", options.module.itable.prefix.l);
252 case function_name_prefix_icache:
253 nr += lf_printf (file, "%s", options.module.icache.prefix.l);
254 nr += lf_printf (file, "icache_");
256 case function_name_prefix_engine:
257 nr += lf_printf (file, "%s", options.module.engine.prefix.l);
258 nr += lf_printf (file, "engine_");
263 if (model_name != NULL)
265 nr += print_c_name (file, model_name);
266 nr += lf_printf (file, "_");
269 /* the function name */
270 nr += print_c_name (file, basename);
272 /* the format name if available */
273 if (format_name != NULL)
275 nr += lf_printf (file, "_");
276 nr += print_c_name (file, format_name);
280 nr += print_opcode_bits (file, expanded_bits);
287 print_my_defines (lf *file,
288 const char *basename,
289 const char *format_name, opcode_bits *expanded_bits)
291 /* #define MY_INDEX xxxxx */
292 lf_indent_suppress (file);
293 lf_printf (file, "#undef MY_INDEX\n");
294 lf_indent_suppress (file);
295 lf_printf (file, "#define MY_INDEX ");
296 print_function_name (file,
297 basename, format_name, NULL,
298 NULL, function_name_prefix_itable);
299 lf_printf (file, "\n");
300 /* #define MY_PREFIX xxxxxx */
301 lf_indent_suppress (file);
302 lf_printf (file, "#undef ");
303 print_function_name (file,
304 basename, format_name, NULL,
305 expanded_bits, function_name_prefix_none);
306 lf_printf (file, "\n");
307 lf_indent_suppress (file);
308 lf_printf (file, "#undef MY_PREFIX\n");
309 lf_indent_suppress (file);
310 lf_printf (file, "#define MY_PREFIX ");
311 print_function_name (file,
312 basename, format_name, NULL,
313 expanded_bits, function_name_prefix_none);
314 lf_printf (file, "\n");
315 /* #define MY_NAME xxxxxx */
316 lf_indent_suppress (file);
317 lf_indent_suppress (file);
318 lf_printf (file, "#undef MY_NAME\n");
319 lf_indent_suppress (file);
320 lf_printf (file, "#define MY_NAME \"");
321 print_function_name (file,
322 basename, format_name, NULL,
323 expanded_bits, function_name_prefix_none);
324 lf_printf (file, "\"\n");
329 print_itrace_prefix (lf *file)
331 const char *prefix = "trace_prefix (";
332 int indent = strlen (prefix);
333 lf_printf (file, "%sSD, CPU, cia, CIA, TRACE_LINENUM_P (CPU), \\\n",
335 lf_indent (file, +indent);
336 lf_printf (file, "%sitable[MY_INDEX].file, \\\n",
337 options.module.itable.prefix.l);
338 lf_printf (file, "%sitable[MY_INDEX].line_nr, \\\n",
339 options.module.itable.prefix.l);
340 lf_printf (file, "\"");
346 print_itrace_format (lf *file, insn_mnemonic_entry *assembler)
348 /* pass=1 is fmt string; pass=2 is arguments */
350 /* print the format string */
351 for (pass = 1; pass <= 2; pass++)
353 const char *chp = assembler->format;
354 chp++; /* skip the leading quote */
355 /* write out the format/args */
358 if (chp[0] == '\\' && (chp[1] == '<' || chp[1] == '>'))
361 lf_putchr (file, chp[1]);
364 else if (chp[0] == '<' || chp[0] == '%')
366 /* parse [ "%" ... ] "<" [ func "#" ] param ">" */
372 /* the "%" ... "<" format */
374 while (chp[0] != '<' && chp[0] != '\0')
377 error (assembler->line, "Missing `<' after `%%'\n");
379 /* [ "func" # ] OR "param" */
382 while (chp[0] != '>' && chp[0] != '#' && chp[0] != '\0')
384 strlen_func = chp - func;
389 while (chp[0] != '>' && chp[0] != '\0')
392 strlen_param = chp - param;
394 error (assembler->line,
395 "Missing closing `>' in assembler string\n");
399 lf_printf (file, ", \\\n");
400 if (strncmp (fmt, "<", 1) == 0)
401 /* implicit long int format */
404 lf_printf (file, "%%ld");
407 lf_printf (file, "(long) ");
408 lf_write (file, param, strlen_param);
411 else if (strncmp (fmt, "%<", 2) == 0)
412 /* explicit format */
415 lf_printf (file, "%%");
417 lf_write (file, param, strlen_param);
419 else if (strncmp (fmt, "%s<", 3) == 0)
423 lf_printf (file, "%%s");
426 lf_printf (file, "%sstr_",
427 options.module.global.prefix.l);
428 lf_write (file, func, strlen_func);
429 lf_printf (file, " (SD_, ");
430 lf_write (file, param, strlen_param);
431 lf_printf (file, ")");
434 else if (strncmp (fmt, "%lx<", 4) == 0)
438 lf_printf (file, "%%lx");
441 lf_printf (file, "(unsigned long) ");
442 lf_write (file, param, strlen_param);
445 else if (strncmp (fmt, "%#lx<", 5) == 0)
446 /* simple hex with 0x prefix */
449 lf_printf (file, "%%#lx");
452 lf_printf (file, "(unsigned long) ");
453 lf_write (file, param, strlen_param);
456 else if (strncmp (fmt, "%08lx<", 6) == 0)
460 lf_printf (file, "%%08lx");
463 lf_printf (file, "(unsigned long) ");
464 lf_write (file, param, strlen_param);
468 error (assembler->line, "Unknown assembler string format\n");
473 lf_putchr (file, chp[0]);
478 lf_printf (file, ");\n");
483 print_itrace (lf *file, insn_entry * insn, int idecode)
485 /* NB: Here we escape each EOLN. This is so that the the compiler
486 treats a trace function call as a single line. Consequently any
487 errors in the line are refered back to the same igen assembler
489 const char *phase = (idecode) ? "DECODE" : "INSN";
490 lf_printf (file, "\n");
491 lf_indent_suppress (file);
492 lf_printf (file, "#if defined (WITH_TRACE)\n");
493 lf_printf (file, "/* generate a trace prefix if any tracing enabled */\n");
494 lf_printf (file, "if (TRACE_ANY_P (CPU))\n");
495 lf_printf (file, " {\n");
496 lf_indent (file, +4);
498 if (insn->mnemonics != NULL)
500 insn_mnemonic_entry *assembler = insn->mnemonics;
504 if (assembler->condition != NULL)
507 lf_printf (file, "%sif (%s)\n",
508 is_first ? "" : "else ", assembler->condition);
509 lf_indent (file, +2);
510 lf_print__line_ref (file, assembler->line);
511 indent = print_itrace_prefix (file);
512 print_itrace_format (file, assembler);
513 lf_print__internal_ref (file);
514 lf_indent (file, -indent);
515 lf_indent (file, -2);
516 if (assembler->next == NULL)
517 error (assembler->line,
518 "Missing final unconditional assembler\n");
525 lf_printf (file, "else\n");
526 lf_indent (file, +2);
528 lf_print__line_ref (file, assembler->line);
529 indent = print_itrace_prefix (file);
530 print_itrace_format (file, assembler);
531 lf_print__internal_ref (file);
532 lf_indent (file, -indent);
534 lf_indent (file, -2);
535 if (assembler->next != NULL)
536 error (assembler->line,
537 "Unconditional assembler is not last\n");
540 assembler = assembler->next;
542 while (assembler != NULL);
547 lf_indent (file, +2);
548 lf_print__line_ref (file, insn->line);
549 indent = print_itrace_prefix (file);
550 lf_printf (file, "%%s\", \\\n");
551 lf_printf (file, "itable[MY_INDEX].name);\n");
552 lf_print__internal_ref (file);
553 lf_indent (file, -indent);
554 lf_indent (file, -2);
556 lf_printf (file, "/* trace the instruction execution if enabled */\n");
557 lf_printf (file, "if (TRACE_%s_P (CPU))\n", phase);
559 " trace_generic (SD, CPU, TRACE_%s_IDX, \" %%s\", itable[MY_INDEX].name);\n",
562 lf_indent (file, -4);
563 lf_printf (file, " }\n");
564 lf_indent_suppress (file);
565 lf_printf (file, "#endif\n");
570 print_sim_engine_abort (lf *file, const char *message)
572 lf_printf (file, "sim_engine_abort (SD, CPU, cia, ");
573 lf_printf (file, "\"%s\"", message);
574 lf_printf (file, ");\n");
579 print_include (lf *file, igen_module module)
581 lf_printf (file, "#include \"%s%s.h\"\n", module.prefix.l, module.suffix.l);
585 print_include_inline (lf *file, igen_module module)
587 lf_printf (file, "#if C_REVEALS_MODULE_P (%s_INLINE)\n", module.suffix.u);
588 lf_printf (file, "#include \"%s%s.c\"\n", module.prefix.l, module.suffix.l);
589 lf_printf (file, "#else\n");
590 print_include (file, module);
591 lf_printf (file, "#endif\n");
592 lf_printf (file, "\n");
596 print_includes (lf *file)
598 lf_printf (file, "\n");
599 lf_printf (file, "#include \"sim-inline.c\"\n");
600 lf_printf (file, "\n");
601 print_include_inline (file, options.module.itable);
602 print_include_inline (file, options.module.idecode);
603 print_include_inline (file, options.module.support);
607 /****************************************************************/
611 gen_semantics_h (lf *file, insn_list *semantics, int max_nr_words)
615 for (word_nr = -1; word_nr <= max_nr_words; word_nr++)
617 lf_printf (file, "typedef ");
618 print_semantic_function_type (file);
619 lf_printf (file, " %sidecode_semantic", options.module.global.prefix.l);
621 lf_printf (file, "_%d", word_nr);
622 lf_printf (file, "\n(");
623 lf_indent (file, +1);
624 print_semantic_function_formal (file, word_nr);
625 lf_indent (file, -1);
626 lf_printf (file, ");\n");
627 lf_printf (file, "\n");
629 switch (options.gen.code)
632 for (semantic = semantics; semantic != NULL; semantic = semantic->next)
634 /* Ignore any special/internal instructions */
635 if (semantic->insn->nr_words == 0)
637 print_semantic_declaration (file,
639 semantic->expanded_bits,
641 semantic->nr_prefetched_words);
645 lf_print__this_file_is_empty (file, "generating jumps");
652 gen_semantics_c (lf *file, insn_list *semantics, cache_entry *cache_rules)
654 if (options.gen.code == generate_calls)
657 print_includes (file);
658 print_include (file, options.module.semantics);
659 lf_printf (file, "\n");
661 for (semantic = semantics; semantic != NULL; semantic = semantic->next)
663 /* Ignore any special/internal instructions */
664 if (semantic->insn->nr_words == 0)
666 print_semantic_definition (file,
668 semantic->expanded_bits,
671 semantic->nr_prefetched_words);
676 lf_print__this_file_is_empty (file, "generating jump engine");
681 /****************************************************************/
685 gen_icache_h (lf *file,
687 function_entry * functions, int max_nr_words)
690 for (word_nr = 0; word_nr <= max_nr_words; word_nr++)
692 lf_printf (file, "typedef ");
693 print_icache_function_type (file);
694 lf_printf (file, " %sidecode_icache_%d\n(",
695 options.module.global.prefix.l, word_nr);
696 print_icache_function_formal (file, word_nr);
697 lf_printf (file, ");\n");
698 lf_printf (file, "\n");
700 if (options.gen.code == generate_calls && options.gen.icache)
702 function_entry_traverse (file, functions,
703 print_icache_internal_function_declaration,
705 while (semantic != NULL)
707 print_icache_declaration (file,
709 semantic->expanded_bits,
711 semantic->nr_prefetched_words);
712 semantic = semantic->next;
717 lf_print__this_file_is_empty (file, "generating jump engine");
722 gen_icache_c (lf *file,
724 function_entry * functions, cache_entry *cache_rules)
726 /* output `internal' invalid/floating-point unavailable functions
728 if (options.gen.code == generate_calls && options.gen.icache)
730 lf_printf (file, "\n");
731 lf_printf (file, "#include \"cpu.h\"\n");
732 lf_printf (file, "#include \"idecode.h\"\n");
733 lf_printf (file, "#include \"semantics.h\"\n");
734 lf_printf (file, "#include \"icache.h\"\n");
735 lf_printf (file, "#include \"support.h\"\n");
736 lf_printf (file, "\n");
737 function_entry_traverse (file, functions,
738 print_icache_internal_function_definition,
740 lf_printf (file, "\n");
741 while (semantic != NULL)
743 print_icache_definition (file,
745 semantic->expanded_bits,
748 semantic->nr_prefetched_words);
749 semantic = semantic->next;
754 lf_print__this_file_is_empty (file, "generating jump engine");
759 /****************************************************************/
763 gen_idecode_h (lf *file,
764 gen_table *gen, insn_table *insns, cache_entry *cache_rules)
766 lf_printf (file, "typedef unsigned%d %sinstruction_word;\n",
767 options.insn_bit_size, options.module.global.prefix.l);
768 if (options.gen.delayed_branch)
770 lf_printf (file, "typedef struct _%sinstruction_address {\n",
771 options.module.global.prefix.l);
772 lf_printf (file, " address_word ip; /* instruction pointer */\n");
773 lf_printf (file, " address_word dp; /* delayed-slot pointer */\n");
774 lf_printf (file, "} %sinstruction_address;\n",
775 options.module.global.prefix.l);
779 lf_printf (file, "typedef address_word %sinstruction_address;\n",
780 options.module.global.prefix.l);
783 if (options.gen.nia == nia_is_invalid
784 && strlen (options.module.global.prefix.u) > 0)
786 lf_indent_suppress (file);
787 lf_printf (file, "#define %sINVALID_INSTRUCTION_ADDRESS ",
788 options.module.global.prefix.u);
789 lf_printf (file, "INVALID_INSTRUCTION_ADDRESS\n");
791 lf_printf (file, "\n");
792 print_icache_struct (file, insns, cache_rules);
793 lf_printf (file, "\n");
794 if (options.gen.icache)
796 ERROR ("FIXME - idecode with icache suffering from bit-rot");
801 for (entry = gen->tables; entry != NULL; entry = entry->next)
803 print_idecode_issue_function_header (file,
804 (options.gen.multi_sim
807 is_function_declaration,
808 1 /*ALWAYS ONE WORD */ );
810 if (options.gen.multi_sim)
812 print_idecode_issue_function_header (file,
814 is_function_variable,
815 1 /*ALWAYS ONE WORD */ );
822 gen_idecode_c (lf *file,
823 gen_table *gen, insn_table *isa, cache_entry *cache_rules)
826 print_includes (file);
827 print_include_inline (file, options.module.semantics);
828 lf_printf (file, "\n");
830 print_idecode_globals (file);
831 lf_printf (file, "\n");
833 switch (options.gen.code)
838 for (entry = gen->tables; entry != NULL; entry = entry->next)
840 print_idecode_lookups (file, entry->table, cache_rules);
842 /* output the main idecode routine */
843 if (!options.gen.icache)
845 print_idecode_issue_function_header (file,
846 (options.gen.multi_sim
849 1 /*is definition */ ,
850 1 /*ALWAYS ONE WORD */ );
851 lf_printf (file, "{\n");
852 lf_indent (file, +2);
853 lf_printf (file, "%sinstruction_address nia;\n",
854 options.module.global.prefix.l);
855 print_idecode_body (file, entry->table, "nia =");
856 lf_printf (file, "return nia;");
857 lf_indent (file, -2);
858 lf_printf (file, "}\n");
865 lf_print__this_file_is_empty (file, "generating a jump engine");
872 /****************************************************************/
876 gen_run_c (lf *file, gen_table *gen)
879 lf_printf (file, "#include \"sim-main.h\"\n");
880 lf_printf (file, "#include \"engine.h\"\n");
881 lf_printf (file, "#include \"idecode.h\"\n");
882 lf_printf (file, "#include \"bfd.h\"\n");
883 lf_printf (file, "\n");
885 if (options.gen.multi_sim)
887 print_idecode_issue_function_header (file, NULL, is_function_variable,
889 lf_printf (file, "\n");
890 print_engine_run_function_header (file, NULL, is_function_variable);
891 lf_printf (file, "\n");
894 lf_printf (file, "void\n");
895 lf_printf (file, "sim_engine_run (SIM_DESC sd,\n");
896 lf_printf (file, " int next_cpu_nr,\n");
897 lf_printf (file, " int nr_cpus,\n");
898 lf_printf (file, " int siggnal)\n");
899 lf_printf (file, "{\n");
900 lf_indent (file, +2);
901 if (options.gen.multi_sim)
903 lf_printf (file, "int mach;\n");
904 lf_printf (file, "if (STATE_ARCHITECTURE (sd) == NULL)\n");
905 lf_printf (file, " mach = 0;\n");
906 lf_printf (file, "else\n");
907 lf_printf (file, " mach = STATE_ARCHITECTURE (sd)->mach;\n");
908 lf_printf (file, "switch (mach)\n");
909 lf_printf (file, " {\n");
910 lf_indent (file, +2);
911 for (entry = gen->tables; entry != NULL; entry = entry->next)
913 if (options.gen.default_model != NULL
914 && (strcmp (entry->model->name, options.gen.default_model) == 0
915 || strcmp (entry->model->full_name,
916 options.gen.default_model) == 0))
917 lf_printf (file, "default:\n");
918 lf_printf (file, "case bfd_mach_%s:\n", entry->model->full_name);
919 lf_indent (file, +2);
920 print_function_name (file, "issue", NULL, /* format name */
921 NULL, /* NO processor */
922 NULL, /* expanded bits */
923 function_name_prefix_idecode);
924 lf_printf (file, " = ");
925 print_function_name (file, "issue", NULL, /* format name */
926 entry->model->name, NULL, /* expanded bits */
927 function_name_prefix_idecode);
928 lf_printf (file, ";\n");
929 print_function_name (file, "run", NULL, /* format name */
930 NULL, /* NO processor */
931 NULL, /* expanded bits */
932 function_name_prefix_engine);
933 lf_printf (file, " = ");
934 print_function_name (file, "run", NULL, /* format name */
935 entry->model->name, NULL, /* expanded bits */
936 function_name_prefix_engine);
937 lf_printf (file, ";\n");
938 lf_printf (file, "break;\n");
939 lf_indent (file, -2);
941 if (options.gen.default_model == NULL)
943 lf_printf (file, "default:\n");
944 lf_indent (file, +2);
945 lf_printf (file, "sim_engine_abort (sd, NULL, NULL_CIA,\n");
947 " \"sim_engine_run - unknown machine\");\n");
948 lf_printf (file, "break;\n");
949 lf_indent (file, -2);
951 lf_indent (file, -2);
952 lf_printf (file, " }\n");
954 print_function_name (file, "run", NULL, /* format name */
955 NULL, /* NO processor */
956 NULL, /* expanded bits */
957 function_name_prefix_engine);
958 lf_printf (file, " (sd, next_cpu_nr, nr_cpus, siggnal);\n");
959 lf_indent (file, -2);
960 lf_printf (file, "}\n");
963 /****************************************************************/
966 do_gen (insn_table *isa, decode_table *decode_rules)
969 if (decode_rules == NULL)
970 error (NULL, "Must specify a decode table\n");
972 error (NULL, "Must specify an instruction table\n");
973 if (decode_table_max_word_nr (decode_rules) > 0)
974 options.gen.multi_word = decode_table_max_word_nr (decode_rules);
975 gen = make_gen_tables (isa, decode_rules);
976 gen_tables_expand_insns (gen);
977 gen_tables_expand_semantics (gen);
981 /****************************************************************/
983 igen_options options;
986 main (int argc, char **argv, char **envp)
988 cache_entry *cache_rules = NULL;
989 lf_file_references file_references = lf_include_references;
990 decode_table *decode_rules = NULL;
991 insn_table *isa = NULL;
992 gen_table *gen = NULL;
993 char *real_file_name = NULL;
997 lf_open ("-", "stdout", lf_omit_references, lf_is_text, "igen");
1003 printf ("Usage:\n");
1005 printf (" igen <config-opts> ... <input-opts>... <output-opts>...\n");
1007 printf ("Config options:\n");
1009 printf (" -B <bit-size>\n");
1010 printf ("\t Set the number of bits in an instruction (deprecated).\n");
1012 ("\t This option can now be set directly in the instruction table.\n");
1014 printf (" -D <data-structure>\n");
1016 ("\t Dump the specified data structure to stdout. Valid structures include:\n");
1018 ("\t processor-names - list the names of all the processors (models)\n");
1020 printf (" -F <filter-list>\n");
1022 ("\t Filter out any instructions with a non-empty flags field that contains\n");
1023 printf ("\t a flag not listed in the <filter-list>.\n");
1025 printf (" -H <high-bit>\n");
1027 ("\t Set the number of the high (most significant) instruction bit (deprecated).\n");
1029 ("\t This option can now be set directly in the instruction table.\n");
1031 printf (" -I <directory>\n");
1033 ("\t Add <directory> to the list of directories searched when opening a file\n");
1035 printf (" -M <model-list>\n");
1037 ("\t Filter out any instructions that do not support at least one of the listed\n");
1039 ("\t models (An instructions with no model information is considered to support\n");
1040 printf ("\t all models.).\n");
1042 printf (" -N <nr-cpus>\n");
1043 printf ("\t Generate a simulator supporting <nr-cpus>\n");
1045 ("\t Specify `-N 0' to disable generation of the SMP. Specifying `-N 1' will\n");
1047 ("\t still generate an SMP enabled simulator but will only support one CPU.\n");
1049 printf (" -T <mechanism>\n");
1051 ("\t Override the decode mechanism specified by the decode rules\n");
1053 printf (" -P <prefix>\n");
1055 ("\t Prepend global names (except itable) with the string <prefix>.\n");
1057 ("\t Specify -P <module>=<prefix> to set a specific <module>'s prefix.\n");
1059 printf (" -S <suffix>\n");
1061 ("\t Replace a global name (suffix) (except itable) with the string <suffix>.\n");
1063 ("\t Specify -S <module>=<suffix> to change a specific <module>'s name (suffix).\n");
1065 printf (" -Werror\n");
1066 printf ("\t Make warnings errors\n");
1067 printf (" -Wnodiscard\n");
1069 ("\t Suppress warnings about discarded functions and instructions\n");
1070 printf (" -Wnowidth\n");
1072 ("\t Suppress warnings about instructions with invalid widths\n");
1073 printf (" -Wnounimplemented\n");
1074 printf ("\t Suppress warnings about unimplemented instructions\n");
1076 printf (" -G [!]<gen-option>\n");
1077 printf ("\t Any of the following options:\n");
1080 ("\t decode-duplicate - Override the decode rules, forcing the duplication of\n");
1081 printf ("\t semantic functions\n");
1083 ("\t decode-combine - Combine any duplicated entries within a table\n");
1085 ("\t decode-zero-reserved - Override the decode rules, forcing reserved bits to be\n");
1086 printf ("\t treated as zero.\n");
1088 ("\t decode-switch-is-goto - Overfide the padded-switch code type as a goto-switch\n");
1091 ("\t gen-conditional-issue - conditionally issue each instruction\n");
1093 ("\t gen-delayed-branch - need both cia and nia passed around\n");
1095 ("\t gen-direct-access - use #defines to directly access values\n");
1097 ("\t gen-zero-r<N> - arch assumes GPR(<N>) == 0, keep it that way\n");
1099 ("\t gen-icache[=<N> - generate an instruction cracking cache of size <N>\n");
1100 printf ("\t Default size is %d\n",
1101 options.gen.icache_size);
1103 ("\t gen-insn-in-icache - save original instruction when cracking\n");
1105 ("\t gen-multi-sim[=MODEL] - generate multiple simulators - one per model\n");
1107 ("\t If specified MODEL is made the default architecture.\n");
1109 ("\t By default, a single simulator that will\n");
1111 ("\t execute any instruction is generated\n");
1113 ("\t gen-multi-word - generate code allowing for multi-word insns\n");
1115 ("\t gen-semantic-icache - include semantic code in cracking functions\n");
1117 ("\t gen-slot-verification - perform slot verification as part of decode\n");
1118 printf ("\t gen-nia-invalid - NIA defaults to nia_invalid\n");
1119 printf ("\t gen-nia-void - do not compute/return NIA\n");
1122 ("\t trace-combine - report combined entries a rule application\n");
1124 ("\t trace-entries - report entries after a rules application\n");
1125 printf ("\t trace-rule-rejection - report each rule as rejected\n");
1126 printf ("\t trace-rule-selection - report each rule as selected\n");
1128 ("\t trace-insn-insertion - report each instruction as it is inserted into a decode table\n");
1130 ("\t trace-rule-expansion - report each instruction as it is expanded (before insertion into a decode table)\n");
1131 printf ("\t trace-all - enable all trace options\n");
1134 ("\t field-widths - instruction formats specify widths (deprecated)\n");
1136 ("\t By default, an instruction format specifies bit\n");
1137 printf ("\t positions\n");
1139 ("\t This option can now be set directly in the\n");
1140 printf ("\t instruction table\n");
1142 ("\t jumps - use jumps instead of function calls\n");
1144 ("\t omit-line-numbers - do not include line number information in the output\n");
1146 printf ("Input options:\n");
1148 printf (" -k <cache-rules> (deprecated)\n");
1149 printf (" -o <decode-rules>\n");
1150 printf (" -i <instruction-table>\n");
1152 printf ("Output options:\n");
1154 printf (" -x Perform expansion (required)\n");
1156 (" -n <real-name> Specify the real name of the next output file\n");
1158 (" -h Generate the header (.h) file rather than the body (.c)\n");
1159 printf (" -c <output-file> output icache\n");
1160 printf (" -d <output-file> output idecode\n");
1161 printf (" -e <output-file> output engine\n");
1162 printf (" -f <output-file> output support functions\n");
1163 printf (" -m <output-file> output model\n");
1164 printf (" -r <output-file> output multi-sim run\n");
1165 printf (" -s <output-file> output schematic\n");
1166 printf (" -t <output-file> output itable\n");
1169 while ((ch = getopt (argc, argv,
1170 "B:D:F:G:H:I:M:N:P:T:W:o:k:i:n:hc:d:e:m:r:s:t:f:x"))
1173 fprintf (stderr, " -%c ", ch);
1175 fprintf (stderr, "%s ", optarg);
1176 fprintf (stderr, "\\\n");
1182 filter_parse (&options.model_filter, optarg);
1186 if (strcmp (optarg, "processor-names"))
1189 for (processor = filter_next (options.model_filter, "");
1191 processor = filter_next (options.model_filter, processor))
1192 lf_printf (standard_out, "%s\n", processor);
1195 error (NULL, "Unknown data structure %s, not dumped\n", optarg);
1199 filter_parse (&options.flags_filter, optarg);
1204 table_include **dir = &options.include;
1205 while ((*dir) != NULL)
1206 dir = &(*dir)->next;
1207 (*dir) = ZALLOC (table_include);
1208 (*dir)->dir = strdup (optarg);
1213 options.insn_bit_size = a2i (optarg);
1214 if (options.insn_bit_size <= 0
1215 || options.insn_bit_size > max_insn_bit_size)
1217 error (NULL, "Instruction bitsize must be in range 1..%d\n",
1220 if (options.hi_bit_nr != options.insn_bit_size - 1
1221 && options.hi_bit_nr != 0)
1223 error (NULL, "Conflict betweem hi-bit-nr and insn-bit-size\n");
1228 options.hi_bit_nr = a2i (optarg);
1229 if (options.hi_bit_nr != options.insn_bit_size - 1
1230 && options.hi_bit_nr != 0)
1232 error (NULL, "Conflict between hi-bit-nr and insn-bit-size\n");
1237 options.gen.smp = a2i (optarg);
1246 chp = strchr (optarg, '=');
1249 names = &options.module.global;
1254 chp = chp + 1; /* skip `=' */
1256 if (strncmp (optarg, "global=", chp - optarg) == 0)
1258 names = &options.module.global;
1260 if (strncmp (optarg, "engine=", chp - optarg) == 0)
1262 names = &options.module.engine;
1264 if (strncmp (optarg, "icache=", chp - optarg) == 0)
1266 names = &options.module.icache;
1268 if (strncmp (optarg, "idecode=", chp - optarg) == 0)
1270 names = &options.module.idecode;
1272 if (strncmp (optarg, "itable=", chp - optarg) == 0)
1274 names = &options.module.itable;
1276 if (strncmp (optarg, "semantics=", chp - optarg) == 0)
1278 names = &options.module.semantics;
1280 if (strncmp (optarg, "support=", chp - optarg) == 0)
1282 names = &options.module.support;
1286 error (NULL, "Prefix `%s' unreconized\n", optarg);
1292 name = &names->prefix;
1295 name = &names->suffix;
1298 abort (); /* Bad switch. */
1300 name->u = strdup (chp);
1301 name->l = strdup (chp);
1306 *chp = toupper (*chp);
1309 if (name == &options.module.global.prefix)
1311 options.module.engine.prefix = options.module.global.prefix;
1312 options.module.icache.prefix = options.module.global.prefix;
1313 options.module.idecode.prefix = options.module.global.prefix;
1314 /* options.module.itable.prefix = options.module.global.prefix; */
1315 options.module.semantics.prefix =
1316 options.module.global.prefix;
1317 options.module.support.prefix = options.module.global.prefix;
1319 if (name == &options.module.global.suffix)
1321 options.module.engine.suffix = options.module.global.suffix;
1322 options.module.icache.suffix = options.module.global.suffix;
1323 options.module.idecode.suffix = options.module.global.suffix;
1324 /* options.module.itable.suffix = options.module.global.suffix; */
1325 options.module.semantics.suffix =
1326 options.module.global.suffix;
1327 options.module.support.suffix = options.module.global.suffix;
1334 if (strcmp (optarg, "error") == 0)
1335 options.warning = error;
1336 else if (strcmp (optarg, "nodiscard") == 0)
1337 options.warn.discard = 0;
1338 else if (strcmp (optarg, "discard") == 0)
1339 options.warn.discard = 1;
1340 else if (strcmp (optarg, "nowidth") == 0)
1341 options.warn.width = 0;
1342 else if (strcmp (optarg, "width") == 0)
1343 options.warn.width = 1;
1344 else if (strcmp (optarg, "nounimplemented") == 0)
1345 options.warn.unimplemented = 0;
1346 else if (strcmp (optarg, "unimplemented") == 0)
1347 options.warn.unimplemented = 1;
1349 error (NULL, "Unknown -W argument `%s'\n", optarg);
1358 if (strncmp (optarg, "no-", strlen ("no-")) == 0)
1360 argp = optarg + strlen ("no-");
1363 else if (strncmp (optarg, "!", strlen ("!")) == 0)
1365 argp = optarg + strlen ("no-");
1373 if (strcmp (argp, "decode-duplicate") == 0)
1375 options.decode.duplicate = enable_p;
1377 else if (strcmp (argp, "decode-combine") == 0)
1379 options.decode.combine = enable_p;
1381 else if (strcmp (argp, "decode-zero-reserved") == 0)
1383 options.decode.zero_reserved = enable_p;
1386 else if (strcmp (argp, "gen-conditional-issue") == 0)
1388 options.gen.conditional_issue = enable_p;
1390 else if (strcmp (argp, "conditional-issue") == 0)
1392 options.gen.conditional_issue = enable_p;
1393 options.warning (NULL,
1394 "Option conditional-issue replaced by gen-conditional-issue\n");
1396 else if (strcmp (argp, "gen-delayed-branch") == 0)
1398 options.gen.delayed_branch = enable_p;
1400 else if (strcmp (argp, "delayed-branch") == 0)
1402 options.gen.delayed_branch = enable_p;
1403 options.warning (NULL,
1404 "Option delayed-branch replaced by gen-delayed-branch\n");
1406 else if (strcmp (argp, "gen-direct-access") == 0)
1408 options.gen.direct_access = enable_p;
1410 else if (strcmp (argp, "direct-access") == 0)
1412 options.gen.direct_access = enable_p;
1413 options.warning (NULL,
1414 "Option direct-access replaced by gen-direct-access\n");
1416 else if (strncmp (argp, "gen-zero-r", strlen ("gen-zero-r")) == 0)
1418 options.gen.zero_reg = enable_p;
1419 options.gen.zero_reg_nr = atoi (argp + strlen ("gen-zero-r"));
1421 else if (strncmp (argp, "zero-r", strlen ("zero-r")) == 0)
1423 options.gen.zero_reg = enable_p;
1424 options.gen.zero_reg_nr = atoi (argp + strlen ("zero-r"));
1425 options.warning (NULL,
1426 "Option zero-r<N> replaced by gen-zero-r<N>\n");
1428 else if (strncmp (argp, "gen-icache", strlen ("gen-icache")) == 0)
1430 switch (argp[strlen ("gen-icache")])
1433 options.gen.icache_size =
1434 atoi (argp + strlen ("gen-icache") + 1);
1435 options.gen.icache = enable_p;
1438 options.gen.icache = enable_p;
1442 "Expecting -Ggen-icache or -Ggen-icache=<N>\n");
1445 else if (strcmp (argp, "gen-insn-in-icache") == 0)
1447 options.gen.insn_in_icache = enable_p;
1449 else if (strncmp (argp, "gen-multi-sim", strlen ("gen-multi-sim"))
1452 char *arg = &argp[strlen ("gen-multi-sim")];
1456 options.gen.multi_sim = enable_p;
1457 options.gen.default_model = arg + 1;
1458 if (!filter_is_member
1459 (options.model_filter, options.gen.default_model))
1460 error (NULL, "multi-sim model %s unknown\n",
1461 options.gen.default_model);
1464 options.gen.multi_sim = enable_p;
1465 options.gen.default_model = NULL;
1469 "Expecting -Ggen-multi-sim or -Ggen-multi-sim=<MODEL>\n");
1473 else if (strcmp (argp, "gen-multi-word") == 0)
1475 options.gen.multi_word = enable_p;
1477 else if (strcmp (argp, "gen-semantic-icache") == 0)
1479 options.gen.semantic_icache = enable_p;
1481 else if (strcmp (argp, "gen-slot-verification") == 0)
1483 options.gen.slot_verification = enable_p;
1485 else if (strcmp (argp, "verify-slot") == 0)
1487 options.gen.slot_verification = enable_p;
1488 options.warning (NULL,
1489 "Option verify-slot replaced by gen-slot-verification\n");
1491 else if (strcmp (argp, "gen-nia-invalid") == 0)
1493 options.gen.nia = nia_is_invalid;
1495 else if (strcmp (argp, "default-nia-minus-one") == 0)
1497 options.gen.nia = nia_is_invalid;
1498 options.warning (NULL,
1499 "Option default-nia-minus-one replaced by gen-nia-invalid\n");
1501 else if (strcmp (argp, "gen-nia-void") == 0)
1503 options.gen.nia = nia_is_void;
1505 else if (strcmp (argp, "trace-all") == 0)
1507 memset (&options.trace, enable_p, sizeof (options.trace));
1509 else if (strcmp (argp, "trace-combine") == 0)
1511 options.trace.combine = enable_p;
1513 else if (strcmp (argp, "trace-entries") == 0)
1515 options.trace.entries = enable_p;
1517 else if (strcmp (argp, "trace-rule-rejection") == 0)
1519 options.trace.rule_rejection = enable_p;
1521 else if (strcmp (argp, "trace-rule-selection") == 0)
1523 options.trace.rule_selection = enable_p;
1525 else if (strcmp (argp, "trace-insn-insertion") == 0)
1527 options.trace.insn_insertion = enable_p;
1529 else if (strcmp (argp, "trace-insn-expansion") == 0)
1531 options.trace.insn_expansion = enable_p;
1533 else if (strcmp (argp, "jumps") == 0)
1535 options.gen.code = generate_jumps;
1537 else if (strcmp (argp, "field-widths") == 0)
1539 options.insn_specifying_widths = enable_p;
1541 else if (strcmp (argp, "omit-line-numbers") == 0)
1543 file_references = lf_omit_references;
1547 error (NULL, "Unknown option %s\n", optarg);
1553 isa = load_insn_table (optarg, cache_rules);
1554 if (isa->illegal_insn == NULL)
1555 error (NULL, "illegal-instruction missing from insn table\n");
1559 gen = do_gen (isa, decode_rules);
1563 decode_rules = load_decode_table (optarg);
1568 error (NULL, "Cache file must appear before the insn file\n");
1569 cache_rules = load_cache_table (optarg);
1573 real_file_name = strdup (optarg);
1589 lf *file = lf_open (optarg, real_file_name, file_references,
1590 (is_header ? lf_is_h : lf_is_c),
1592 if (gen == NULL && ch != 't' && ch != 'm' && ch != 'f')
1594 options.warning (NULL,
1595 "Explicitly generate tables with -x option\n");
1596 gen = do_gen (isa, decode_rules);
1598 lf_print__file_start (file);
1603 gen_model_h (file, isa);
1605 gen_model_c (file, isa);
1609 gen_itable_h (file, isa);
1611 gen_itable_c (file, isa);
1615 gen_support_h (file, isa);
1617 gen_support_c (file, isa);
1621 options.warning (NULL, "-hr option ignored\n");
1623 gen_run_c (file, gen);
1627 gen_semantics_h (file, gen->semantics, isa->max_nr_words);
1629 gen_semantics_c (file, gen->semantics, isa->caches);
1633 gen_idecode_h (file, gen, isa, cache_rules);
1635 gen_idecode_c (file, gen, isa, cache_rules);
1639 gen_engine_h (file, gen, isa, cache_rules);
1641 gen_engine_c (file, gen, isa, cache_rules);
1647 isa->functions, isa->max_nr_words);
1650 gen->semantics, isa->functions, cache_rules);
1653 lf_print__file_finish (file);
1657 real_file_name = NULL;
1660 ERROR ("Bad switch");