1 /* This file is part of the program psim.
3 Copyright (C) 1994-1998, Andrew Cagney <cagney@highland.com.au>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
34 #include "ld-decode.h"
39 #include "gen-model.h"
40 #include "gen-icache.h"
41 #include "gen-itable.h"
42 #include "gen-idecode.h"
43 #include "gen-semantics.h"
44 #include "gen-engine.h"
45 #include "gen-support.h"
46 #include "gen-engine.h"
49 /****************************************************************/
52 /* Semantic functions */
55 print_semantic_function_formal (lf *file,
56 int nr_prefetched_words)
60 if (options.gen.icache || nr_prefetched_words < 0)
62 nr += lf_printf (file, "SIM_DESC sd,\n");
63 nr += lf_printf (file, "%sidecode_cache *cache_entry,\n",
64 options.module.global.prefix.l);
65 nr += lf_printf (file, "%sinstruction_address cia",
66 options.module.global.prefix.l);
68 else if (options.gen.smp)
70 nr += lf_printf (file, "sim_cpu *cpu,\n");
71 for (word_nr = 0; word_nr < nr_prefetched_words; word_nr++)
73 nr += lf_printf (file, "%sinstruction_word instruction_%d,\n",
74 options.module.global.prefix.l,
77 nr += lf_printf (file, "%sinstruction_address cia",
78 options.module.global.prefix.l);
82 nr += lf_printf (file, "SIM_DESC sd,\n");
83 for (word_nr = 0; word_nr < nr_prefetched_words; word_nr++)
85 nr += lf_printf (file, "%sinstruction_word instruction_%d,\n",
86 options.module.global.prefix.l,
89 nr += lf_printf (file, "%sinstruction_address cia",
90 options.module.global.prefix.l);
96 print_semantic_function_actual (lf *file,
97 int nr_prefetched_words)
101 if (options.gen.icache || nr_prefetched_words < 0)
103 nr += lf_printf (file, "sd, cache_entry, cia");
108 nr += lf_printf (file, "cpu");
110 nr += lf_printf (file, "sd");
111 for (word_nr = 0; word_nr < nr_prefetched_words; word_nr++)
112 nr += lf_printf (file, ", instruction_%d", word_nr);
113 nr += lf_printf (file, ", cia");
119 print_semantic_function_type (lf *file)
122 nr += lf_printf (file, "%sinstruction_address",
123 options.module.global.prefix.l);
128 /* Idecode functions */
131 print_icache_function_formal (lf *file,
132 int nr_prefetched_words)
137 nr += lf_printf (file, "sim_cpu *cpu,\n");
139 nr += lf_printf (file, "SIM_DESC sd,\n");
140 for (word_nr = 0; word_nr < nr_prefetched_words; word_nr++)
141 nr += lf_printf (file, " %sinstruction_word instruction_%d,\n",
142 options.module.global.prefix.l, word_nr);
143 nr += lf_printf (file, " %sinstruction_address cia,\n",
144 options.module.global.prefix.l);
145 nr += lf_printf (file, " %sidecode_cache *cache_entry",
146 options.module.global.prefix.l);
151 print_icache_function_actual (lf *file,
152 int nr_prefetched_words)
157 nr += lf_printf (file, "cpu");
159 nr += lf_printf (file, "sd");
160 for (word_nr = 0; word_nr < nr_prefetched_words; word_nr++)
161 nr += lf_printf (file, ", instruction_%d", word_nr);
162 nr += lf_printf (file, ", cia, cache_entry");
167 print_icache_function_type (lf *file)
170 if (options.gen.semantic_icache)
172 nr = print_semantic_function_type (file);
176 nr = lf_printf (file, "%sidecode_semantic *",
177 options.module.global.prefix.l);
186 print_opcode_bits (lf *file,
192 nr += lf_putchr (file, '_');
193 nr += lf_putstr (file, bits->field->val_string);
194 if (bits->opcode->is_boolean && bits->value == 0)
195 nr += lf_putint (file, bits->opcode->boolean_constant);
196 else if (!bits->opcode->is_boolean) {
197 if (bits->opcode->last < bits->field->last)
198 nr += lf_putint (file, bits->value << (bits->field->last - bits->opcode->last));
200 nr += lf_putint (file, bits->value);
202 nr += print_opcode_bits (file, bits->next);
207 print_c_name (lf *file,
212 for (pos = name; *pos != '\0'; pos++)
221 nr += lf_putchr (file, '_');
224 nr += lf_putchr (file, *pos);
232 print_function_name (lf *file,
233 const char *basename,
234 const char *format_name,
235 const char *model_name,
236 opcode_bits *expanded_bits,
237 lf_function_name_prefixes prefix)
243 case function_name_prefix_semantics:
244 nr += lf_printf (file, "%s", options.module.semantics.prefix.l);
245 nr += lf_printf (file, "semantic_");
247 case function_name_prefix_idecode:
248 nr += lf_printf (file, "%s", options.module.idecode.prefix.l);
249 nr += lf_printf (file, "idecode_");
251 case function_name_prefix_itable:
252 nr += lf_printf (file, "%sitable_", options.module.itable.prefix.l);
254 case function_name_prefix_icache:
255 nr += lf_printf (file, "%s", options.module.icache.prefix.l);
256 nr += lf_printf (file, "icache_");
258 case function_name_prefix_engine:
259 nr += lf_printf (file, "%s", options.module.engine.prefix.l);
260 nr += lf_printf (file, "engine_");
265 if (model_name != NULL)
267 nr += print_c_name (file, model_name);
268 nr += lf_printf (file, "_");
271 /* the function name */
272 nr += print_c_name (file, basename);
274 /* the format name if available */
275 if (format_name != NULL)
277 nr += lf_printf (file, "_");
278 nr += print_c_name (file, format_name);
282 nr += print_opcode_bits (file, expanded_bits);
289 print_my_defines (lf *file,
290 const char *basename,
291 const char *format_name,
292 opcode_bits *expanded_bits)
294 /* #define MY_INDEX xxxxx */
295 lf_indent_suppress (file);
296 lf_printf (file, "#undef MY_INDEX\n");
297 lf_indent_suppress (file);
298 lf_printf (file, "#define MY_INDEX ");
299 print_function_name (file,
300 basename, format_name, NULL,
302 function_name_prefix_itable);
303 lf_printf (file, "\n");
304 /* #define MY_PREFIX xxxxxx */
305 lf_indent_suppress (file);
306 lf_printf (file, "#undef ");
307 print_function_name (file,
308 basename, format_name, NULL,
310 function_name_prefix_none);
311 lf_printf (file, "\n");
312 lf_indent_suppress (file);
313 lf_printf (file, "#undef MY_PREFIX\n");
314 lf_indent_suppress (file);
315 lf_printf (file, "#define MY_PREFIX ");
316 print_function_name (file,
317 basename, format_name, NULL,
319 function_name_prefix_none);
320 lf_printf (file, "\n");
321 /* #define MY_NAME xxxxxx */
322 lf_indent_suppress (file);
323 lf_indent_suppress (file);
324 lf_printf (file, "#undef MY_NAME\n");
325 lf_indent_suppress (file);
326 lf_printf (file, "#define MY_NAME \"");
327 print_function_name (file,
328 basename, format_name, NULL,
330 function_name_prefix_none);
331 lf_printf (file, "\"\n");
336 print_itrace_prefix (lf *file)
338 const char *prefix = "trace_prefix (";
339 int indent = strlen (prefix);
340 lf_printf (file, "%sSD, CPU, cia, CIA, TRACE_LINENUM_P (CPU), \\\n", prefix);
341 lf_indent (file, +indent);
342 lf_printf (file, "%sitable[MY_INDEX].file, \\\n", options.module.itable.prefix.l);
343 lf_printf (file, "%sitable[MY_INDEX].line_nr, \\\n", options.module.itable.prefix.l);
344 lf_printf (file, "\"");
350 print_itrace_format (lf *file,
351 insn_mnemonic_entry *assembler)
353 /* pass=1 is fmt string; pass=2 is arguments */
355 /* print the format string */
356 for (pass = 1; pass <= 2; pass++)
358 const char *chp = assembler->format;
359 chp++; /* skip the leading quote */
360 /* write out the format/args */
363 if (chp[0] == '\\' && (chp[1] == '<' || chp[1] == '>'))
366 lf_putchr (file, chp[1]);
369 else if (chp[0] == '<' || chp[0] == '%')
371 /* parse [ "%" ... ] "<" [ func "#" ] param ">" */
377 /* the "%" ... "<" format */
379 while (chp[0] != '<' && chp[0] != '\0')
382 error (assembler->line, "Missing `<' after `%%'\n");
384 /* [ "func" # ] OR "param" */
387 while (chp[0] != '>' && chp[0] != '#' && chp[0] != '\0')
389 strlen_func = chp - func;
394 while (chp[0] != '>' && chp[0] != '\0')
397 strlen_param = chp - param;
399 error (assembler->line, "Missing closing `>' in assembler string\n");
403 lf_printf (file, ", \\\n");
404 if (strncmp (fmt, "<", 1) == 0)
405 /* implicit long int format */
408 lf_printf (file, "%%ld");
411 lf_printf (file, "(long) ");
412 lf_write (file, param, strlen_param);
415 else if (strncmp (fmt, "%<", 2) == 0)
416 /* explicit format */
419 lf_printf (file, "%%");
421 lf_write (file, param, strlen_param);
423 else if (strncmp (fmt, "%s<", 3) == 0)
427 lf_printf (file, "%%s");
430 lf_printf (file, "%sstr_", options.module.global.prefix.l);
431 lf_write (file, func, strlen_func);
432 lf_printf (file, " (SD_, ");
433 lf_write (file, param, strlen_param);
434 lf_printf (file, ")");
437 else if (strncmp (fmt, "%lx<", 4) == 0)
441 lf_printf (file, "%%lx");
444 lf_printf (file, "(unsigned long) ");
445 lf_write (file, param, strlen_param);
448 else if (strncmp (fmt, "%08lx<", 6) == 0)
452 lf_printf (file, "%%08lx");
455 lf_printf (file, "(unsigned long) ");
456 lf_write (file, param, strlen_param);
460 error (assembler->line, "Unknown assembler string format\n");
465 lf_putchr (file, chp[0]);
470 lf_printf (file, ");\n");
475 print_itrace (lf *file,
479 /* NB: Here we escape each EOLN. This is so that the the compiler
480 treats a trace function call as a single line. Consequently any
481 errors in the line are refered back to the same igen assembler
483 const char *phase = (idecode) ? "DECODE" : "INSN";
484 lf_printf (file, "\n");
485 lf_indent_suppress (file);
486 lf_printf (file, "#if defined (WITH_TRACE)\n");
487 lf_printf (file, "/* generate a trace prefix if any tracing enabled */\n");
488 lf_printf (file, "if (TRACE_ANY_P (CPU))\n");
489 lf_printf (file, " {\n");
490 lf_indent (file, +4);
492 if (insn->mnemonics != NULL)
494 insn_mnemonic_entry *assembler = insn->mnemonics;
498 if (assembler->condition != NULL)
501 lf_printf (file, "%sif (%s)\n",
502 is_first ? "" : "else ",
503 assembler->condition);
504 lf_indent (file, +2);
505 lf_print__line_ref (file, assembler->line);
506 indent = print_itrace_prefix (file);
507 print_itrace_format (file, assembler);
508 lf_print__internal_ref (file);
509 lf_indent (file, -indent);
510 lf_indent (file, -2);
511 if (assembler->next == NULL)
512 error (assembler->line, "Missing final unconditional assembler\n");
519 lf_printf (file, "else\n");
520 lf_indent (file, +2);
522 lf_print__line_ref (file, assembler->line);
523 indent = print_itrace_prefix (file);
524 print_itrace_format (file, assembler);
525 lf_print__internal_ref (file);
526 lf_indent (file, -indent);
528 lf_indent (file, -2);
529 if (assembler->next != NULL)
530 error (assembler->line, "Unconditional assembler is not last\n");
533 assembler = assembler->next;
535 while (assembler != NULL);
540 lf_indent (file, +2);
541 lf_print__line_ref (file, insn->line);
542 indent = print_itrace_prefix (file);
543 lf_printf (file, "%%s\", \\\n");
544 lf_printf (file, "itable[MY_INDEX].name);\n");
545 lf_print__internal_ref (file);
546 lf_indent (file, -indent);
547 lf_indent (file, -2);
549 lf_printf (file, "/* trace the instruction execution if enabled */\n");
550 lf_printf (file, "if (TRACE_%s_P (CPU))\n", phase);
551 lf_printf (file, " trace_generic (SD, CPU, TRACE_%s_IDX, \" %%s\", itable[MY_INDEX].name);\n", phase);
553 lf_indent (file, -4);
554 lf_printf (file, " }\n");
555 lf_indent_suppress (file);
556 lf_printf (file, "#endif\n");
561 print_sim_engine_abort (lf *file,
564 lf_printf (file, "sim_engine_abort (SD, CPU, cia, ");
565 lf_printf (file, "\"%s\"", message);
566 lf_printf (file, ");\n");
571 print_include (lf *file,
574 lf_printf (file, "#include \"%s%s.h\"\n", module.prefix.l, module.suffix.l);
578 print_include_inline (lf *file,
581 lf_printf (file, "#if C_REVEALS_MODULE_P (%s_INLINE)\n", module.suffix.u);
582 lf_printf (file, "#include \"%s%s.c\"\n", module.prefix.l, module.suffix.l);
583 lf_printf (file, "#else\n");
584 print_include (file, module);
585 lf_printf (file, "#endif\n");
586 lf_printf (file, "\n");
590 print_includes (lf *file)
592 lf_printf (file, "\n");
593 lf_printf (file, "#include \"sim-inline.c\"\n");
594 lf_printf (file, "\n");
595 print_include_inline (file, options.module.itable);
596 print_include_inline (file, options.module.idecode);
597 print_include_inline (file, options.module.support);
601 /****************************************************************/
605 gen_semantics_h (lf *file,
606 insn_list *semantics,
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",
616 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,
650 insn_list *semantics,
651 cache_entry *cache_rules)
653 if (options.gen.code == generate_calls)
656 print_includes (file);
657 print_include (file, options.module.semantics);
658 lf_printf (file, "\n");
660 for (semantic = semantics; semantic != NULL; semantic = semantic->next)
662 /* Ignore any special/internal instructions */
663 if (semantic->insn->nr_words == 0)
665 print_semantic_definition (file,
667 semantic->expanded_bits,
670 semantic->nr_prefetched_words);
675 lf_print__this_file_is_empty (file, "generating jump engine");
680 /****************************************************************/
684 gen_icache_h (lf *file,
686 function_entry *functions,
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,
697 print_icache_function_formal(file, word_nr);
698 lf_printf (file, ");\n");
699 lf_printf (file, "\n");
701 if (options.gen.code == generate_calls
702 && options.gen.icache)
704 function_entry_traverse (file, functions,
705 print_icache_internal_function_declaration,
707 while (semantic != NULL)
709 print_icache_declaration (file,
711 semantic->expanded_bits,
713 semantic->nr_prefetched_words);
714 semantic = semantic->next;
719 lf_print__this_file_is_empty (file, "generating jump engine");
724 gen_icache_c (lf *file,
726 function_entry *functions,
727 cache_entry *cache_rules)
729 /* output `internal' invalid/floating-point unavailable functions
731 if (options.gen.code == generate_calls
732 && options.gen.icache)
734 lf_printf (file, "\n");
735 lf_printf (file, "#include \"cpu.h\"\n");
736 lf_printf (file, "#include \"idecode.h\"\n");
737 lf_printf (file, "#include \"semantics.h\"\n");
738 lf_printf (file, "#include \"icache.h\"\n");
739 lf_printf (file, "#include \"support.h\"\n");
740 lf_printf (file, "\n");
741 function_entry_traverse (file, functions,
742 print_icache_internal_function_definition,
744 lf_printf (file, "\n");
745 while (semantic != NULL)
747 print_icache_definition (file,
749 semantic->expanded_bits,
752 semantic->nr_prefetched_words);
753 semantic = semantic->next;
758 lf_print__this_file_is_empty (file, "generating jump engine");
763 /****************************************************************/
767 gen_idecode_h (lf *file,
770 cache_entry *cache_rules)
772 lf_printf (file, "typedef unsigned%d %sinstruction_word;\n",
773 options.insn_bit_size, options.module.global.prefix.l);
774 if (options.gen.delayed_branch)
776 lf_printf (file, "typedef struct _%sinstruction_address {\n",
777 options.module.global.prefix.l);
778 lf_printf (file, " address_word ip; /* instruction pointer */\n");
779 lf_printf (file, " address_word dp; /* delayed-slot pointer */\n");
780 lf_printf (file, "} %sinstruction_address;\n", options.module.global.prefix.l);
784 lf_printf (file, "typedef address_word %sinstruction_address;\n",
785 options.module.global.prefix.l);
788 if (options.gen.nia == nia_is_invalid
789 && strlen (options.module.global.prefix.u) > 0)
791 lf_indent_suppress (file);
792 lf_printf (file, "#define %sINVALID_INSTRUCTION_ADDRESS ",
793 options.module.global.prefix.u);
794 lf_printf (file, "INVALID_INSTRUCTION_ADDRESS\n");
796 lf_printf (file, "\n");
797 print_icache_struct (file, insns, cache_rules);
798 lf_printf (file, "\n");
799 if (options.gen.icache)
801 ERROR ("FIXME - idecode with icache suffering from bit-rot");
806 for (entry = gen->tables; entry != NULL; entry = entry->next)
808 print_idecode_issue_function_header (file,
809 (options.gen.multi_sim
812 is_function_declaration,
813 1/*ALWAYS ONE WORD*/);
815 if (options.gen.multi_sim)
817 print_idecode_issue_function_header (file,
819 is_function_variable,
820 1/*ALWAYS ONE WORD*/);
827 gen_idecode_c (lf *file,
830 cache_entry *cache_rules)
833 print_includes (file);
834 print_include_inline (file, options.module.semantics);
835 lf_printf (file, "\n");
837 print_idecode_globals (file);
838 lf_printf (file, "\n");
840 switch (options.gen.code)
845 for (entry = gen->tables; entry != NULL; entry = entry->next)
847 print_idecode_lookups (file, entry->table, cache_rules);
849 /* output the main idecode routine */
850 if (!options.gen.icache)
852 print_idecode_issue_function_header (file,
853 (options.gen.multi_sim
857 1/*ALWAYS ONE WORD*/);
858 lf_printf (file, "{\n");
859 lf_indent (file, +2);
860 lf_printf (file, "%sinstruction_address nia;\n",
861 options.module.global.prefix.l);
862 print_idecode_body (file, entry->table, "nia =");
863 lf_printf (file, "return nia;");
864 lf_indent (file, -2);
865 lf_printf (file, "}\n");
872 lf_print__this_file_is_empty (file, "generating a jump engine");
879 /****************************************************************/
887 lf_printf (file, "#include \"sim-main.h\"\n");
888 lf_printf (file, "#include \"engine.h\"\n");
889 lf_printf (file, "#include \"idecode.h\"\n");
890 lf_printf (file, "#include \"bfd.h\"\n");
891 lf_printf (file, "\n");
893 if (options.gen.multi_sim)
895 print_idecode_issue_function_header (file, NULL, is_function_variable, 1);
896 lf_printf (file, "\n");
897 print_engine_run_function_header (file, NULL, is_function_variable);
898 lf_printf (file, "\n");
901 lf_printf (file, "void\n");
902 lf_printf (file, "sim_engine_run (SIM_DESC sd,\n");
903 lf_printf (file, " int next_cpu_nr,\n");
904 lf_printf (file, " int nr_cpus,\n");
905 lf_printf (file, " int siggnal)\n");
906 lf_printf (file, "{\n");
907 lf_indent (file, +2);
908 if (options.gen.multi_sim)
910 lf_printf (file, "int mach;\n");
911 lf_printf (file, "if (STATE_ARCHITECTURE (sd) == NULL)\n");
912 lf_printf (file, " mach = 0;\n");
913 lf_printf (file, "else\n");
914 lf_printf (file, " mach = STATE_ARCHITECTURE (sd)->mach;\n");
915 lf_printf (file, "switch (mach)\n");
916 lf_printf (file, " {\n");
917 lf_indent (file, +2);
918 for (entry = gen->tables; entry != NULL; entry = entry->next)
920 if (options.gen.default_model != NULL
921 && (strcmp (entry->model->name, options.gen.default_model) == 0
922 || strcmp (entry->model->full_name, options.gen.default_model) == 0))
923 lf_printf (file, "default:\n");
924 lf_printf (file, "case bfd_mach_%s:\n", entry->model->full_name);
925 lf_indent (file, +2);
926 print_function_name (file,
928 NULL, /* format name */
929 NULL, /* NO processor */
930 NULL, /* expanded bits */
931 function_name_prefix_idecode);
932 lf_printf (file, " = ");
933 print_function_name (file,
935 NULL, /* format name */
937 NULL, /* expanded bits */
938 function_name_prefix_idecode);
939 lf_printf (file, ";\n");
940 print_function_name (file,
942 NULL, /* format name */
943 NULL, /* NO processor */
944 NULL, /* expanded bits */
945 function_name_prefix_engine);
946 lf_printf (file, " = ");
947 print_function_name (file,
949 NULL, /* format name */
951 NULL, /* expanded bits */
952 function_name_prefix_engine);
953 lf_printf (file, ";\n");
954 lf_printf (file, "break;\n");
955 lf_indent (file, -2);
957 if (options.gen.default_model == NULL)
959 lf_printf (file, "default:\n");
960 lf_indent (file, +2);
961 lf_printf (file, "sim_engine_abort (sd, NULL, NULL_CIA,\n");
962 lf_printf (file, " \"sim_engine_run - unknown machine\");\n");
963 lf_printf (file, "break;\n");
964 lf_indent (file, -2);
966 lf_indent (file, -2);
967 lf_printf (file, " }\n");
969 print_function_name (file,
971 NULL, /* format name */
972 NULL, /* NO processor */
973 NULL, /* expanded bits */
974 function_name_prefix_engine);
975 lf_printf (file, " (sd, next_cpu_nr, nr_cpus, siggnal);\n");
976 lf_indent (file, -2);
977 lf_printf (file, "}\n");
980 /****************************************************************/
983 do_gen (insn_table *isa,
984 decode_table *decode_rules)
987 if (decode_rules == NULL)
988 error (NULL, "Must specify a decode table\n");
990 error (NULL, "Must specify an instruction table\n");
991 if (decode_table_max_word_nr (decode_rules) > 0)
992 options.gen.multi_word = decode_table_max_word_nr (decode_rules);
993 gen = make_gen_tables (isa, decode_rules);
994 gen_tables_expand_insns (gen);
995 gen_tables_expand_semantics (gen);
999 /****************************************************************/
1001 igen_options options;
1008 cache_entry *cache_rules = NULL;
1009 lf_file_references file_references = lf_include_references;
1010 decode_table *decode_rules = NULL;
1011 insn_table *isa = NULL;
1012 gen_table *gen = NULL;
1013 char *real_file_name = NULL;
1016 lf *standard_out = lf_open ("-", "stdout", lf_omit_references, lf_is_text, "igen");
1022 printf ("Usage:\n");
1024 printf (" igen <config-opts> ... <input-opts>... <output-opts>...\n");
1026 printf ("Config options:\n");
1028 printf (" -B <bit-size>\n");
1029 printf ("\t Set the number of bits in an instruction (depreciated).\n");
1030 printf ("\t This option can now be set directly in the instruction table.\n");
1032 printf (" -D <data-structure>\n");
1033 printf ("\t Dump the specified data structure to stdout. Valid structures include:\n");
1034 printf ("\t processor-names - list the names of all the processors (models)\n");
1036 printf (" -F <filter-list>\n");
1037 printf ("\t Filter out any instructions with a non-empty flags field that contains\n");
1038 printf ("\t a flag not listed in the <filter-list>.\n");
1040 printf (" -H <high-bit>\n");
1041 printf ("\t Set the number of the high (most significant) instruction bit (depreciated).\n");
1042 printf ("\t This option can now be set directly in the instruction table.\n");
1044 printf (" -I <directory>\n");
1045 printf ("\t Add <directory> to the list of directories searched when opening a file\n");
1047 printf (" -M <model-list>\n");
1048 printf ("\t Filter out any instructions that do not support at least one of the listed\n");
1049 printf ("\t models (An instructions with no model information is considered to support\n");
1050 printf ("\t all models.).\n");
1052 printf (" -N <nr-cpus>\n");
1053 printf ("\t Generate a simulator supporting <nr-cpus>\n");
1054 printf ("\t Specify `-N 0' to disable generation of the SMP. Specifying `-N 1' will\n");
1055 printf ("\t still generate an SMP enabled simulator but will only support one CPU.\n");
1057 printf (" -T <mechanism>\n");
1058 printf ("\t Override the decode mechanism specified by the decode rules\n");
1060 printf (" -P <prefix>\n");
1061 printf ("\t Prepend global names (except itable) with the string <prefix>.\n");
1062 printf ("\t Specify -P <module>=<prefix> to set a specific <module>'s prefix.\n");
1064 printf (" -S <suffix>\n");
1065 printf ("\t Replace a global name (suffix) (except itable) with the string <suffix>.\n");
1066 printf ("\t Specify -S <module>=<suffix> to change a specific <module>'s name (suffix).\n");
1068 printf (" -Werror\n");
1069 printf ("\t Make warnings errors\n");
1070 printf (" -Wnodiscard\n");
1071 printf ("\t Suppress warnings about discarded functions and instructions\n");
1072 printf (" -Wnowidth\n");
1073 printf ("\t Suppress warnings about instructions with invalid widths\n");
1075 printf (" -G [!]<gen-option>\n");
1076 printf ("\t Any of the following options:\n");
1078 printf ("\t decode-duplicate - Override the decode rules, forcing the duplication of\n");
1079 printf ("\t semantic functions\n");
1080 printf ("\t decode-combine - Combine any duplicated entries within a table\n");
1081 printf ("\t decode-zero-reserved - Override the decode rules, forcing reserved bits to be\n");
1082 printf ("\t treated as zero.\n");
1083 printf ("\t decode-switch-is-goto - Overfide the padded-switch code type as a goto-switch\n");
1085 printf ("\t gen-conditional-issue - conditionally issue each instruction\n");
1086 printf ("\t gen-delayed-branch - need both cia and nia passed around\n");
1087 printf ("\t gen-direct-access - use #defines to directly access values\n");
1088 printf ("\t gen-zero-r<N> - arch assumes GPR(<N>) == 0, keep it that way\n");
1089 printf ("\t gen-icache[=<N> - generate an instruction cracking cache of size <N>\n");
1090 printf ("\t Default size is %d\n", options.gen.icache_size);
1091 printf ("\t gen-insn-in-icache - save original instruction when cracking\n");
1092 printf ("\t gen-multi-sim[=MODEL] - generate multiple simulators - one per model\n");
1093 printf ("\t If specified MODEL is made the default architecture.\n");
1094 printf ("\t By default, a single simulator that will\n");
1095 printf ("\t execute any instruction is generated\n");
1096 printf ("\t gen-multi-word - generate code allowing for multi-word insns\n");
1097 printf ("\t gen-semantic-icache - include semantic code in cracking functions\n");
1098 printf ("\t gen-slot-verification - perform slot verification as part of decode\n");
1099 printf ("\t gen-nia-invalid - NIA defaults to nia_invalid\n");
1100 printf ("\t gen-nia-void - do not compute/return NIA\n");
1102 printf ("\t trace-combine - report combined entries a rule application\n");
1103 printf ("\t trace-entries - report entries after a rules application\n");
1104 printf ("\t trace-rule-rejection - report each rule as rejected\n");
1105 printf ("\t trace-rule-selection - report each rule as selected\n");
1106 printf ("\t trace-insn-insertion - report each instruction as it is inserted into a decode table\n");
1107 printf ("\t trace-rule-expansion - report each instruction as it is expanded (before insertion into a decode table)\n");
1108 printf ("\t trace-all - enable all trace options\n");
1110 printf ("\t field-widths - instruction formats specify widths (depreciated)\n");
1111 printf ("\t By default, an instruction format specifies bit\n");
1112 printf ("\t positions\n");
1113 printf ("\t This option can now be set directly in the\n");
1114 printf ("\t instruction table\n");
1115 printf ("\t jumps - use jumps instead of function calls\n");
1116 printf ("\t omit-line-numbers - do not include line number information in the output\n");
1118 printf ("Input options:\n");
1120 printf (" -k <cache-rules> (depreciated)\n");
1121 printf (" -o <decode-rules>\n");
1122 printf (" -i <instruction-table>\n");
1124 printf ("Output options:\n");
1126 printf (" -x Perform expansion (required)\n");
1127 printf (" -n <real-name> Specify the real name of the next output file\n");
1128 printf (" -h Generate the header (.h) file rather than the body (.c)\n");
1129 printf (" -c <output-file> output icache\n");
1130 printf (" -d <output-file> output idecode\n");
1131 printf (" -e <output-file> output engine\n");
1132 printf (" -f <output-file> output support functions\n");
1133 printf (" -m <output-file> output model\n");
1134 printf (" -r <output-file> output multi-sim run\n");
1135 printf (" -s <output-file> output schematic\n");
1136 printf (" -t <output-file> output itable\n");
1139 while ((ch = getopt(argc, argv,
1140 "B:D:F:G:H:I:M:N:P:T:W:o:k:i:n:hc:d:e:m:r:s:t:f:x"))
1143 fprintf (stderr, " -%c ", ch);
1145 fprintf (stderr, "%s ", optarg);
1146 fprintf (stderr, "\\\n");
1152 filter_parse (&options.model_filter, optarg);
1156 if (strcmp (optarg, "processor-names"))
1159 for (processor = filter_next (options.model_filter, "");
1161 processor = filter_next (options.model_filter, processor))
1162 lf_printf (standard_out, "%s\n", processor);
1165 error (NULL, "Unknown data structure %s, not dumped\n", optarg);
1169 filter_parse (&options.flags_filter, optarg);
1174 table_include **dir = &options.include;
1175 while ((*dir) != NULL)
1176 dir = &(*dir)->next;
1177 (*dir) = ZALLOC (table_include);
1178 (*dir)->dir = strdup (optarg);
1183 options.insn_bit_size = a2i (optarg);
1184 if (options.insn_bit_size <= 0
1185 || options.insn_bit_size > max_insn_bit_size)
1187 error (NULL, "Instruction bitsize must be in range 1..%d\n",
1190 if (options.hi_bit_nr != options.insn_bit_size - 1
1191 && options.hi_bit_nr != 0)
1193 error (NULL, "Conflict betweem hi-bit-nr and insn-bit-size\n");
1198 options.hi_bit_nr = a2i (optarg);
1199 if (options.hi_bit_nr != options.insn_bit_size - 1
1200 && options.hi_bit_nr != 0)
1202 error (NULL, "Conflict between hi-bit-nr and insn-bit-size\n");
1207 options.gen.smp = a2i (optarg);
1216 chp = strchr (optarg, '=');
1219 names = &options.module.global;
1224 chp = chp + 1; /* skip `=' */
1225 if (strncmp (optarg, "global=", chp - optarg) == 0)
1227 names = &options.module.global;
1229 if (strncmp (optarg, "engine=", chp - optarg) == 0)
1231 names = &options.module.engine;
1233 if (strncmp (optarg, "icache=", chp - optarg) == 0)
1235 names = &options.module.icache;
1237 if (strncmp (optarg, "idecode=", chp - optarg) == 0)
1239 names = &options.module.idecode;
1241 if (strncmp (optarg, "itable=", chp - optarg) == 0)
1243 names = &options.module.itable;
1245 if (strncmp (optarg, "semantics=", chp - optarg) == 0)
1247 names = &options.module.semantics;
1249 if (strncmp (optarg, "support=", chp - optarg) == 0)
1251 names = &options.module.support;
1256 error (NULL, "Prefix `%s' unreconized\n", optarg);
1262 name = &names->prefix;
1265 name = &names->suffix;
1268 name->u = strdup (chp);
1269 name->l = strdup (chp);
1273 *chp = toupper(*chp);
1276 if (name == &options.module.global.prefix)
1278 options.module.engine.prefix = options.module.global.prefix;
1279 options.module.icache.prefix = options.module.global.prefix;
1280 options.module.idecode.prefix = options.module.global.prefix;
1281 /* options.module.itable.prefix = options.module.global.prefix; */
1282 options.module.semantics.prefix = options.module.global.prefix;
1283 options.module.support.prefix = options.module.global.prefix;
1285 if (name == &options.module.global.suffix)
1287 options.module.engine.suffix = options.module.global.suffix;
1288 options.module.icache.suffix = options.module.global.suffix;
1289 options.module.idecode.suffix = options.module.global.suffix;
1290 /* options.module.itable.suffix = options.module.global.suffix; */
1291 options.module.semantics.suffix = options.module.global.suffix;
1292 options.module.support.suffix = options.module.global.suffix;
1299 if (strcmp (optarg, "error") == 0)
1300 options.warning = error;
1301 else if (strcmp (optarg, "nodiscard") == 0)
1302 options.warn.discard = 0;
1303 else if (strcmp (optarg, "discard") == 0)
1304 options.warn.discard = 1;
1305 else if (strcmp (optarg, "nowidth") == 0)
1306 options.warn.width = 0;
1307 else if (strcmp (optarg, "width") == 0)
1308 options.warn.width = 1;
1310 error (NULL, "Unknown -W argument `%s'\n", optarg);
1319 if (strncmp (optarg, "no-", strlen ("no-")) == 0)
1321 argp = optarg + strlen ("no-");
1324 else if (strncmp (optarg, "!", strlen ("!")) == 0)
1326 argp = optarg + strlen ("no-");
1334 if (strcmp (argp, "decode-duplicate") == 0)
1336 options.decode.duplicate = enable_p;
1338 else if (strcmp (argp, "decode-combine") == 0)
1340 options.decode.combine = enable_p;
1342 else if (strcmp (argp, "decode-zero-reserved") == 0)
1344 options.decode.zero_reserved = enable_p;
1347 else if (strcmp (argp, "gen-conditional-issue") == 0)
1349 options.gen.conditional_issue = enable_p;
1351 else if (strcmp (argp, "conditional-issue") == 0)
1353 options.gen.conditional_issue = enable_p;
1354 options.warning (NULL, "Option conditional-issue replaced by gen-conditional-issue\n");
1356 else if (strcmp (argp, "gen-delayed-branch") == 0)
1358 options.gen.delayed_branch = enable_p;
1360 else if (strcmp (argp, "delayed-branch") == 0)
1362 options.gen.delayed_branch = enable_p;
1363 options.warning (NULL, "Option delayed-branch replaced by gen-delayed-branch\n");
1365 else if (strcmp (argp, "gen-direct-access") == 0)
1367 options.gen.direct_access = enable_p;
1369 else if (strcmp (argp, "direct-access") == 0)
1371 options.gen.direct_access = enable_p;
1372 options.warning (NULL, "Option direct-access replaced by gen-direct-access\n");
1374 else if (strncmp (argp, "gen-zero-r", strlen ("gen-zero-r")) == 0)
1376 options.gen.zero_reg = enable_p;
1377 options.gen.zero_reg_nr = atoi (argp + strlen ("gen-zero-r"));
1379 else if (strncmp (argp, "zero-r", strlen ("zero-r")) == 0)
1381 options.gen.zero_reg = enable_p;
1382 options.gen.zero_reg_nr = atoi (argp + strlen ("zero-r"));
1383 options.warning (NULL, "Option zero-r<N> replaced by gen-zero-r<N>\n");
1385 else if (strncmp (argp, "gen-icache", strlen ("gen-icache")) == 0)
1387 switch (argp[strlen ("gen-icache")])
1390 options.gen.icache_size = atoi (argp + strlen ("gen-icache") + 1);
1391 options.gen.icache = enable_p;
1394 options.gen.icache = enable_p;
1397 error (NULL, "Expecting -Ggen-icache or -Ggen-icache=<N>\n");
1400 else if (strcmp (argp, "gen-insn-in-icache") == 0)
1402 options.gen.insn_in_icache = enable_p;
1404 else if (strncmp (argp, "gen-multi-sim", strlen ("gen-multi-sim")) == 0)
1406 char *arg = &argp[strlen ("gen-multi-sim")];
1410 options.gen.multi_sim = enable_p;
1411 options.gen.default_model = arg + 1;
1412 if (! filter_is_member (options.model_filter, options.gen.default_model))
1413 error (NULL, "multi-sim model %s unknown\n", options.gen.default_model);
1416 options.gen.multi_sim = enable_p;
1417 options.gen.default_model = NULL;
1420 error (NULL, "Expecting -Ggen-multi-sim or -Ggen-multi-sim=<MODEL>\n");
1424 else if (strcmp (argp, "gen-multi-word") == 0)
1426 options.gen.multi_word = enable_p;
1428 else if (strcmp (argp, "gen-semantic-icache") == 0)
1430 options.gen.semantic_icache = enable_p;
1432 else if (strcmp (argp, "gen-slot-verification") == 0)
1434 options.gen.slot_verification = enable_p;
1436 else if (strcmp (argp, "verify-slot") == 0)
1438 options.gen.slot_verification = enable_p;
1439 options.warning (NULL, "Option verify-slot replaced by gen-slot-verification\n");
1441 else if (strcmp (argp, "gen-nia-invalid") == 0)
1443 options.gen.nia = nia_is_invalid;
1445 else if (strcmp (argp, "default-nia-minus-one") == 0)
1447 options.gen.nia = nia_is_invalid;
1448 options.warning (NULL, "Option default-nia-minus-one replaced by gen-nia-invalid\n");
1450 else if (strcmp (argp, "gen-nia-void") == 0)
1452 options.gen.nia = nia_is_void;
1454 else if (strcmp (argp, "trace-all") == 0)
1456 memset (&options.trace, enable_p, sizeof (options.trace));
1458 else if (strcmp (argp, "trace-combine") == 0)
1460 options.trace.combine = enable_p;
1462 else if (strcmp (argp, "trace-entries") == 0)
1464 options.trace.entries = enable_p;
1466 else if (strcmp (argp, "trace-rule-rejection") == 0)
1468 options.trace.rule_rejection = enable_p;
1470 else if (strcmp (argp, "trace-rule-selection") == 0)
1472 options.trace.rule_selection = enable_p;
1474 else if (strcmp (argp, "trace-insn-insertion") == 0)
1476 options.trace.insn_insertion = enable_p;
1478 else if (strcmp (argp, "trace-insn-expansion") == 0)
1480 options.trace.insn_expansion = enable_p;
1482 else if (strcmp (argp, "jumps") == 0)
1484 options.gen.code = generate_jumps;
1486 else if (strcmp (argp, "field-widths") == 0)
1488 options.insn_specifying_widths = enable_p;
1490 else if (strcmp (argp, "omit-line-numbers") == 0)
1492 file_references = lf_omit_references;
1496 error (NULL, "Unknown option %s\n", optarg);
1502 isa = load_insn_table (optarg, cache_rules);
1503 if (isa->illegal_insn == NULL)
1504 error (NULL, "illegal-instruction missing from insn table\n");
1508 gen = do_gen (isa, decode_rules);
1512 decode_rules = load_decode_table (optarg);
1517 error (NULL, "Cache file must appear before the insn file\n");
1518 cache_rules = load_cache_table (optarg);
1522 real_file_name = strdup(optarg);
1538 lf *file = lf_open(optarg, real_file_name, file_references,
1539 (is_header ? lf_is_h : lf_is_c),
1541 if (gen == NULL && ch != 't' && ch != 'm' && ch != 'f')
1543 options.warning (NULL, "Explicitly generate tables with -x option\n");
1544 gen = do_gen (isa, decode_rules);
1546 lf_print__file_start(file);
1551 gen_model_h (file, isa);
1553 gen_model_c (file, isa);
1557 gen_itable_h (file, isa);
1559 gen_itable_c (file, isa);
1563 gen_support_h (file, isa);
1565 gen_support_c (file, isa);
1569 options.warning (NULL, "-hr option ignored\n");
1571 gen_run_c (file, gen);
1575 gen_semantics_h (file, gen->semantics, isa->max_nr_words);
1577 gen_semantics_c (file, gen->semantics, isa->caches);
1581 gen_idecode_h (file, gen, isa, cache_rules);
1583 gen_idecode_c (file, gen, isa, cache_rules);
1587 gen_engine_h (file, gen, isa, cache_rules);
1589 gen_engine_c (file, gen, isa, cache_rules);
1604 lf_print__file_finish(file);
1608 real_file_name = NULL;
1611 ERROR ("Bad switch");