insns.pl

   1 #!/usr/bin/perl
   2 ## --------------------------------------------------------------------------
   3 ##
   4 ##   Copyright 1996-2013 The NASM Authors - All Rights Reserved
   5 ##   See the file AUTHORS included with the NASM distribution for
   6 ##   the specific copyright holders.
   7 ##
   8 ##   Redistribution and use in source and binary forms, with or without
   9 ##   modification, are permitted provided that the following
  10 ##   conditions are met:
  11 ##
  12 ##   * Redistributions of source code must retain the above copyright
  13 ##     notice, this list of conditions and the following disclaimer.
  14 ##   * Redistributions in binary form must reproduce the above
  15 ##     copyright notice, this list of conditions and the following
  16 ##     disclaimer in the documentation and/or other materials provided
  17 ##     with the distribution.
  18 ##
  19 ##     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  20 ##     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  21 ##     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  22 ##     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  23 ##     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  24 ##     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25 ##     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  26 ##     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27 ##     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 ##     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29 ##     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  30 ##     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  31 ##     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 ##
  33 ## --------------------------------------------------------------------------
  34
  35 #
  36 # insns.pl
  37 #
  38 # Parse insns.dat and produce generated source code files
  39
  40 # Opcode prefixes which need their own opcode tables
  41 # LONGER PREFIXES FIRST!
  42 @disasm_prefixes = qw(0F24 0F25 0F38 0F3A 0F7A 0FA6 0FA7 0F);
  43
  44 # This should match MAX_OPERANDS from nasm.h
  45 $MAX_OPERANDS = 5;
  46
  47 # Add VEX/XOP prefixes
  48 @vex_class = ( 'vex', 'xop', 'evex' );
  49 $vex_classes = scalar(@vex_class);
  50 @vexlist = ();
  51 %vexmap = ();
  52 for ($c = 0; $c < $vex_classes; $c++) {
  53     $vexmap{$vex_class[$c]} = $c;
  54     for ($m = 0; $m < 32; $m++) {
  55         for ($p = 0; $p < 4; $p++) {
  56             push(@vexlist, sprintf("%s%02X%01X", $vex_class[$c], $m, $p));
  57         }
  58     }
  59 }
  60 @disasm_prefixes = (@vexlist, @disasm_prefixes);
  61
  62 @bytecode_count = (0) x 256;
  63
  64 print STDERR "Reading insns.dat...\n";
  65
  66 @args   = ();
  67 undef $output;
  68 foreach $arg ( @ARGV ) {
  69     if ( $arg =~ /^\-/ ) {
  70         if  ( $arg =~ /^\-([abdin])$/ ) {
  71             $output = $1;
  72         } else {
  73             die "$0: Unknown option: ${arg}\n";
  74         }
  75     } else {
  76         push (@args, $arg);
  77     }
  78 }
  79
  80 $fname = "insns.dat" unless $fname = $args[0];
  81 open (F, $fname) || die "unable to open $fname";
  82
  83 %dinstables = ();
  84 @bytecode_list = ();
  85
  86 $line = 0;
  87 $insns = 0;
  88 while (<F>) {
  89     $line++;
  90     chomp;
  91     next if ( /^\s*(\;.*|)$/ );   # comments or blank lines
  92
  93     unless (/^\s*(\S+)\s+(\S+)\s+(\S+|\[.*\])\s+(\S+)\s*$/) {
  94         warn "line $line does not contain four fields\n";
  95         next;
  96     }
  97     @fields = ($1, $2, $3, $4);
  98     @field_list = ([@fields, 0]);
  99
 100     if ($fields[1] =~ /\*/) {
 101         # This instruction has relaxed form(s)
 102         if ($fields[2] !~ /^\[/) {
 103             warn "line $line has an * operand but uses raw bytecodes\n";
 104             next;
 105         }
 106
 107         $opmask = 0;
 108         @ops = split(/,/, $fields[1]);
 109         for ($oi = 0; $oi < scalar @ops; $oi++) {
 110             if ($ops[$oi] =~ /\*$/) {
 111                 if ($oi == 0) {
 112                     warn "line $line has a first operand with a *\n";
 113                     next;
 114                 }
 115                 $opmask |= 1 << $oi;
 116             }
 117         }
 118
 119         for ($oi = 1; $oi < (1 << scalar @ops); $oi++) {
 120             if (($oi & ~$opmask) == 0) {
 121                 my @xops = ();
 122                 my $omask = ~$oi;
 123                 for ($oj = 0; $oj < scalar(@ops); $oj++) {
 124                     if ($omask & 1) {
 125                         push(@xops, $ops[$oj]);
 126                     }
 127                     $omask >>= 1;
 128                 }
 129                 push(@field_list, [$fields[0], join(',', @xops),
 130                      $fields[2], $fields[3], $oi]);
 131             }
 132         }
 133     }
 134
 135     foreach $fptr (@field_list) {
 136         @fields = @$fptr;
 137         ($formatted, $nd) = format_insn(@fields);
 138         if ($formatted) {
 139             $insns++;
 140             $aname = "aa_$fields[0]";
 141             push @$aname, $formatted;
 142         }
 143         if ( $fields[0] =~ /cc$/ ) {
 144             # Conditional instruction
 145             $k_opcodes_cc{$fields[0]}++;
 146         } else {
 147             # Unconditional instruction
 148             $k_opcodes{$fields[0]}++;
 149         }
 150         if ($formatted && !$nd) {
 151             push @big, $formatted;
 152             my @sseq = startseq($fields[2], $fields[4]);
 153             foreach $i (@sseq) {
 154                 if (!defined($dinstables{$i})) {
 155                     $dinstables{$i} = [];
 156                 }
 157                 push(@{$dinstables{$i}}, $#big);
 158             }
 159         }
 160     }
 161 }
 162
 163 close F;
 164
 165 #
 166 # Generate the bytecode array.  At this point, @bytecode_list contains
 167 # the full set of bytecodes.
 168 #
 169
 170 # Sort by descending length
 171 @bytecode_list = sort { scalar(@$b) <=> scalar(@$a) } @bytecode_list;
 172 @bytecode_array = ();
 173 %bytecode_pos = ();
 174 $bytecode_next = 0;
 175 foreach $bl (@bytecode_list) {
 176     my $h = hexstr(@$bl);
 177     next if (defined($bytecode_pos{$h}));
 178
 179     push(@bytecode_array, $bl);
 180     while ($h ne '') {
 181         $bytecode_pos{$h} = $bytecode_next;
 182         $h = substr($h, 2);
 183         $bytecode_next++;
 184     }
 185 }
 186 undef @bytecode_list;
 187
 188 @opcodes    = sort keys(%k_opcodes);
 189 @opcodes_cc = sort keys(%k_opcodes_cc);
 190
 191 if ( !defined($output) || $output eq 'b') {
 192     print STDERR "Writing insnsb.c...\n";
 193
 194     open B, ">insnsb.c";
 195
 196     print B "/* This file auto-generated from insns.dat by insns.pl" .
 197         " - don't edit it */\n\n";
 198
 199     print B "#include \"nasm.h\"\n";
 200     print B "#include \"insns.h\"\n\n";
 201
 202     print B "const uint8_t nasm_bytecodes[$bytecode_next] = {\n";
 203
 204     $p = 0;
 205     foreach $bl (@bytecode_array) {
 206         printf B "    /* %5d */ ", $p;
 207         foreach $d (@$bl) {
 208             printf B "%#o,", $d;
 209             $p++;
 210         }
 211         printf B "\n";
 212     }
 213     print B "};\n";
 214
 215     print B "\n";
 216     print B "/*\n";
 217     print B " * Bytecode frequencies (including reuse):\n";
 218     print B " *\n";
 219     for ($i = 0; $i < 32; $i++) {
 220         print B " *";
 221         for ($j = 0; $j < 256; $j += 32) {
 222             print B " |" if ($j);
 223             printf B " %3o:%4d", $i+$j, $bytecode_count[$i+$j];
 224         }
 225         print B "\n";
 226     }
 227     print B " */\n";
 228
 229     close B;
 230 }
 231
 232 if ( !defined($output) || $output eq 'a' ) {
 233     print STDERR "Writing insnsa.c...\n";
 234
 235     open A, ">insnsa.c";
 236
 237     print A "/* This file auto-generated from insns.dat by insns.pl" .
 238         " - don't edit it */\n\n";
 239
 240     print A "#include \"nasm.h\"\n";
 241     print A "#include \"insns.h\"\n\n";
 242
 243     foreach $i (@opcodes, @opcodes_cc) {
 244         print A "static const struct itemplate instrux_${i}[] = {\n";
 245         $aname = "aa_$i";
 246         foreach $j (@$aname) {
 247             print A "    ", codesubst($j), "\n";
 248         }
 249         print A "    ITEMPLATE_END\n};\n\n";
 250     }
 251     print A "const struct itemplate * const nasm_instructions[] = {\n";
 252     foreach $i (@opcodes, @opcodes_cc) {
 253         print A "    instrux_${i},\n";
 254     }
 255     print A "};\n";
 256
 257     close A;
 258 }
 259
 260 if ( !defined($output) || $output eq 'd' ) {
 261     print STDERR "Writing insnsd.c...\n";
 262
 263     open D, ">insnsd.c";
 264
 265     print D "/* This file auto-generated from insns.dat by insns.pl" .
 266         " - don't edit it */\n\n";
 267
 268     print D "#include \"nasm.h\"\n";
 269     print D "#include \"insns.h\"\n\n";
 270
 271     print D "static const struct itemplate instrux[] = {\n";
 272     $n = 0;
 273     foreach $j (@big) {
 274         printf D "    /* %4d */ %s\n", $n++, codesubst($j);
 275     }
 276     print D "};\n";
 277
 278     foreach $h (sort(keys(%dinstables))) {
 279         next if ($h eq ''); # Skip pseudo-instructions
 280             print D "\nstatic const struct itemplate * const itable_${h}[] = {\n";
 281         foreach $j (@{$dinstables{$h}}) {
 282             print D "    instrux + $j,\n";
 283         }
 284         print D "};\n";
 285     }
 286
 287     @prefix_list = ();
 288     foreach $h (@disasm_prefixes, '') {
 289         for ($c = 0; $c < 256; $c++) {
 290             $nn = sprintf("%s%02X", $h, $c);
 291             if ($is_prefix{$nn} || defined($dinstables{$nn})) {
 292                 # At least one entry in this prefix table
 293                 push(@prefix_list, $h);
 294                 $is_prefix{$h} = 1;
 295                 last;
 296             }
 297         }
 298     }
 299
 300     foreach $h (@prefix_list) {
 301         print D "\n";
 302         print D "static " unless ($h eq '');
 303         print D "const struct disasm_index ";
 304         print D ($h eq '') ? 'itable' : "itable_$h";
 305         print D "[256] = {\n";
 306         for ($c = 0; $c < 256; $c++) {
 307             $nn = sprintf("%s%02X", $h, $c);
 308             if ($is_prefix{$nn}) {
 309                 die "$fname: ambiguous decoding of $nn\n"
 310                     if (defined($dinstables{$nn}));
 311                 printf D "    /* 0x%02x */ { itable_%s, -1 },\n", $c, $nn;
 312             } elsif (defined($dinstables{$nn})) {
 313                 printf D "    /* 0x%02x */ { itable_%s, %u },\n", $c,
 314                        $nn, scalar(@{$dinstables{$nn}});
 315             } else {
 316                 printf D "    /* 0x%02x */ { NULL, 0 },\n", $c;
 317             }
 318         }
 319         print D "};\n";
 320     }
 321
 322     printf D "\nconst struct disasm_index * const itable_vex[NASM_VEX_CLASSES][32][4] =\n";
 323     print D "{\n";
 324     for ($c = 0; $c < $vex_classes; $c++) {
 325         print D "    {\n";
 326         for ($m = 0; $m < 32; $m++) {
 327             print D "        { ";
 328             for ($p = 0; $p < 4; $p++) {
 329                 $vp = sprintf("%s%02X%01X", $vex_class[$c], $m, $p);
 330                 printf D "%-15s",
 331                        ($is_prefix{$vp} ? sprintf("itable_%s,", $vp) : 'NULL,');
 332             }
 333             print D "},\n";
 334         }
 335         print D "    },\n";
 336     }
 337     print D "};\n";
 338
 339     close D;
 340 }
 341
 342 if ( !defined($output) || $output eq 'i' ) {
 343     print STDERR "Writing insnsi.h...\n";
 344
 345     open I, ">insnsi.h";
 346
 347     print I "/* This file is auto-generated from insns.dat by insns.pl" .
 348         " - don't edit it */\n\n";
 349     print I "/* This file in included by nasm.h */\n\n";
 350
 351     print I "/* Instruction names */\n\n";
 352     print I "#ifndef NASM_INSNSI_H\n";
 353     print I "#define NASM_INSNSI_H 1\n\n";
 354     print I "enum opcode {\n";
 355     $maxlen = 0;
 356     foreach $i (@opcodes, @opcodes_cc) {
 357         print I "\tI_${i},\n";
 358         $len = length($i);
 359         $len++ if ( $i =~ /cc$/ ); # Condition codes can be 3 characters long
 360         $maxlen = $len if ( $len > $maxlen );
 361     }
 362     print I "\tI_none = -1\n";
 363     print I "};\n\n";
 364     print I "#define MAX_INSLEN ", $maxlen, "\n";
 365     print I "#define NASM_VEX_CLASSES ", $vex_classes, "\n";
 366     print I "#define NO_DECORATOR\t{", join(',',(0) x $MAX_OPERANDS), "}\n";
 367     print I "#define FIRST_COND_OPCODE I_", $opcodes_cc[0], "\n\n";
 368     print I "#endif /* NASM_INSNSI_H */\n";
 369
 370     close I;
 371 }
 372
 373 if ( !defined($output) || $output eq 'n' ) {
 374     print STDERR "Writing insnsn.c...\n";
 375
 376     open N, ">insnsn.c";
 377
 378     print N "/* This file is auto-generated from insns.dat by insns.pl" .
 379         " - don't edit it */\n\n";
 380     print N "#include \"tables.h\"\n\n";
 381
 382     print N "const char * const nasm_insn_names[] = {";
 383     $first = 1;
 384     foreach $i (@opcodes, @opcodes_cc) {
 385         print N "," if ( !$first );
 386         $first = 0;
 387         $ilower = $i;
 388         $ilower =~ s/cc$//;             # Remove conditional cc suffix
 389         $ilower =~ tr/A-Z/a-z/;         # Change to lower case (Perl 4 compatible)
 390         print N "\n\t\"${ilower}\"";
 391     }
 392     print N "\n};\n";
 393     close N;
 394 }
 395
 396 printf STDERR "Done: %d instructions\n", $insns;
 397
 398 # Count primary bytecodes, for statistics
 399 sub count_bytecodes(@) {
 400     my $skip = 0;
 401     foreach my $bc (@_) {
 402         if ($skip) {
 403             $skip--;
 404             next;
 405         }
 406         $bytecode_count[$bc]++;
 407         if ($bc >= 01 && $bc <= 04) {
 408             $skip = $bc;
 409         } elsif (($bc & ~03) == 010) {
 410             $skip = 1;
 411         } elsif (($bc & ~013) == 0144) {
 412             $skip = 1;
 413         } elsif ($bc == 0172 || $bc == 0173) {
 414             $skip = 1;
 415         } elsif (($bc & ~3) == 0260 || $bc == 0270) {   # VEX
 416             $skip = 2;
 417         } elsif (($bc & ~3) == 0240 || $bc == 0250) {   # EVEX
 418             $skip = 3;
 419         } elsif ($bc == 0330) {
 420             $skip = 1;
 421         }
 422     }
 423 }
 424
 425 sub format_insn($$$$$) {
 426     my ($opcode, $operands, $codes, $flags, $relax) = @_;
 427     my $num, $nd = 0;
 428     my @bytecode;
 429     my $op, @ops, $opp, @opx, @oppx, @decos, @opevex;
 430
 431     return (undef, undef) if $operands eq "ignore";
 432
 433     # format the operands
 434     $operands =~ s/\*//g;
 435     $operands =~ s/:/|colon,/g;
 436     @ops = ();
 437     @decos = ();
 438     if ($operands ne 'void') {
 439         foreach $op (split(/,/, $operands)) {
 440             @opx = ();
 441             @opevex = ();
 442             foreach $opp (split(/\|/, $op)) {
 443                 @oppx = ();
 444                 if ($opp =~ s/^(b(32|64)|mask|z|er|sae)$//) {
 445                     push(@opevex, $1);
 446                 }
 447
 448                 if ($opp =~ s/(?<!\d)(8|16|32|64|80|128|256|512)$//) {
 449                     push(@oppx, "bits$1");
 450                 }
 451                 $opp =~ s/^mem$/memory/;
 452                 $opp =~ s/^memory_offs$/mem_offs/;
 453                 $opp =~ s/^imm$/immediate/;
 454                 $opp =~ s/^([a-z]+)rm$/rm_$1/;
 455                 $opp =~ s/^rm$/rm_gpr/;
 456                 $opp =~ s/^reg$/reg_gpr/;
 457                 push(@opx, $opp, @oppx) if $opp;
 458             }
 459             $op = join('|', @opx);
 460             push(@ops, $op);
 461             push(@decos, (@opevex ? join('|', @opevex) : '0'));
 462         }
 463     }
 464
 465     $num = scalar(@ops);
 466     while (scalar(@ops) < $MAX_OPERANDS) {
 467         push(@ops, '0');
 468         push(@decos, '0');
 469     }
 470     $operands = join(',', @ops);
 471     $operands =~ tr/a-z/A-Z/;
 472
 473     $decorators = "{" . join(',', @decos) . "}";
 474     if ($decorators =~ /^{(0,)+0}$/) {
 475         $decorators = "NO_DECORATOR";
 476     }
 477     $decorators =~ tr/a-z/A-Z/;
 478
 479     # format the flags
 480     $flags =~ s/,/|IF_/g;
 481     $flags =~ s/(\|IF_ND|IF_ND\|)//, $nd = 1 if $flags =~ /IF_ND/;
 482     $flags = "IF_" . $flags;
 483
 484     @bytecode = (decodify($codes, $relax), 0);
 485     push(@bytecode_list, [@bytecode]);
 486     $codes = hexstr(@bytecode);
 487     count_bytecodes(@bytecode);
 488
 489     ("{I_$opcode, $num, {$operands}, $decorators, \@\@CODES-$codes\@\@, $flags},", $nd);
 490 }
 491
 492 #
 493 # Look for @@CODES-xxx@@ sequences and replace them with the appropriate
 494 # offset into nasm_bytecodes
 495 #
 496 sub codesubst($) {
 497     my($s) = @_;
 498     my $n;
 499
 500     while ($s =~ /\@\@CODES-([0-9A-F]+)\@\@/) {
 501         my $pos = $bytecode_pos{$1};
 502         if (!defined($pos)) {
 503             die "$fname: no position assigned to byte code $1\n";
 504         }
 505         $s = $` . "nasm_bytecodes+${pos}" . "$'";
 506     }
 507     return $s;
 508 }
 509
 510 sub addprefix ($@) {
 511     my ($prefix, @list) = @_;
 512     my $x;
 513     my @l = ();
 514
 515     foreach $x (@list) {
 516         push(@l, sprintf("%s%02X", $prefix, $x));
 517     }
 518
 519     return @l;
 520 }
 521
 522 #
 523 # Turn a code string into a sequence of bytes
 524 #
 525 sub decodify($$) {
 526   # Although these are C-syntax strings, by convention they should have
 527   # only octal escapes (for directives) and hexadecimal escapes
 528   # (for verbatim bytes)
 529     my($codestr, $relax) = @_;
 530
 531     if ($codestr =~ /^\s*\[([^\]]*)\]\s*$/) {
 532         return byte_code_compile($1, $relax);
 533     }
 534
 535     my $c = $codestr;
 536     my @codes = ();
 537
 538     unless ($codestr eq 'ignore') {
 539         while ($c ne '') {
 540             if ($c =~ /^\\x([0-9a-f]+)(.*)$/i) {
 541                 push(@codes, hex $1);
 542                 $c = $2;
 543                 next;
 544             } elsif ($c =~ /^\\([0-7]{1,3})(.*)$/) {
 545                 push(@codes, oct $1);
 546                 $c = $2;
 547                 next;
 548             } else {
 549                 die "$fname: unknown code format in \"$codestr\"\n";
 550             }
 551         }
 552     }
 553
 554     return @codes;
 555 }
 556
 557 # Turn a numeric list into a hex string
 558 sub hexstr(@) {
 559     my $s = '';
 560     my $c;
 561
 562     foreach $c (@_) {
 563         $s .= sprintf("%02X", $c);
 564     }
 565     return $s;
 566 }
 567
 568 # Here we determine the range of possible starting bytes for a given
 569 # instruction. We need only consider the codes:
 570 # \[1234]      mean literal bytes, of course
 571 # \1[0123]     mean byte plus register value
 572 # \330         means byte plus condition code
 573 # \0 or \340   mean give up and return empty set
 574 # \34[4567]    mean PUSH/POP of segment registers: special case
 575 # \17[234]     skip is4 control byte
 576 # \26x \270    skip VEX control bytes
 577 # \24x \250    skip EVEX control bytes
 578 sub startseq($$) {
 579     my ($codestr, $relax) = @_;
 580     my $word, @range;
 581     my @codes = ();
 582     my $c = $codestr;
 583     my $c0, $c1, $i;
 584     my $prefix = '';
 585
 586     @codes = decodify($codestr, $relax);
 587
 588     while ($c0 = shift(@codes)) {
 589         $c1 = $codes[0];
 590         if ($c0 >= 01 && $c0 <= 04) {
 591             # Fixed byte string
 592             my $fbs = $prefix;
 593             while (1) {
 594                 if ($c0 >= 01 && $c0 <= 04) {
 595                     while ($c0--) {
 596                         $fbs .= sprintf("%02X", shift(@codes));
 597                     }
 598                 } else {
 599                     last;
 600                 }
 601                 $c0 = shift(@codes);
 602             }
 603
 604             foreach $pfx (@disasm_prefixes) {
 605                 if (substr($fbs, 0, length($pfx)) eq $pfx) {
 606                     $prefix = $pfx;
 607                     $fbs = substr($fbs, length($pfx));
 608                     last;
 609                 }
 610             }
 611
 612             if ($fbs ne '') {
 613                 return ($prefix.substr($fbs,0,2));
 614             }
 615
 616             unshift(@codes, $c0);
 617         } elsif ($c0 >= 010 && $c0 <= 013) {
 618             return addprefix($prefix, $c1..($c1+7));
 619         } elsif (($c0 & ~013) == 0144) {
 620             return addprefix($prefix, $c1, $c1|2);
 621         } elsif ($c0 == 0330) {
 622             return addprefix($prefix, $c1..($c1+15));
 623         } elsif ($c0 == 0 || $c0 == 0340) {
 624             return $prefix;
 625         } elsif (($c0 & ~3) == 0260 || $c0 == 0270 ||
 626                  ($c0 & ~3) == 0240 || $c0 == 0250) {
 627             my $c,$m,$wlp;
 628             $m   = shift(@codes);
 629             $wlp = shift(@codes);
 630             $c = ($m >> 6);
 631             $m = $m & 31;
 632             $prefix .= sprintf('%s%02X%01X', $vex_class[$c], $m, $wlp & 3);
 633             if ($c0 < 0260) {
 634                 my $tuple = shift(@codes);
 635             }
 636         } elsif ($c0 >= 0172 && $c0 <= 173) {
 637             shift(@codes);      # Skip is4 control byte
 638         } else {
 639             # We really need to be able to distinguish "forbidden"
 640             # and "ignorable" codes here
 641         }
 642     }
 643     return $prefix;
 644 }
 645
 646 # EVEX tuple types offset is 0300. e.g. 0301 is for full vector(fv).
 647 sub tupletype($) {
 648     my ($tuplestr) = @_;
 649     my %tuple_codes = (
 650         ''      => 000,
 651         'fv'    => 001,
 652         'hv'    => 002,
 653         'fvm'   => 003,
 654         't1s8'  => 004,
 655         't1s16' => 005,
 656         't1s'   => 006,
 657         't1f32' => 007,
 658         't1f64' => 010,
 659         't2'    => 011,
 660         't4'    => 012,
 661         't8'    => 013,
 662         'hvm'   => 014,
 663         'qvm'   => 015,
 664         'ovm'   => 016,
 665         'm128'  => 017,
 666         'dup'   => 020,
 667     );
 668
 669     if (defined $tuple_codes{$tuplestr}) {
 670         return 0300 + $tuple_codes{$tuplestr};
 671     } else {
 672         die "Undefined tuple type : $tuplestr\n";
 673     }
 674 }
 675
 676 #
 677 # This function takes a series of byte codes in a format which is more
 678 # typical of the Intel documentation, and encode it.
 679 #
 680 # The format looks like:
 681 #
 682 # [operands: opcodes]
 683 #
 684 # The operands word lists the order of the operands:
 685 #
 686 # r = register field in the modr/m
 687 # m = modr/m
 688 # v = VEX "v" field
 689 # i = immediate
 690 # s = register field of is4/imz2 field
 691 # - = implicit (unencoded) operand
 692 #
 693 # For an operand that should be filled into more than one field,
 694 # enter it as e.g. "r+v".
 695 #
 696 sub byte_code_compile($$) {
 697     my($str, $relax) = @_;
 698     my $opr;
 699     my $opc;
 700     my @codes = ();
 701     my $litix = undef;
 702     my %oppos = ();
 703     my $i;
 704     my $op, $oq;
 705     my $opex;
 706
 707     my %imm_codes = (
 708         'ib'        => 020,     # imm8
 709         'ib,u'      => 024,     # Unsigned imm8
 710         'iw'        => 030,     # imm16
 711         'ib,s'      => 0274,    # imm8 sign-extended to opsize or bits
 712         'iwd'       => 034,     # imm16 or imm32, depending on opsize
 713         'id'        => 040,     # imm32
 714         'id,s'      => 0254,    # imm32 sign-extended to 64 bits
 715         'iwdq'      => 044,     # imm16/32/64, depending on addrsize
 716         'rel8'      => 050,
 717         'iq'        => 054,
 718         'rel16'     => 060,
 719         'rel'       => 064,     # 16 or 32 bit relative operand
 720         'rel32'     => 070,
 721         'seg'       => 074,
 722     );
 723     my %plain_codes = (
 724         'o16'       => 0320,    # 16-bit operand size
 725         'o32'       => 0321,    # 32-bit operand size
 726         'odf'       => 0322,    # Operand size is default
 727         'o64'       => 0324,    # 64-bit operand size requiring REX.W
 728         'o64nw'     => 0323,    # Implied 64-bit operand size (no REX.W)
 729         'a16'       => 0310,
 730         'a32'       => 0311,
 731         'adf'       => 0312,    # Address size is default
 732         'a64'       => 0313,
 733         '!osp'      => 0364,
 734         '!asp'      => 0365,
 735         'f2i'       => 0332,    # F2 prefix, but 66 for operand size is OK
 736         'f3i'       => 0333,    # F3 prefix, but 66 for operand size is OK
 737         'mustrep'   => 0336,
 738         'mustrepne' => 0337,
 739         'rex.l'     => 0334,
 740         'norexb'    => 0314,
 741         'norexx'    => 0315,
 742         'norexr'    => 0316,
 743         'norexw'    => 0317,
 744         'repe'      => 0335,
 745         'nohi'      => 0325,    # Use spl/bpl/sil/dil even without REX
 746         'nof3'      => 0326,    # No REP 0xF3 prefix permitted
 747         'norep'     => 0331,    # No REP prefix permitted
 748         'wait'      => 0341,    # Needs a wait prefix
 749         'resb'      => 0340,
 750         'jcc8'      => 0370,    # Match only if Jcc possible with single byte
 751         'jmp8'      => 0371,    # Match only if JMP possible with single byte
 752         'jlen'      => 0373,    # Length of jump
 753         'hlexr'     => 0271,
 754         'hlenl'     => 0272,
 755         'hle'       => 0273,
 756
 757         # This instruction takes XMM VSIB
 758         'vsibx'     => 0374,
 759         'vm32x'     => 0374,
 760         'vm64x'     => 0374,
 761
 762         # This instruction takes YMM VSIB
 763         'vsiby'     => 0375,
 764         'vm32y'     => 0375,
 765         'vm64y'     => 0375,
 766
 767         # This instruction takes ZMM VSIB
 768         'vsibz'     => 0376,
 769         'vm32z'     => 0376,
 770         'vm64z'     => 0376,
 771     );
 772
 773     unless ($str =~ /^(([^\s:]*)\:*([^\s:]*)\:|)\s*(.*\S)\s*$/) {
 774         die "$fname: $line: cannot parse: [$str]\n";
 775     }
 776     $opr = "\L$2";
 777     $tuple = "\L$3";    # Tuple type for AVX512
 778     $opc = "\L$4";
 779
 780     my $op = 0;
 781     for ($i = 0; $i < length($opr); $i++) {
 782         my $c = substr($opr,$i,1);
 783         if ($c eq '+') {
 784             $op--;
 785         } else {
 786             if ($relax & 1) {
 787                 $op--;
 788             }
 789             $relax >>= 1;
 790             $oppos{$c} = $op++;
 791         }
 792     }
 793     $tup = tupletype($tuple);
 794
 795     my $last_imm = 'h';
 796     my $prefix_ok = 1;
 797     foreach $op (split(/\s*(?:\s|(?=[\/\\]))/, $opc)) {
 798         my $pc = $plain_codes{$op};
 799
 800         if (defined $pc) {
 801             # Plain code
 802             push(@codes, $pc);
 803         } elsif ($prefix_ok && $op =~ /^(66|f2|f3|np)$/) {
 804             # 66/F2/F3 prefix used as an opcode extension, or np = no prefix
 805             if ($op eq '66') {
 806                 push(@codes, 0361);
 807             } elsif ($op eq 'f2') {
 808                 push(@codes, 0332);
 809             } elsif ($op eq 'f3') {
 810                 push(@codes, 0333);
 811             } else {
 812                 push(@codes, 0360);
 813             }
 814         } elsif ($op =~ /^[0-9a-f]{2}$/) {
 815             if (defined($litix) && $litix+$codes[$litix]+1 == scalar @codes &&
 816                 $codes[$litix] < 4) {
 817                 $codes[$litix]++;
 818                 push(@codes, hex $op);
 819             } else {
 820                 $litix = scalar(@codes);
 821                 push(@codes, 01, hex $op);
 822             }
 823             $prefix_ok = 0;
 824         } elsif ($op eq '/r') {
 825             if (!defined($oppos{'r'}) || !defined($oppos{'m'})) {
 826                 die "$fname: $line: $op requires r and m operands\n";
 827             }
 828             $opex = (($oppos{'m'} & 4) ? 06 : 0) |
 829                 (($oppos{'r'} & 4) ? 05 : 0);
 830             push(@codes, $opex) if ($opex);
 831             push(@codes, 0100 + (($oppos{'m'} & 3) << 3) + ($oppos{'r'} & 3));
 832             $prefix_ok = 0;
 833         } elsif ($op =~ m:^/([0-7])$:) {
 834             if (!defined($oppos{'m'})) {
 835                 die "$fname: $line: $op requires m operand\n";
 836             }
 837             push(@codes, 06) if ($oppos{'m'} & 4);
 838             push(@codes, 0200 + (($oppos{'m'} & 3) << 3) + $1);
 839             $prefix_ok = 0;
 840         } elsif ($op =~ /^(vex|xop)(|\..*)$/) {
 841             my $c = $vexmap{$1};
 842             my ($m,$w,$l,$p) = (undef,2,undef,0);
 843             my $has_nds = 0;
 844             my @subops = split(/\./, $op);
 845             shift @subops;      # Drop prefix
 846                 foreach $oq (@subops) {
 847                     if ($oq eq '128' || $oq eq 'l0' || $oq eq 'lz') {
 848                         $l = 0;
 849                     } elsif ($oq eq '256' || $oq eq 'l1') {
 850                         $l = 1;
 851                     } elsif ($oq eq 'lig') {
 852                         $l = 2;
 853                     } elsif ($oq eq 'w0') {
 854                         $w = 0;
 855                     } elsif ($oq eq 'w1') {
 856                         $w = 1;
 857                     } elsif ($oq eq 'wig') {
 858                         $w = 2;
 859                     } elsif ($oq eq 'ww') {
 860                         $w = 3;
 861                     } elsif ($oq eq 'p0') {
 862                         $p = 0;
 863                     } elsif ($oq eq '66' || $oq eq 'p1') {
 864                         $p = 1;
 865                     } elsif ($oq eq 'f3' || $oq eq 'p2') {
 866                         $p = 2;
 867                     } elsif ($oq eq 'f2' || $oq eq 'p3') {
 868                         $p = 3;
 869                     } elsif ($oq eq '0f') {
 870                         $m = 1;
 871                     } elsif ($oq eq '0f38') {
 872                         $m = 2;
 873                     } elsif ($oq eq '0f3a') {
 874                         $m = 3;
 875                     } elsif ($oq =~ /^m([0-9]+)$/) {
 876                         $m = $1+0;
 877                     } elsif ($oq eq 'nds' || $oq eq 'ndd' || $oq eq 'dds') {
 878                         if (!defined($oppos{'v'})) {
 879                             die "$fname: $line: vex.$oq without 'v' operand\n";
 880                         }
 881                         $has_nds = 1;
 882                     } else {
 883                         die "$fname: $line: undefined VEX subcode: $oq\n";
 884                     }
 885                 }
 886             if (!defined($m) || !defined($w) || !defined($l) || !defined($p)) {
 887                 die "$fname: $line: missing fields in VEX specification\n";
 888             }
 889             if (defined($oppos{'v'}) && !$has_nds) {
 890                 die "$fname: $line: 'v' operand without vex.nds or vex.ndd\n";
 891             }
 892             push(@codes, defined($oppos{'v'}) ? 0260+($oppos{'v'} & 3) : 0270,
 893                  ($c << 6)+$m, ($w << 4)+($l << 2)+$p);
 894             $prefix_ok = 0;
 895         } elsif ($op =~ /^(evex)(|\..*)$/) {
 896             my $c = $vexmap{$1};
 897             my ($m,$w,$l,$p) = (undef,2,undef,0);
 898             my $has_nds = 0;
 899             my @subops = split(/\./, $op);
 900             shift @subops;      # Drop prefix
 901                 foreach $oq (@subops) {
 902                     if ($oq eq '128' || $oq eq 'l0' || $oq eq 'lz' || $oq eq 'lig') {
 903                         $l = 0;
 904                     } elsif ($oq eq '256' || $oq eq 'l1') {
 905                         $l = 1;
 906                     } elsif ($oq eq '512' || $oq eq 'l2') {
 907                         $l = 2;
 908                     } elsif ($oq eq 'w0') {
 909                         $w = 0;
 910                     } elsif ($oq eq 'w1') {
 911                         $w = 1;
 912                     } elsif ($oq eq 'wig') {
 913                         $w = 2;
 914                     } elsif ($oq eq 'ww') {
 915                         $w = 3;
 916                     } elsif ($oq eq 'p0') {
 917                         $p = 0;
 918                     } elsif ($oq eq '66' || $oq eq 'p1') {
 919                         $p = 1;
 920                     } elsif ($oq eq 'f3' || $oq eq 'p2') {
 921                         $p = 2;
 922                     } elsif ($oq eq 'f2' || $oq eq 'p3') {
 923                         $p = 3;
 924                     } elsif ($oq eq '0f') {
 925                         $m = 1;
 926                     } elsif ($oq eq '0f38') {
 927                         $m = 2;
 928                     } elsif ($oq eq '0f3a') {
 929                         $m = 3;
 930                     } elsif ($oq =~ /^m([0-9]+)$/) {
 931                         $m = $1+0;
 932                     } elsif ($oq eq 'nds' || $oq eq 'ndd' || $oq eq 'dds') {
 933                         if (!defined($oppos{'v'})) {
 934                             die "$fname: $line: evex.$oq without 'v' operand\n";
 935                         }
 936                         $has_nds = 1;
 937                     } else {
 938                         die "$fname: $line: undefined EVEX subcode: $oq\n";
 939                     }
 940                 }
 941             if (!defined($m) || !defined($w) || !defined($l) || !defined($p)) {
 942                 die "$fname: $line: missing fields in EVEX specification\n";
 943             }
 944             if (defined($oppos{'v'}) && !$has_nds) {
 945                 die "$fname: $line: 'v' operand without evex.nds or evex.ndd\n";
 946             }
 947             push(@codes, defined($oppos{'v'}) ? 0240+($oppos{'v'} & 3) : 0250,
 948                  ($c << 6)+$m, ($w << 4)+($l << 2)+$p, $tup);
 949             $prefix_ok = 0;
 950         } elsif (defined $imm_codes{$op}) {
 951             if ($op eq 'seg') {
 952                 if ($last_imm lt 'i') {
 953                     die "$fname: $line: seg without an immediate operand\n";
 954                 }
 955             } else {
 956                 $last_imm++;
 957                 if ($last_imm gt 'j') {
 958                     die "$fname: $line: too many immediate operands\n";
 959                 }
 960             }
 961             if (!defined($oppos{$last_imm})) {
 962                 die "$fname: $line: $op without '$last_imm' operand\n";
 963             }
 964             push(@codes, 05) if ($oppos{$last_imm} & 4);
 965             push(@codes, $imm_codes{$op} + ($oppos{$last_imm} & 3));
 966             $prefix_ok = 0;
 967         } elsif ($op eq '/is4') {
 968             if (!defined($oppos{'s'})) {
 969                 die "$fname: $line: $op without 's' operand\n";
 970             }
 971             if (defined($oppos{'i'})) {
 972                 push(@codes, 0172, ($oppos{'s'} << 3)+$oppos{'i'});
 973             } else {
 974                 push(@codes, 05) if ($oppos{'s'} & 4);
 975                 push(@codes, 0174+($oppos{'s'} & 3));
 976             }
 977             $prefix_ok = 0;
 978         } elsif ($op =~ /^\/is4\=([0-9]+)$/) {
 979             my $imm = $1;
 980             if (!defined($oppos{'s'})) {
 981                 die "$fname: $line: $op without 's' operand\n";
 982             }
 983             if ($imm < 0 || $imm > 15) {
 984                 die "$fname: $line: invalid imm4 value for $op: $imm\n";
 985             }
 986             push(@codes, 0173, ($oppos{'s'} << 4) + $imm);
 987             $prefix_ok = 0;
 988         } elsif ($op =~ /^([0-9a-f]{2})\+c$/) {
 989             push(@codes, 0330, hex $1);
 990             $prefix_ok = 0;
 991         } elsif ($op =~ /^([0-9a-f]{2})\+r$/) {
 992             if (!defined($oppos{'r'})) {
 993                 die "$fname: $line: $op without 'r' operand\n";
 994             }
 995             push(@codes, 05) if ($oppos{'r'} & 4);
 996             push(@codes, 010 + ($oppos{'r'} & 3), hex $1);
 997             $prefix_ok = 0;
 998         } elsif ($op =~ /^\\([0-7]+|x[0-9a-f]{2})$/) {
 999             # Escape to enter literal bytecodes
1000             push(@codes, oct $1);
1001         } else {
1002             die "$fname: $line: unknown operation: $op\n";
1003         }
1004     }
1005
1006     return @codes;
1007 }