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