insns.pl

   1 #!/usr/bin/perl
   2 ## --------------------------------------------------------------------------
   3 ##
   4 ##   Copyright 1996-2009 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' );
  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 ($lp = 0; $lp < 8; $lp++) {
  56             push(@vexlist, sprintf("%s%02X%01X", $vex_class[$c], $m, $lp));
  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 "    { itable_%s, -1 },\n", $nn;
 312             } elsif (defined($dinstables{$nn})) {
 313                 printf D "    { itable_%s, %u },\n",
 314                 $nn, scalar(@{$dinstables{$nn}});
 315             } else {
 316                 printf D "    { NULL, 0 },\n";
 317             }
 318         }
 319         print D "};\n";
 320     }
 321
 322     printf D "\nconst struct disasm_index * const itable_vex[%d][32][8] =\n",
 323         $vex_classes;
 324     print D "{\n";
 325     for ($c = 0; $c < $vex_classes; $c++) {
 326         print D "    {\n";
 327         for ($m = 0; $m < 32; $m++) {
 328             print D "        {\n";
 329             for ($lp = 0; $lp < 8; $lp++) {
 330                 $vp = sprintf("%s%02X%01X", $vex_class[$c], $m, $lp);
 331                 if ($is_prefix{$vp}) {
 332                     printf D "            itable_%s,\n", $vp;
 333                 } else {
 334                     print  D "            NULL,\n";
 335                 }
 336             }
 337             print D "        },\n";
 338         }
 339         print D "    },\n";
 340     }
 341     print D "};\n";
 342
 343     close D;
 344 }
 345
 346 if ( !defined($output) || $output eq 'i' ) {
 347     print STDERR "Writing insnsi.h...\n";
 348
 349     open I, ">insnsi.h";
 350
 351     print I "/* This file is auto-generated from insns.dat by insns.pl" .
 352         " - don't edit it */\n\n";
 353     print I "/* This file in included by nasm.h */\n\n";
 354
 355     print I "/* Instruction names */\n\n";
 356     print I "#ifndef NASM_INSNSI_H\n";
 357     print I "#define NASM_INSNSI_H 1\n\n";
 358     print I "enum opcode {\n";
 359     $maxlen = 0;
 360     foreach $i (@opcodes, @opcodes_cc) {
 361         print I "\tI_${i},\n";
 362         $len = length($i);
 363         $len++ if ( $i =~ /cc$/ ); # Condition codes can be 3 characters long
 364         $maxlen = $len if ( $len > $maxlen );
 365     }
 366     print I "\tI_none = -1\n";
 367     print I "\n};\n\n";
 368     print I "#define MAX_INSLEN ", $maxlen, "\n";
 369     print I "#define FIRST_COND_OPCODE I_", $opcodes_cc[0], "\n\n";
 370     print I "#endif /* NASM_INSNSI_H */\n";
 371
 372     close I;
 373 }
 374
 375 if ( !defined($output) || $output eq 'n' ) {
 376     print STDERR "Writing insnsn.c...\n";
 377
 378     open N, ">insnsn.c";
 379
 380     print N "/* This file is auto-generated from insns.dat by insns.pl" .
 381         " - don't edit it */\n\n";
 382     print N "#include \"tables.h\"\n\n";
 383
 384     print N "const char * const nasm_insn_names[] = {";
 385     $first = 1;
 386     foreach $i (@opcodes, @opcodes_cc) {
 387         print N "," if ( !$first );
 388         $first = 0;
 389         $ilower = $i;
 390         $ilower =~ s/cc$//;     # Remove conditional cc suffix
 391         $ilower =~ tr/A-Z/a-z/; # Change to lower case (Perl 4 compatible)
 392         print N "\n\t\"${ilower}\"";
 393     }
 394     print N "\n};\n";
 395     close N;
 396 }
 397
 398 printf STDERR "Done: %d instructions\n", $insns;
 399
 400 # Count primary bytecodes, for statistics
 401 sub count_bytecodes(@) {
 402     my $skip = 0;
 403     foreach my $bc (@_) {
 404         if ($skip) {
 405             $skip--;
 406             next;
 407         }
 408         $bytecode_count[$bc]++;
 409         if ($bc >= 01 && $bc <= 04) {
 410             $skip = $bc;
 411         } elsif (($bc & ~03) == 010) {
 412             $skip = 1;
 413         } elsif (($bc & ~013) == 0144) {
 414             $skip = 1;
 415         } elsif ($bc == 0172) {
 416             $skip = 1;
 417         } elsif ($bc >= 0260 && $bc <= 0270) {
 418             $skip = 2;
 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;
 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     if ($operands ne 'void') {
 438         foreach $op (split(/,/, $operands)) {
 439             if ($op =~ /^\=([0-9]+)$/) {
 440                 $op = "same_as|$1";
 441             } else {
 442                 @opx = ();
 443                 foreach $opp (split(/\|/, $op)) {
 444                     @oppx = ();
 445                     if ($opp =~ /^(.*[^\d])(8|16|32|64|80|128|256)$/) {
 446                         my $ox = $1;
 447                         my $on = $2;
 448                         if ($ox !~ /^sbyte$/) {
 449                             $opp = $ox;
 450                             push(@oppx, "bits$on");
 451                         }
 452                     }
 453                     $opp =~ s/^mem$/memory/;
 454                     $opp =~ s/^memory_offs$/mem_offs/;
 455                     $opp =~ s/^imm$/immediate/;
 456                     $opp =~ s/^([a-z]+)rm$/rm_$1/;
 457                     $opp =~ s/^rm$/rm_gpr/;
 458                     $opp =~ s/^reg$/reg_gpr/;
 459                     push(@opx, $opp, @oppx);
 460                 }
 461                 $op = join('|', @opx);
 462             }
 463             push(@ops, $op);
 464         }
 465     }
 466
 467     $num = scalar(@ops);
 468     while (scalar(@ops) < $MAX_OPERANDS) {
 469         push(@ops, '0');
 470     }
 471     $operands = join(',', @ops);
 472     $operands =~ tr/a-z/A-Z/;
 473
 474     # format the flags
 475     $flags =~ s/,/|IF_/g;
 476     $flags =~ s/(\|IF_ND|IF_ND\|)//, $nd = 1 if $flags =~ /IF_ND/;
 477     $flags = "IF_" . $flags;
 478
 479     @bytecode = (decodify($codes, $relax), 0);
 480     push(@bytecode_list, [@bytecode]);
 481     $codes = hexstr(@bytecode);
 482     count_bytecodes(@bytecode);
 483
 484     ("{I_$opcode, $num, {$operands}, \@\@CODES-$codes\@\@, $flags},", $nd);
 485 }
 486
 487 #
 488 # Look for @@CODES-xxx@@ sequences and replace them with the appropriate
 489 # offset into nasm_bytecodes
 490 #
 491 sub codesubst($) {
 492     my($s) = @_;
 493     my $n;
 494
 495     while ($s =~ /\@\@CODES-([0-9A-F]+)\@\@/) {
 496         my $pos = $bytecode_pos{$1};
 497         if (!defined($pos)) {
 498             die "$fname: no position assigned to byte code $1\n";
 499         }
 500         $s = $` . "nasm_bytecodes+${pos}" . "$'";
 501     }
 502     return $s;
 503 }
 504
 505 sub addprefix ($@) {
 506     my ($prefix, @list) = @_;
 507     my $x;
 508     my @l = ();
 509
 510     foreach $x (@list) {
 511         push(@l, sprintf("%s%02X", $prefix, $x));
 512     }
 513
 514     return @l;
 515 }
 516
 517 #
 518 # Turn a code string into a sequence of bytes
 519 #
 520 sub decodify($$) {
 521   # Although these are C-syntax strings, by convention they should have
 522   # only octal escapes (for directives) and hexadecimal escapes
 523   # (for verbatim bytes)
 524     my($codestr, $relax) = @_;
 525
 526     if ($codestr =~ /^\s*\[([^\]]*)\]\s*$/) {
 527         return byte_code_compile($1, $relax);
 528     }
 529
 530     my $c = $codestr;
 531     my @codes = ();
 532
 533     while ($c ne '') {
 534         if ($c =~ /^\\x([0-9a-f]+)(.*)$/i) {
 535             push(@codes, hex $1);
 536             $c = $2;
 537             next;
 538         } elsif ($c =~ /^\\([0-7]{1,3})(.*)$/) {
 539             push(@codes, oct $1);
 540             $c = $2;
 541             next;
 542         } else {
 543             die "$fname: unknown code format in \"$codestr\"\n";
 544         }
 545     }
 546
 547     return @codes;
 548 }
 549
 550 # Turn a numeric list into a hex string
 551 sub hexstr(@) {
 552     my $s = '';
 553     my $c;
 554
 555     foreach $c (@_) {
 556         $s .= sprintf("%02X", $c);
 557     }
 558     return $s;
 559 }
 560
 561 # Here we determine the range of possible starting bytes for a given
 562 # instruction. We need only consider the codes:
 563 # \[1234]      mean literal bytes, of course
 564 # \1[0123]     mean byte plus register value
 565 # \330         means byte plus condition code
 566 # \0 or \340   mean give up and return empty set
 567 # \34[4567]    mean PUSH/POP of segment registers: special case
 568 # \17[234]     skip is4 control byte
 569 # \26x \270    skip VEX control bytes
 570 sub startseq($$) {
 571     my ($codestr, $relax) = @_;
 572     my $word, @range;
 573     my @codes = ();
 574     my $c = $codestr;
 575     my $c0, $c1, $i;
 576     my $prefix = '';
 577
 578     @codes = decodify($codestr, $relax);
 579
 580     while ($c0 = shift(@codes)) {
 581         $c1 = $codes[0];
 582         if ($c0 >= 01 && $c0 <= 04) {
 583             # Fixed byte string
 584             my $fbs = $prefix;
 585             while (1) {
 586                 if ($c0 >= 01 && $c0 <= 04) {
 587                     while ($c0--) {
 588                         $fbs .= sprintf("%02X", shift(@codes));
 589                     }
 590                 } else {
 591                     last;
 592                 }
 593                 $c0 = shift(@codes);
 594             }
 595
 596             foreach $pfx (@disasm_prefixes) {
 597                 if (substr($fbs, 0, length($pfx)) eq $pfx) {
 598                     $prefix = $pfx;
 599                     $fbs = substr($fbs, length($pfx));
 600                     last;
 601                 }
 602             }
 603
 604             if ($fbs ne '') {
 605                 return ($prefix.substr($fbs,0,2));
 606             }
 607
 608             unshift(@codes, $c0);
 609         } elsif ($c0 >= 010 && $c0 <= 013) {
 610             return addprefix($prefix, $c1..($c1+7));
 611         } elsif (($c0 & ~013) == 0144) {
 612             return addprefix($prefix, $c1, $c1|2);
 613         } elsif ($c0 == 0330) {
 614             return addprefix($prefix, $c1..($c1+15));
 615         } elsif ($c0 == 0 || $c0 == 0340) {
 616             return $prefix;
 617         } elsif ($c0 == 0344) {
 618             return addprefix($prefix, 0x06, 0x0E, 0x16, 0x1E);
 619         } elsif ($c0 == 0345) {
 620             return addprefix($prefix, 0x07, 0x17, 0x1F);
 621         } elsif ($c0 == 0346) {
 622             return addprefix($prefix, 0xA0, 0xA8);
 623         } elsif ($c0 == 0347) {
 624             return addprefix($prefix, 0xA1, 0xA9);
 625         } elsif (($c0 & ~3) == 0260 || $c0 == 0270) {
 626             my $c,$m,$wlp;
 627             $m   = shift(@codes);
 628             $wlp = shift(@codes);
 629             $c = ($m >> 6);
 630             $m = $m & 31;
 631             $prefix .= sprintf('%s%02X%01X', $vex_class[$c], $m, $wlp & 7);
 632         } elsif ($c0 >= 0172 && $c0 <= 174) {
 633             shift(@codes);      # Skip is4 control byte
 634         } else {
 635             # We really need to be able to distinguish "forbidden"
 636             # and "ignorable" codes here
 637         }
 638     }
 639     return $prefix;
 640 }
 641
 642 #
 643 # This function takes a series of byte codes in a format which is more
 644 # typical of the Intel documentation, and encode it.
 645 #
 646 # The format looks like:
 647 #
 648 # [operands: opcodes]
 649 #
 650 # The operands word lists the order of the operands:
 651 #
 652 # r = register field in the modr/m
 653 # m = modr/m
 654 # v = VEX "v" field
 655 # d = DREX "dst" field
 656 # i = immediate
 657 # s = register field of is4/imz2 field
 658 # - = implicit (unencoded) operand
 659 #
 660 # For an operand that should be filled into more than one field,
 661 # enter it as e.g. "r+v".
 662 #
 663 sub byte_code_compile($$) {
 664     my($str, $relax) = @_;
 665     my $opr;
 666     my $opc;
 667     my @codes = ();
 668     my $litix = undef;
 669     my %oppos = ();
 670     my $i;
 671     my $op, $oq;
 672     my $opex;
 673
 674     unless ($str =~ /^(([^\s:]*)\:|)\s*(.*\S)\s*$/) {
 675         die "$fname: $line: cannot parse: [$str]\n";
 676     }
 677     $opr = "\L$2";
 678     $opc = "\L$3";
 679
 680     my $op = 0;
 681     for ($i = 0; $i < length($opr); $i++) {
 682         my $c = substr($opr,$i,1);
 683         if ($c eq '+') {
 684             $op--;
 685         } else {
 686             if ($relax & 1) {
 687                 $op--;
 688             }
 689             $relax >>= 1;
 690             $oppos{$c} = $op++;
 691         }
 692     }
 693
 694     $prefix_ok = 1;
 695     foreach $op (split(/\s*(?:\s|(?=[\/\\]))/, $opc)) {
 696         if ($op eq 'o16') {
 697             push(@codes, 0320);
 698         } elsif ($op eq 'o32') {
 699             push(@codes, 0321);
 700         } elsif ($op eq 'o64') {  # 64-bit operand size requiring REX.W
 701             push(@codes, 0324);
 702         } elsif ($op eq 'o64nw') { # Implied 64-bit operand size (no REX.W)
 703             push(@codes, 0323);
 704         } elsif ($op eq 'a16') {
 705             push(@codes, 0310);
 706         } elsif ($op eq 'a32') {
 707             push(@codes, 0311);
 708         } elsif ($op eq 'a64') {
 709             push(@codes, 0313);
 710         } elsif ($op eq '!osp') {
 711             push(@codes, 0364);
 712         } elsif ($op eq '!asp') {
 713             push(@codes, 0365);
 714         } elsif ($op eq 'rex.l') {
 715             push(@codes, 0334);
 716         } elsif ($op eq 'repe') {
 717             push(@codes, 0335);
 718         } elsif ($op eq 'nohi') { # Use spl/bpl/sil/dil even without REX
 719             push(@codes, 0325);
 720         } elsif ($prefix_ok && $op =~ /^(66|f2|f3|np)$/) {
 721             # 66/F2/F3 prefix used as an opcode extension, or np = no prefix
 722             if ($op eq '66') {
 723                 push(@codes, 0361);
 724             } elsif ($op eq 'f2') {
 725                 push(@codes, 0362);
 726             } elsif ($op eq 'f3') {
 727                 push(@codes, 0363);
 728             } else {
 729                 push(@codes, 0360);
 730             }
 731         } elsif ($op =~ /^[0-9a-f]{2}$/) {
 732             if (defined($litix) && $litix+$codes[$litix]+1 == scalar @codes &&
 733                 $codes[$litix] < 4) {
 734                 $codes[$litix]++;
 735                 push(@codes, hex $op);
 736             } else {
 737                 $litix = scalar(@codes);
 738                 push(@codes, 01, hex $op);
 739             }
 740             $prefix_ok = 0;
 741         } elsif ($op eq '/r') {
 742             if (!defined($oppos{'r'}) || !defined($oppos{'m'})) {
 743                 die "$fname: $line: $op requires r and m operands\n";
 744             }
 745             $opex = (($oppos{'m'} & 4) ? 06 : 0) |
 746                     (($oppos{'r'} & 4) ? 05 : 0);
 747             push(@codes, $opex) if ($opex);
 748             push(@codes, 0100 + (($oppos{'m'} & 3) << 3) + ($oppos{'r'} & 3));
 749             $prefix_ok = 0;
 750         } elsif ($op =~ m:^/([0-7])$:) {
 751             if (!defined($oppos{'m'})) {
 752                 die "$fname: $line: $op requires m operand\n";
 753             }
 754             push(@codes, 06) if ($oppos{'m'} & 4);
 755             push(@codes, 0200 + (($oppos{'m'} & 3) << 3) + $1);
 756             $prefix_ok = 0;
 757         } elsif ($op =~ /^(vex|xop)(|\..*)$/) {
 758             my $c = $vexmap{$1};
 759             my ($m,$w,$l,$p) = (undef,2,undef,0);
 760             my $has_nds = 0;
 761             my @subops = split(/\./, $op);
 762             shift @subops;      # Drop prefix
 763             foreach $oq (@subops) {
 764                 if ($oq eq '128' || $oq eq 'l0') {
 765                     $l = 0;
 766                 } elsif ($oq eq '256' || $oq eq 'l1') {
 767                     $l = 1;
 768                 } elsif ($oq eq 'w0') {
 769                     $w = 0;
 770                 } elsif ($oq eq 'w1') {
 771                     $w = 1;
 772                 } elsif ($oq eq 'wx') {
 773                     $w = 2;
 774                 } elsif ($oq eq 'ww') {
 775                     $w = 3;
 776                 } elsif ($oq eq 'p0') {
 777                     $p = 0;
 778                 } elsif ($oq eq '66' || $oq eq 'p1') {
 779                     $p = 1;
 780                 } elsif ($oq eq 'f3' || $oq eq 'p2') {
 781                     $p = 2;
 782                 } elsif ($oq eq 'f2' || $oq eq 'p3') {
 783                     $p = 3;
 784                 } elsif ($oq eq '0f') {
 785                     $m = 1;
 786                 } elsif ($oq eq '0f38') {
 787                     $m = 2;
 788                 } elsif ($oq eq '0f3a') {
 789                     $m = 3;
 790                 } elsif ($oq =~ /^m([0-9]+)$/) {
 791                     $m = $1+0;
 792                 } elsif ($oq eq 'nds' || $oq eq 'ndd' || $oq eq 'dds') {
 793                     if (!defined($oppos{'v'})) {
 794                         die "$fname: $line: vex.$oq without 'v' operand\n";
 795                     }
 796                     $has_nds = 1;
 797                 } else {
 798                     die "$fname: $line: undefined VEX subcode: $oq\n";
 799                 }
 800             }
 801             if (!defined($m) || !defined($w) || !defined($l) || !defined($p)) {
 802                 die "$fname: $line: missing fields in VEX specification\n";
 803             }
 804             if (defined($oppos{'v'}) && !$has_nds) {
 805                 die "$fname: $line: 'v' operand without vex.nds or vex.ndd\n";
 806             }
 807             push(@codes, defined($oppos{'v'}) ? 0260+($oppos{'v'} & 3) : 0270,
 808                  ($c << 6)+$m, ($w << 3)+($l << 2)+$p);
 809             $prefix_ok = 0;
 810         } elsif ($op =~ /^\/drex([01])$/) {
 811             my $oc0 = $1;
 812             if (!defined($oppos{'d'})) {
 813                 die "$fname: $line: DREX without a 'd' operand\n";
 814             }
 815             # Note the use of *unshift* here, as opposed to *push*.
 816             # This is because NASM want this byte code at the start of
 817             # the instruction sequence, but the AMD documentation puts
 818             # this at (roughly) the position of the drex byte itself.
 819             # This allows us to match the AMD documentation and still
 820             # do the right thing.
 821             unshift(@codes, 0160+($oppos{'d'} & 3)+($oc0 ? 4 : 0));
 822             unshift(@codes, 05) if ($oppos{'d'} & 4);
 823         } elsif ($op =~ /^(ib\,s|ib|ibx|ib\,w|iw|iwd|id|idx|iwdq|rel|rel8|rel16|rel32|iq|seg|ibw|ibd|ibd,s)$/) {
 824             if (!defined($oppos{'i'})) {
 825                 die "$fname: $line: $op without 'i' operand\n";
 826             }
 827             if ($op eq 'ib,s') { # Signed imm8
 828                 push(@codes, 05) if ($oppos{'i'} & 4);
 829                 push(@codes, 014+($oppos{'i'} & 3));
 830             } elsif ($op eq 'ib') { # imm8
 831                 push(@codes, 05) if ($oppos{'i'} & 4);
 832                 push(@codes, 020+($oppos{'i'} & 3));
 833             } elsif ($op eq 'ib,u') { # Unsigned imm8
 834                 push(@codes, 05) if ($oppos{'i'} & 4);
 835                 push(@codes, 024+($oppos{'i'} & 3));
 836             } elsif ($op eq 'iw') { # imm16
 837                 push(@codes, 05) if ($oppos{'i'} & 4);
 838                 push(@codes, 030+($oppos{'i'} & 3));
 839             } elsif ($op eq 'ibx') { # imm8 sign-extended to opsize
 840                 push(@codes, 05) if ($oppos{'i'} & 4);
 841                 push(@codes, 0274+($oppos{'i'} & 3));
 842             } elsif ($op eq 'iwd') { # imm16 or imm32, depending on opsize
 843                 push(@codes, 05) if ($oppos{'i'} & 4);
 844                 push(@codes, 034+($oppos{'i'} & 3));
 845             } elsif ($op eq 'id') { # imm32
 846                 push(@codes, 05) if ($oppos{'i'} & 4);
 847                 push(@codes, 040+($oppos{'i'} & 3));
 848             } elsif ($op eq 'idx') { # imm32 extended to 64 bits
 849                 push(@codes, 05) if ($oppos{'i'} & 4);
 850                 push(@codes, 0254+($oppos{'i'} & 3));
 851             } elsif ($op eq 'iwdq') { # imm16/32/64, depending on opsize
 852                 push(@codes, 05) if ($oppos{'i'} & 4);
 853                 push(@codes, 044+($oppos{'i'} & 3));
 854             } elsif ($op eq 'rel8') {
 855                 push(@codes, 05) if ($oppos{'i'} & 4);
 856                 push(@codes, 050+($oppos{'i'} & 3));
 857             } elsif ($op eq 'iq') {
 858                 push(@codes, 05) if ($oppos{'i'} & 4);
 859                 push(@codes, 054+($oppos{'i'} & 3));
 860             } elsif ($op eq 'rel16') {
 861                 push(@codes, 05) if ($oppos{'i'} & 4);
 862                 push(@codes, 060+($oppos{'i'} & 3));
 863             } elsif ($op eq 'rel') { # 16 or 32 bit relative operand
 864                 push(@codes, 05) if ($oppos{'i'} & 4);
 865                 push(@codes, 064+($oppos{'i'} & 3));
 866             } elsif ($op eq 'rel32') {
 867                 push(@codes, 05) if ($oppos{'i'} & 4);
 868                 push(@codes, 070+($oppos{'i'} & 3));
 869             } elsif ($op eq 'seg') {
 870                 push(@codes, 05) if ($oppos{'i'} & 4);
 871                 push(@codes, 074+($oppos{'i'} & 3));
 872             } elsif ($op eq 'ibw') { # imm16 that can be bytified
 873                 if (!defined($s_pos)) {
 874                     die "$fname: $line: $op without a +s byte\n";
 875                 }
 876                 $codes[$s_pos] += 0144;
 877                 push(@codes, 05) if ($oppos{'i'} & 4);
 878                 push(@codes, 0140+($oppos{'i'} & 3));
 879             } elsif ($op eq 'ibd') { # imm32 that can be bytified
 880                 if (!defined($s_pos)) {
 881                     die "$fname: $line: $op without a +s byte\n";
 882                 }
 883                 $codes[$s_pos] += 0154;
 884                 push(@codes, 05) if ($oppos{'i'} & 4);
 885                 push(@codes, 0150+($oppos{'i'} & 3));
 886             } elsif ($op eq 'ibd,s') {
 887                 # imm32 that can be bytified, sign extended to 64 bits
 888                 if (!defined($s_pos)) {
 889                     die "$fname: $line: $op without a +s byte\n";
 890                 }
 891                 $codes[$s_pos] += 0154;
 892                 push(@codes, 05) if ($oppos{'i'} & 4);
 893                 push(@codes, 0250+($oppos{'i'} & 3));
 894             }
 895             $prefix_ok = 0;
 896         } elsif ($op eq '/is4') {
 897             if (!defined($oppos{'s'})) {
 898                 die "$fname: $line: $op without 's' operand\n";
 899             }
 900             if (defined($oppos{'i'})) {
 901                 push(@codes, 0172, ($oppos{'s'} << 3)+$oppos{'i'});
 902             } else {
 903                 push(@codes, 0174, $oppos{'s'});
 904             }
 905             $prefix_ok = 0;
 906         } elsif ($op =~ /^\/is4\=([0-9]+)$/) {
 907             my $imm = $1;
 908             if (!defined($oppos{'s'})) {
 909                 die "$fname: $line: $op without 's' operand\n";
 910             }
 911             if ($imm < 0 || $imm > 15) {
 912                 die "$fname: $line: invalid imm4 value for $op: $imm\n";
 913             }
 914             push(@codes, 0173, ($oppos{'s'} << 4) + $imm);
 915             $prefix_ok = 0;
 916         } elsif ($op =~ /^([0-9a-f]{2})\+s$/) {
 917             if (!defined($oppos{'i'})) {
 918                 die "$fname: $line: $op without 'i' operand\n";
 919             }
 920             $s_pos = scalar @codes;
 921             push(@codes, 05) if ($oppos{'i'} & 4);
 922             push(@codes, $oppos{'i'} & 3, hex $1);
 923             $prefix_ok = 0;
 924         } elsif ($op =~ /^([0-9a-f]{2})\+c$/) {
 925             push(@codes, 0330, hex $1);
 926             $prefix_ok = 0;
 927         } elsif ($op =~ /^\\([0-7]+|x[0-9a-f]{2})$/) {
 928             # Escape to enter literal bytecodes
 929             push(@codes, oct $1);
 930         } else {
 931             die "$fname: $line: unknown operation: $op\n";
 932         }
 933     }
 934
 935     return @codes;
 936 }