sim/ppc/igen.c

   1 /*  This file is part of the program psim.
   2
   3     Copyright (C) 1994-1997, Andrew Cagney <cagney@highland.com.au>
   4
   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.
   9
  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.
  14
  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.
  18
  19     */
  20
  21
  22
  23 #include <getopt.h>
  24
  25 #include "misc.h"
  26 #include "lf.h"
  27 #include "table.h"
  28 #include "config.h"
  29
  30 #include "filter.h"
  31
  32 #include "ld-decode.h"
  33 #include "ld-cache.h"
  34 #include "ld-insn.h"
  35
  36 #include "igen.h"
  37
  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-support.h"
  44
  45 int hi_bit_nr;
  46 int insn_bit_size = max_insn_bit_size;
  47
  48 igen_code code = generate_calls;
  49
  50 int generate_expanded_instructions;
  51 int icache_size = 1024;
  52 int generate_smp;
  53
  54 /****************************************************************/
  55
  56 static int
  57 print_insn_bits(lf *file, insn_bits *bits)
  58 {
  59   int nr = 0;
  60   if (bits == NULL)
  61     return nr;
  62   nr += print_insn_bits(file, bits->last);
  63   nr += lf_putchr(file, '_');
  64   nr += lf_putstr(file, bits->field->val_string);
  65   if (bits->opcode->is_boolean && bits->value == 0)
  66     nr += lf_putint(file, bits->opcode->boolean_constant);
  67   else if (!bits->opcode->is_boolean) {
  68     if (bits->opcode->last < bits->field->last)
  69       nr += lf_putint(file, bits->value << (bits->field->last - bits->opcode->last));
  70     else
  71       nr += lf_putint(file, bits->value);
  72   }
  73   return nr;
  74 }
  75
  76 extern int
  77 print_function_name(lf *file,
  78                     const char *basename,
  79                     insn_bits *expanded_bits,
  80                     lf_function_name_prefixes prefix)
  81 {
  82   int nr = 0;
  83   /* the prefix */
  84   switch (prefix) {
  85   case function_name_prefix_semantics:
  86     nr += lf_putstr(file, "semantic_");
  87     break;
  88   case function_name_prefix_idecode:
  89     nr += lf_printf(file, "idecode_");
  90     break;
  91   case function_name_prefix_itable:
  92     nr += lf_putstr(file, "itable_");
  93     break;
  94   case function_name_prefix_icache:
  95     nr += lf_putstr(file, "icache_");
  96     break;
  97   default:
  98     break;
  99   }
 100
 101   /* the function name */
 102   {
 103     const char *pos;
 104     for (pos = basename;
 105          *pos != '\0';
 106          pos++) {
 107       switch (*pos) {
 108       case '/':
 109       case '-':
 110         break;
 111       case ' ':
 112         nr += lf_putchr(file, '_');
 113         break;
 114       default:
 115         nr += lf_putchr(file, *pos);
 116         break;
 117       }
 118     }
 119   }
 120
 121   /* the suffix */
 122   if (generate_expanded_instructions)
 123     nr += print_insn_bits(file, expanded_bits);
 124
 125   return nr;
 126 }
 127
 128
 129 void
 130 print_my_defines(lf *file,
 131                  insn_bits *expanded_bits,
 132                  table_entry *file_entry)
 133 {
 134   /* #define MY_INDEX xxxxx */
 135   lf_indent_suppress(file);
 136   lf_printf(file, "#undef MY_INDEX\n");
 137   lf_indent_suppress(file);
 138   lf_printf(file, "#define MY_INDEX ");
 139   print_function_name(file,
 140                       file_entry->fields[insn_name],
 141                       NULL,
 142                       function_name_prefix_itable);
 143   lf_printf(file, "\n");
 144   /* #define MY_PREFIX xxxxxx */
 145   lf_indent_suppress(file);
 146   lf_printf(file, "#undef MY_PREFIX\n");
 147   lf_indent_suppress(file);
 148   lf_printf(file, "#define MY_PREFIX ");
 149   print_function_name(file,
 150                       file_entry->fields[insn_name],
 151                       expanded_bits,
 152                       function_name_prefix_none);
 153   lf_printf(file, "\n");
 154 }
 155
 156
 157 void
 158 print_itrace(lf *file,
 159              table_entry *file_entry,
 160              int idecode)
 161 {
 162   lf_print__external_reference(file, file_entry->line_nr, file_entry->file_name);
 163   lf_printf(file, "ITRACE(trace_%s, (\"%s %s\\n\"));\n",
 164             (idecode ? "idecode" : "semantics"),
 165             (idecode ? "idecode" : "semantics"),
 166             file_entry->fields[insn_name]);
 167   lf_print__internal_reference(file);
 168 }
 169
 170
 171 /****************************************************************/
 172
 173
 174 static void
 175 gen_semantics_h(insn_table *table,
 176                 lf *file,
 177                 igen_code generate)
 178 {
 179   lf_printf(file, "typedef %s idecode_semantic\n(%s);\n",
 180             SEMANTIC_FUNCTION_TYPE,
 181             SEMANTIC_FUNCTION_FORMAL);
 182   lf_printf(file, "\n");
 183   if ((code & generate_calls)) {
 184     lf_printf(file, "extern int option_mpc860c0;\n");
 185     lf_printf(file, "#define PAGE_SIZE 0x1000\n");
 186     lf_printf(file, "\n");
 187     lf_printf(file, "EXTERN_SEMANTICS(void)\n");
 188     lf_printf(file, "semantic_init(device* root);\n");
 189     lf_printf(file, "\n");
 190     if (generate_expanded_instructions)
 191       insn_table_traverse_tree(table,
 192                                file, NULL,
 193                                1,
 194                                NULL, /* start */
 195                                print_semantic_declaration, /* leaf */
 196                                NULL, /* end */
 197                                NULL); /* padding */
 198     else
 199       insn_table_traverse_insn(table,
 200                                file, NULL,
 201                                print_semantic_declaration);
 202
 203   }
 204   else {
 205     lf_print__this_file_is_empty(file);
 206   }
 207 }
 208
 209
 210 static void
 211 gen_semantics_c(insn_table *table,
 212                 cache_table *cache_rules,
 213                 lf *file,
 214                 igen_code generate)
 215 {
 216   if ((code & generate_calls)) {
 217     lf_printf(file, "\n");
 218     lf_printf(file, "#include \"cpu.h\"\n");
 219     lf_printf(file, "#include \"idecode.h\"\n");
 220     lf_printf(file, "#include \"semantics.h\"\n");
 221     lf_printf(file, "#include \"support.h\"\n");
 222     lf_printf(file, "\n");
 223     lf_printf(file, "int option_mpc860c0 = 0;\n");
 224     lf_printf(file, "\n");
 225     lf_printf(file, "EXTERN_SEMANTICS(void)\n");
 226     lf_printf(file, "semantic_init(device* root)\n");
 227     lf_printf(file, "{\n");
 228     lf_printf(file, "  option_mpc860c0 = 0;\n");
 229     lf_printf(file, "  if (tree_find_property(root, \"/options/mpc860c0\"))\n");
 230     lf_printf(file, "    option_mpc860c0 = tree_find_integer_property(root, \"/options/mpc860c0\");\n");
 231     lf_printf(file, "    option_mpc860c0 *= 4;   /* convert word count to byte count */\n");
 232     lf_printf(file, "}\n");
 233     lf_printf(file, "\n");
 234     if (generate_expanded_instructions)
 235       insn_table_traverse_tree(table,
 236                                file, cache_rules,
 237                                1,
 238                                NULL, /* start */
 239                                print_semantic_definition, /* leaf */
 240                                NULL, /* end */
 241                                NULL); /* padding */
 242     else
 243       insn_table_traverse_insn(table,
 244                                file, cache_rules,
 245                                print_semantic_definition);
 246
 247   }
 248   else {
 249     lf_print__this_file_is_empty(file);
 250   }
 251 }
 252
 253
 254 /****************************************************************/
 255
 256
 257 static void
 258 gen_icache_h(insn_table *table,
 259              lf *file,
 260              igen_code generate)
 261 {
 262   lf_printf(file, "typedef %s idecode_icache\n(%s);\n",
 263             ICACHE_FUNCTION_TYPE,
 264             ICACHE_FUNCTION_FORMAL);
 265   lf_printf(file, "\n");
 266   if ((code & generate_calls)
 267       && (code & generate_with_icache)) {
 268     insn_table_traverse_function(table,
 269                                  file, NULL,
 270                                  print_icache_internal_function_declaration);
 271     if (generate_expanded_instructions)
 272       insn_table_traverse_tree(table,
 273                                file, NULL,
 274                                1,
 275                                NULL, /* start */
 276                                print_icache_declaration, /* leaf */
 277                                NULL, /* end */
 278                                NULL); /* padding */
 279     else
 280       insn_table_traverse_insn(table,
 281                                file, NULL,
 282                                print_icache_declaration);
 283
 284   }
 285   else {
 286     lf_print__this_file_is_empty(file);
 287   }
 288 }
 289
 290 static void
 291 gen_icache_c(insn_table *table,
 292              cache_table *cache_rules,
 293              lf *file,
 294              igen_code generate)
 295 {
 296   /* output `internal' invalid/floating-point unavailable functions
 297      where needed */
 298   if ((code & generate_calls)
 299       && (code & generate_with_icache)) {
 300     lf_printf(file, "\n");
 301     lf_printf(file, "#include \"cpu.h\"\n");
 302     lf_printf(file, "#include \"idecode.h\"\n");
 303     lf_printf(file, "#include \"semantics.h\"\n");
 304     lf_printf(file, "#include \"icache.h\"\n");
 305     lf_printf(file, "#include \"support.h\"\n");
 306     lf_printf(file, "\n");
 307     insn_table_traverse_function(table,
 308                                  file, NULL,
 309                                  print_icache_internal_function_definition);
 310     lf_printf(file, "\n");
 311     if (generate_expanded_instructions)
 312       insn_table_traverse_tree(table,
 313                                file, cache_rules,
 314                                1,
 315                                NULL, /* start */
 316                                print_icache_definition, /* leaf */
 317                                NULL, /* end */
 318                                NULL); /* padding */
 319     else
 320       insn_table_traverse_insn(table,
 321                                file, cache_rules,
 322                                print_icache_definition);
 323
 324   }
 325   else {
 326     lf_print__this_file_is_empty(file);
 327   }
 328 }
 329
 330
 331 /****************************************************************/
 332
 333
 334 int
 335 main(int argc,
 336      char **argv,
 337      char **envp)
 338 {
 339   cache_table *cache_rules = NULL;
 340   lf_file_references file_references = lf_include_references;
 341   decode_table *decode_rules = NULL;
 342   filter *filters = NULL;
 343   insn_table *instructions = NULL;
 344   char *real_file_name = NULL;
 345   int is_header = 0;
 346   int ch;
 347
 348   if (argc == 1) {
 349     printf("Usage:\n");
 350     printf("  igen <config-opts> ... <input-opts>... <output-opts>...\n");
 351     printf("Config options:\n");
 352     printf("  -F <filter-out-flag>  eg -F 64 to skip 64bit instructions\n");
 353     printf("  -E                    Expand (duplicate) semantic functions\n");
 354     printf("  -I <icache-size>      Generate cracking cache version\n");
 355     printf("  -C                    Include semantics in cache functions\n");
 356     printf("  -S                    Include insn (instruction) in icache\n");
 357     printf("  -R                    Use defines to reference cache vars\n");
 358     printf("  -L                    Supress line numbering in output files\n");
 359     printf("  -B <bit-size>         Set the number of bits in an instruction\n");
 360     printf("  -H <high-bit>         Set the nr of the high (msb bit)\n");
 361     printf("  -N <nr-cpus>          Specify the max number of cpus the simulation will support\n");
 362     printf("  -J                    Use jumps instead of function calls\n");
 363     printf("  -T <mechanism>        Override the mechanism used to decode an instruction\n");
 364     printf("                        using <mechanism> instead of what was specified in the\n");
 365     printf("                        decode-rules input file\n");
 366     printf("\n");
 367     printf("Input options (ucase version also dumps loaded table):\n");
 368     printf("  -o <decode-rules>\n");
 369     printf("  -k <cache-rules>\n");
 370     printf("  -i <instruction-table>\n");
 371     printf("\n");
 372     printf("Output options:\n");
 373     printf("  -n <real-name>        Specify the real name of for the next output file\n");
 374     printf("  -h                    Generate header file\n");
 375     printf("  -c <output-file>      output icache\n");
 376     printf("  -d <output-file>      output idecode\n");
 377     printf("  -m <output-file>      output model\n");
 378     printf("  -s <output-file>      output schematic\n");
 379     printf("  -t <output-file>      output itable\n");
 380     printf("  -f <output-file>      output support functions\n");
 381   }
 382
 383   while ((ch = getopt(argc, argv,
 384                       "F:EI:RSLJT:CB:H:N:o:k:i:n:hc:d:m:s:t:f:"))
 385          != -1) {
 386     fprintf(stderr, "\t-%c %s\n", ch, (optarg ? optarg : ""));
 387     switch(ch) {
 388     case 'C':
 389       code |= generate_with_icache;
 390       code |= generate_with_semantic_icache;
 391       break;
 392     case 'S':
 393       code |= generate_with_icache;
 394       code |= generate_with_insn_in_icache;
 395       break;
 396     case 'L':
 397       file_references = lf_omit_references;
 398       break;
 399     case 'E':
 400       generate_expanded_instructions = 1;
 401       break;
 402     case 'I':
 403       icache_size = a2i(optarg);
 404       code |= generate_with_icache;
 405       break;
 406     case 'N':
 407       generate_smp = a2i(optarg);
 408       break;
 409     case 'R':
 410       code |= generate_with_direct_access;
 411       break;
 412     case 'B':
 413       insn_bit_size = a2i(optarg);
 414       ASSERT(insn_bit_size > 0 && insn_bit_size <= max_insn_bit_size
 415              && (hi_bit_nr == insn_bit_size-1 || hi_bit_nr == 0));
 416       break;
 417     case 'H':
 418       hi_bit_nr = a2i(optarg);
 419       ASSERT(hi_bit_nr == insn_bit_size-1 || hi_bit_nr == 0);
 420       break;
 421     case 'F':
 422       filters = new_filter(optarg, filters);
 423       break;
 424     case 'J':
 425       code &= ~generate_calls;
 426       code |= generate_jumps;
 427       break;
 428     case 'T':
 429       force_decode_gen_type(optarg);
 430       break;
 431     case 'i':
 432       if (decode_rules == NULL || cache_rules == NULL) {
 433         fprintf(stderr, "Must specify decode and cache tables\n");
 434         exit (1);
 435       }
 436       instructions = load_insn_table(optarg, decode_rules, filters);
 437       fprintf(stderr, "\texpanding ...\n");
 438       insn_table_expand_insns(instructions);
 439       break;
 440     case 'o':
 441       decode_rules = load_decode_table(optarg, hi_bit_nr);
 442       break;
 443     case 'k':
 444       cache_rules = load_cache_table(optarg, hi_bit_nr);
 445       break;
 446     case 'n':
 447       real_file_name = strdup(optarg);
 448       break;
 449     case 'h':
 450       is_header = 1;
 451       break;
 452     case 's':
 453     case 'd':
 454     case 'm':
 455     case 't':
 456     case 'f':
 457     case 'c':
 458       {
 459         lf *file = lf_open(optarg, real_file_name, file_references,
 460                            (is_header ? lf_is_h : lf_is_c),
 461                            argv[0]);
 462         lf_print__file_start(file);
 463         ASSERT(instructions != NULL);
 464         switch (ch) {
 465         case 's':
 466           if(is_header)
 467             gen_semantics_h(instructions, file, code);
 468           else
 469             gen_semantics_c(instructions, cache_rules, file, code);
 470           break;
 471         case 'd':
 472           if (is_header)
 473             gen_idecode_h(file, instructions, cache_rules);
 474           else
 475             gen_idecode_c(file, instructions, cache_rules);
 476           break;
 477         case 'm':
 478           if (is_header)
 479             gen_model_h(instructions, file);
 480           else
 481             gen_model_c(instructions, file);
 482           break;
 483         case 't':
 484           if (is_header)
 485             gen_itable_h(instructions, file);
 486           else
 487             gen_itable_c(instructions, file);
 488           break;
 489         case 'f':
 490           if (is_header)
 491             gen_support_h(instructions, file);
 492           else
 493             gen_support_c(instructions, file);
 494           break;
 495         case 'c':
 496           if (is_header)
 497             gen_icache_h(instructions, file, code);
 498           else
 499             gen_icache_c(instructions, cache_rules, file, code);
 500           break;
 501         }
 502         lf_print__file_finish(file);
 503         lf_close(file);
 504         is_header = 0;
 505       }
 506       real_file_name = NULL;
 507       break;
 508     default:
 509       error("unknown option\n");
 510     }
 511   }
 512   return 0;
 513 }