| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049 |
- #!/usr/bin/perl
- ## --------------------------------------------------------------------------
- ##
- ## Copyright 1996-2017 The NASM Authors - All Rights Reserved
- ## See the file AUTHORS included with the NASM distribution for
- ## the specific copyright holders.
- ##
- ## Redistribution and use in source and binary forms, with or without
- ## modification, are permitted provided that the following
- ## conditions are met:
- ##
- ## * Redistributions of source code must retain the above copyright
- ## notice, this list of conditions and the following disclaimer.
- ## * Redistributions in binary form must reproduce the above
- ## copyright notice, this list of conditions and the following
- ## disclaimer in the documentation and/or other materials provided
- ## with the distribution.
- ##
- ## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- ## CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
- ## INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
- ## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- ## DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- ## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- ## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- ## NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- ## LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- ## HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- ## CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
- ## OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
- ## EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- ##
- ## --------------------------------------------------------------------------
- #
- # insns.pl
- #
- # Parse insns.dat and produce generated source code files
- require 'x86/insns-iflags.ph';
- # Opcode prefixes which need their own opcode tables
- # LONGER PREFIXES FIRST!
- @disasm_prefixes = qw(0F24 0F25 0F38 0F3A 0F7A 0FA6 0FA7 0F);
- # This should match MAX_OPERANDS from nasm.h
- $MAX_OPERANDS = 5;
- # Add VEX/XOP prefixes
- @vex_class = ( 'vex', 'xop', 'evex' );
- $vex_classes = scalar(@vex_class);
- @vexlist = ();
- %vexmap = ();
- for ($c = 0; $c < $vex_classes; $c++) {
- $vexmap{$vex_class[$c]} = $c;
- for ($m = 0; $m < 32; $m++) {
- for ($p = 0; $p < 4; $p++) {
- push(@vexlist, sprintf("%s%02X%01X", $vex_class[$c], $m, $p));
- }
- }
- }
- @disasm_prefixes = (@vexlist, @disasm_prefixes);
- @bytecode_count = (0) x 256;
- print STDERR "Reading insns.dat...\n";
- @args = ();
- undef $output;
- foreach $arg ( @ARGV ) {
- if ( $arg =~ /^\-/ ) {
- if ( $arg =~ /^\-([abdin]|f[hc])$/ ) {
- $output = $1;
- } else {
- die "$0: Unknown option: ${arg}\n";
- }
- } else {
- push (@args, $arg);
- }
- }
- die if (scalar(@args) != 2); # input output
- ($fname, $oname) = @args;
- open(F, '<', $fname) || die "unable to open $fname";
- %dinstables = ();
- @bytecode_list = ();
- $line = 0;
- $insns = 0;
- $n_opcodes = $n_opcodes_cc = 0;
- while (<F>) {
- $line++;
- chomp;
- next if ( /^\s*(\;.*|)$/ ); # comments or blank lines
- unless (/^\s*(\S+)\s+(\S+)\s+(\S+|\[.*\])\s+(\S+)\s*$/) {
- warn "line $line does not contain four fields\n";
- next;
- }
- @fields = ($1, $2, $3, $4);
- @field_list = ([@fields, 0]);
- if ($fields[1] =~ /\*/) {
- # This instruction has relaxed form(s)
- if ($fields[2] !~ /^\[/) {
- warn "line $line has an * operand but uses raw bytecodes\n";
- next;
- }
- $opmask = 0;
- @ops = split(/,/, $fields[1]);
- for ($oi = 0; $oi < scalar @ops; $oi++) {
- if ($ops[$oi] =~ /\*$/) {
- if ($oi == 0) {
- warn "line $line has a first operand with a *\n";
- next;
- }
- $opmask |= 1 << $oi;
- }
- }
- for ($oi = 1; $oi < (1 << scalar @ops); $oi++) {
- if (($oi & ~$opmask) == 0) {
- my @xops = ();
- my $omask = ~$oi;
- for ($oj = 0; $oj < scalar(@ops); $oj++) {
- if ($omask & 1) {
- push(@xops, $ops[$oj]);
- }
- $omask >>= 1;
- }
- push(@field_list, [$fields[0], join(',', @xops),
- $fields[2], $fields[3], $oi]);
- }
- }
- }
- foreach $fptr (@field_list) {
- @fields = @$fptr;
- ($formatted, $nd) = format_insn(@fields);
- if ($formatted) {
- $insns++;
- $aname = "aa_$fields[0]";
- push @$aname, $formatted;
- }
- if ( $fields[0] =~ /cc$/ ) {
- # Conditional instruction
- if (!defined($k_opcodes_cc{$fields[0]})) {
- $k_opcodes_cc{$fields[0]} = $n_opcodes_cc++;
- }
- } else {
- # Unconditional instruction
- if (!defined($k_opcodes{$fields[0]})) {
- $k_opcodes{$fields[0]} = $n_opcodes++;
- }
- }
- if ($formatted && !$nd) {
- push @big, $formatted;
- my @sseq = startseq($fields[2], $fields[4]);
- foreach $i (@sseq) {
- if (!defined($dinstables{$i})) {
- $dinstables{$i} = [];
- }
- push(@{$dinstables{$i}}, $#big);
- }
- }
- }
- }
- close F;
- #
- # Generate the bytecode array. At this point, @bytecode_list contains
- # the full set of bytecodes.
- #
- # Sort by descending length
- @bytecode_list = sort { scalar(@$b) <=> scalar(@$a) } @bytecode_list;
- @bytecode_array = ();
- %bytecode_pos = ();
- $bytecode_next = 0;
- foreach $bl (@bytecode_list) {
- my $h = hexstr(@$bl);
- next if (defined($bytecode_pos{$h}));
- push(@bytecode_array, $bl);
- while ($h ne '') {
- $bytecode_pos{$h} = $bytecode_next;
- $h = substr($h, 2);
- $bytecode_next++;
- }
- }
- undef @bytecode_list;
- @opcodes = sort { $k_opcodes{$a} <=> $k_opcodes{$b} } keys(%k_opcodes);
- @opcodes_cc = sort { $k_opcodes_cc{$a} <=> $k_opcodes_cc{$b} } keys(%k_opcodes_cc);
- if ( $output eq 'b') {
- print STDERR "Writing $oname...\n";
- open(B, '>', $oname);
- print B "/* This file auto-generated from insns.dat by insns.pl" .
- " - don't edit it */\n\n";
- print B "#include \"nasm.h\"\n";
- print B "#include \"insns.h\"\n\n";
- print B "const uint8_t nasm_bytecodes[$bytecode_next] = {\n";
- $p = 0;
- foreach $bl (@bytecode_array) {
- printf B " /* %5d */ ", $p;
- foreach $d (@$bl) {
- printf B "%#o,", $d;
- $p++;
- }
- printf B "\n";
- }
- print B "};\n";
- print B "\n";
- print B "/*\n";
- print B " * Bytecode frequencies (including reuse):\n";
- print B " *\n";
- for ($i = 0; $i < 32; $i++) {
- print B " *";
- for ($j = 0; $j < 256; $j += 32) {
- print B " |" if ($j);
- printf B " %3o:%4d", $i+$j, $bytecode_count[$i+$j];
- }
- print B "\n";
- }
- print B " */\n";
- close B;
- }
- if ( $output eq 'a' ) {
- print STDERR "Writing $oname...\n";
- open(A, '>', $oname);
- print A "/* This file auto-generated from insns.dat by insns.pl" .
- " - don't edit it */\n\n";
- print A "#include \"nasm.h\"\n";
- print A "#include \"insns.h\"\n\n";
- foreach $i (@opcodes, @opcodes_cc) {
- print A "static const struct itemplate instrux_${i}[] = {\n";
- $aname = "aa_$i";
- foreach $j (@$aname) {
- print A " ", codesubst($j), "\n";
- }
- print A " ITEMPLATE_END\n};\n\n";
- }
- print A "const struct itemplate * const nasm_instructions[] = {\n";
- foreach $i (@opcodes, @opcodes_cc) {
- print A " instrux_${i},\n";
- }
- print A "};\n";
- close A;
- }
- if ( $output eq 'd' ) {
- print STDERR "Writing $oname...\n";
- open(D, '>', $oname);
- print D "/* This file auto-generated from insns.dat by insns.pl" .
- " - don't edit it */\n\n";
- print D "#include \"nasm.h\"\n";
- print D "#include \"insns.h\"\n\n";
- print D "static const struct itemplate instrux[] = {\n";
- $n = 0;
- foreach $j (@big) {
- printf D " /* %4d */ %s\n", $n++, codesubst($j);
- }
- print D "};\n";
- foreach $h (sort(keys(%dinstables))) {
- next if ($h eq ''); # Skip pseudo-instructions
- print D "\nstatic const struct itemplate * const itable_${h}[] = {\n";
- foreach $j (@{$dinstables{$h}}) {
- print D " instrux + $j,\n";
- }
- print D "};\n";
- }
- @prefix_list = ();
- foreach $h (@disasm_prefixes, '') {
- for ($c = 0; $c < 256; $c++) {
- $nn = sprintf("%s%02X", $h, $c);
- if ($is_prefix{$nn} || defined($dinstables{$nn})) {
- # At least one entry in this prefix table
- push(@prefix_list, $h);
- $is_prefix{$h} = 1;
- last;
- }
- }
- }
- foreach $h (@prefix_list) {
- print D "\n";
- print D "static " unless ($h eq '');
- print D "const struct disasm_index ";
- print D ($h eq '') ? 'itable' : "itable_$h";
- print D "[256] = {\n";
- for ($c = 0; $c < 256; $c++) {
- $nn = sprintf("%s%02X", $h, $c);
- if ($is_prefix{$nn}) {
- die "$fname: ambiguous decoding of $nn\n"
- if (defined($dinstables{$nn}));
- printf D " /* 0x%02x */ { itable_%s, -1 },\n", $c, $nn;
- } elsif (defined($dinstables{$nn})) {
- printf D " /* 0x%02x */ { itable_%s, %u },\n", $c,
- $nn, scalar(@{$dinstables{$nn}});
- } else {
- printf D " /* 0x%02x */ { NULL, 0 },\n", $c;
- }
- }
- print D "};\n";
- }
- printf D "\nconst struct disasm_index * const itable_vex[NASM_VEX_CLASSES][32][4] =\n";
- print D "{\n";
- for ($c = 0; $c < $vex_classes; $c++) {
- print D " {\n";
- for ($m = 0; $m < 32; $m++) {
- print D " { ";
- for ($p = 0; $p < 4; $p++) {
- $vp = sprintf("%s%02X%01X", $vex_class[$c], $m, $p);
- printf D "%-15s",
- ($is_prefix{$vp} ? sprintf("itable_%s,", $vp) : 'NULL,');
- }
- print D "},\n";
- }
- print D " },\n";
- }
- print D "};\n";
- close D;
- }
- if ( $output eq 'i' ) {
- print STDERR "Writing $oname...\n";
- open(I, '>', $oname);
- print I "/* This file is auto-generated from insns.dat by insns.pl" .
- " - don't edit it */\n\n";
- print I "/* This file in included by nasm.h */\n\n";
- print I "/* Instruction names */\n\n";
- print I "#ifndef NASM_INSNSI_H\n";
- print I "#define NASM_INSNSI_H 1\n\n";
- print I "enum opcode {\n";
- $maxlen = 0;
- foreach $i (@opcodes, @opcodes_cc) {
- print I "\tI_${i},\n";
- $len = length($i);
- $len++ if ( $i =~ /cc$/ ); # Condition codes can be 3 characters long
- $maxlen = $len if ( $len > $maxlen );
- }
- print I "\tI_none = -1\n";
- print I "};\n\n";
- print I "#define MAX_INSLEN ", $maxlen, "\n";
- print I "#define NASM_VEX_CLASSES ", $vex_classes, "\n";
- print I "#define NO_DECORATOR\t{", join(',',(0) x $MAX_OPERANDS), "}\n";
- print I "#define FIRST_COND_OPCODE I_", $opcodes_cc[0], "\n\n";
- print I "#endif /* NASM_INSNSI_H */\n";
- close I;
- }
- if ( $output eq 'n' ) {
- print STDERR "Writing $oname...\n";
- open(N, '>', $oname);
- print N "/* This file is auto-generated from insns.dat by insns.pl" .
- " - don't edit it */\n\n";
- print N "#include \"tables.h\"\n\n";
- print N "const char * const nasm_insn_names[] = {";
- $first = 1;
- foreach $i (@opcodes, @opcodes_cc) {
- print N "," if ( !$first );
- $first = 0;
- $ilower = $i;
- $ilower =~ s/cc$//; # Remove conditional cc suffix
- $ilower =~ tr/A-Z/a-z/; # Change to lower case (Perl 4 compatible)
- print N "\n\t\"${ilower}\"";
- }
- print N "\n};\n";
- close N;
- }
- if ( $output eq 'fh') {
- write_iflaggen_h();
- }
- if ( $output eq 'fc') {
- write_iflag_c();
- }
- printf STDERR "Done: %d instructions\n", $insns;
- # Count primary bytecodes, for statistics
- sub count_bytecodes(@) {
- my $skip = 0;
- foreach my $bc (@_) {
- if ($skip) {
- $skip--;
- next;
- }
- $bytecode_count[$bc]++;
- if ($bc >= 01 && $bc <= 04) {
- $skip = $bc;
- } elsif (($bc & ~03) == 010) {
- $skip = 1;
- } elsif (($bc & ~013) == 0144) {
- $skip = 1;
- } elsif ($bc == 0172 || $bc == 0173) {
- $skip = 1;
- } elsif (($bc & ~3) == 0260 || $bc == 0270) { # VEX
- $skip = 2;
- } elsif (($bc & ~3) == 0240 || $bc == 0250) { # EVEX
- $skip = 3;
- } elsif ($bc == 0330) {
- $skip = 1;
- }
- }
- }
- sub format_insn($$$$$) {
- my ($opcode, $operands, $codes, $flags, $relax) = @_;
- my $num, $nd = 0, $rawflags, $flagsindex;
- my @bytecode;
- my $op, @ops, $opp, @opx, @oppx, @decos, @opevex;
- return (undef, undef) if $operands eq "ignore";
- # format the operands
- $operands =~ s/\*//g;
- $operands =~ s/:/|colon,/g;
- @ops = ();
- @decos = ();
- if ($operands ne 'void') {
- foreach $op (split(/,/, $operands)) {
- @opx = ();
- @opevex = ();
- foreach $opp (split(/\|/, $op)) {
- @oppx = ();
- if ($opp =~ s/^(b(32|64)|mask|z|er|sae)$//) {
- push(@opevex, $1);
- }
- if ($opp =~ s/(?<!\d)(8|16|32|64|80|128|256|512)$//) {
- push(@oppx, "bits$1");
- }
- $opp =~ s/^mem$/memory/;
- $opp =~ s/^memory_offs$/mem_offs/;
- $opp =~ s/^imm$/immediate/;
- $opp =~ s/^([a-z]+)rm$/rm_$1/;
- $opp =~ s/^rm$/rm_gpr/;
- $opp =~ s/^reg$/reg_gpr/;
- # only for evex insns, high-16 regs are allowed
- if ($codes !~ /(^|\s)evex\./) {
- $opp =~ s/^(rm_[xyz]mm)$/$1_l16/;
- $opp =~ s/^([xyz]mm)reg$/$1_l16/;
- }
- push(@opx, $opp, @oppx) if $opp;
- }
- $op = join('|', @opx);
- push(@ops, $op);
- push(@decos, (@opevex ? join('|', @opevex) : '0'));
- }
- }
- $num = scalar(@ops);
- while (scalar(@ops) < $MAX_OPERANDS) {
- push(@ops, '0');
- push(@decos, '0');
- }
- $operands = join(',', @ops);
- $operands =~ tr/a-z/A-Z/;
- $decorators = "{" . join(',', @decos) . "}";
- if ($decorators =~ /^{(0,)+0}$/) {
- $decorators = "NO_DECORATOR";
- }
- $decorators =~ tr/a-z/A-Z/;
- # format the flags
- $nd = 1 if $flags =~ /(^|\,)ND($|\,)/;
- $flags =~ s/(^|\,)ND($|\,)/\1/g;
- $flags =~ s/(^|\,)X64($|\,)/\1LONG,X86_64\2/g;
- if ($codes =~ /evex\./) {
- $flags .= ",EVEX";
- } elsif ($codes =~ /(vex|xop)\./) {
- $flags .= ",VEX";
- }
- $rawflags = $flags;
- $flagsindex = insns_flag_index(split(',',$flags));
- die "Error in flags $rawflags" if not defined($flagsindex);
- @bytecode = (decodify($codes, $relax), 0);
- push(@bytecode_list, [@bytecode]);
- $codes = hexstr(@bytecode);
- count_bytecodes(@bytecode);
- ("{I_$opcode, $num, {$operands}, $decorators, \@\@CODES-$codes\@\@, $flagsindex},", $nd);
- }
- #
- # Look for @@CODES-xxx@@ sequences and replace them with the appropriate
- # offset into nasm_bytecodes
- #
- sub codesubst($) {
- my($s) = @_;
- my $n;
- while ($s =~ /\@\@CODES-([0-9A-F]+)\@\@/) {
- my $pos = $bytecode_pos{$1};
- if (!defined($pos)) {
- die "$fname: no position assigned to byte code $1\n";
- }
- $s = $` . "nasm_bytecodes+${pos}" . "$'";
- }
- return $s;
- }
- sub addprefix ($@) {
- my ($prefix, @list) = @_;
- my $x;
- my @l = ();
- foreach $x (@list) {
- push(@l, sprintf("%s%02X", $prefix, $x));
- }
- return @l;
- }
- #
- # Turn a code string into a sequence of bytes
- #
- sub decodify($$) {
- # Although these are C-syntax strings, by convention they should have
- # only octal escapes (for directives) and hexadecimal escapes
- # (for verbatim bytes)
- my($codestr, $relax) = @_;
- if ($codestr =~ /^\s*\[([^\]]*)\]\s*$/) {
- return byte_code_compile($1, $relax);
- }
- my $c = $codestr;
- my @codes = ();
- unless ($codestr eq 'ignore') {
- while ($c ne '') {
- if ($c =~ /^\\x([0-9a-f]+)(.*)$/i) {
- push(@codes, hex $1);
- $c = $2;
- next;
- } elsif ($c =~ /^\\([0-7]{1,3})(.*)$/) {
- push(@codes, oct $1);
- $c = $2;
- next;
- } else {
- die "$fname: unknown code format in \"$codestr\"\n";
- }
- }
- }
- return @codes;
- }
- # Turn a numeric list into a hex string
- sub hexstr(@) {
- my $s = '';
- my $c;
- foreach $c (@_) {
- $s .= sprintf("%02X", $c);
- }
- return $s;
- }
- # Here we determine the range of possible starting bytes for a given
- # instruction. We need only consider the codes:
- # \[1234] mean literal bytes, of course
- # \1[0123] mean byte plus register value
- # \330 means byte plus condition code
- # \0 or \340 mean give up and return empty set
- # \34[4567] mean PUSH/POP of segment registers: special case
- # \17[234] skip is4 control byte
- # \26x \270 skip VEX control bytes
- # \24x \250 skip EVEX control bytes
- sub startseq($$) {
- my ($codestr, $relax) = @_;
- my $word, @range;
- my @codes = ();
- my $c = $codestr;
- my $c0, $c1, $i;
- my $prefix = '';
- @codes = decodify($codestr, $relax);
- while ($c0 = shift(@codes)) {
- $c1 = $codes[0];
- if ($c0 >= 01 && $c0 <= 04) {
- # Fixed byte string
- my $fbs = $prefix;
- while (1) {
- if ($c0 >= 01 && $c0 <= 04) {
- while ($c0--) {
- $fbs .= sprintf("%02X", shift(@codes));
- }
- } else {
- last;
- }
- $c0 = shift(@codes);
- }
- foreach $pfx (@disasm_prefixes) {
- if (substr($fbs, 0, length($pfx)) eq $pfx) {
- $prefix = $pfx;
- $fbs = substr($fbs, length($pfx));
- last;
- }
- }
- if ($fbs ne '') {
- return ($prefix.substr($fbs,0,2));
- }
- unshift(@codes, $c0);
- } elsif ($c0 >= 010 && $c0 <= 013) {
- return addprefix($prefix, $c1..($c1+7));
- } elsif (($c0 & ~013) == 0144) {
- return addprefix($prefix, $c1, $c1|2);
- } elsif ($c0 == 0330) {
- return addprefix($prefix, $c1..($c1+15));
- } elsif ($c0 == 0 || $c0 == 0340) {
- return $prefix;
- } elsif (($c0 & ~3) == 0260 || $c0 == 0270 ||
- ($c0 & ~3) == 0240 || $c0 == 0250) {
- my $c,$m,$wlp;
- $m = shift(@codes);
- $wlp = shift(@codes);
- $c = ($m >> 6);
- $m = $m & 31;
- $prefix .= sprintf('%s%02X%01X', $vex_class[$c], $m, $wlp & 3);
- if ($c0 < 0260) {
- my $tuple = shift(@codes);
- }
- } elsif ($c0 >= 0172 && $c0 <= 173) {
- shift(@codes); # Skip is4 control byte
- } else {
- # We really need to be able to distinguish "forbidden"
- # and "ignorable" codes here
- }
- }
- return $prefix;
- }
- # EVEX tuple types offset is 0300. e.g. 0301 is for full vector(fv).
- sub tupletype($) {
- my ($tuplestr) = @_;
- my %tuple_codes = (
- '' => 000,
- 'fv' => 001,
- 'hv' => 002,
- 'fvm' => 003,
- 't1s8' => 004,
- 't1s16' => 005,
- 't1s' => 006,
- 't1f32' => 007,
- 't1f64' => 010,
- 't2' => 011,
- 't4' => 012,
- 't8' => 013,
- 'hvm' => 014,
- 'qvm' => 015,
- 'ovm' => 016,
- 'm128' => 017,
- 'dup' => 020,
- );
- if (defined $tuple_codes{$tuplestr}) {
- return 0300 + $tuple_codes{$tuplestr};
- } else {
- die "Undefined tuple type : $tuplestr\n";
- }
- }
- #
- # This function takes a series of byte codes in a format which is more
- # typical of the Intel documentation, and encode it.
- #
- # The format looks like:
- #
- # [operands: opcodes]
- #
- # The operands word lists the order of the operands:
- #
- # r = register field in the modr/m
- # m = modr/m
- # v = VEX "v" field
- # i = immediate
- # s = register field of is4/imz2 field
- # - = implicit (unencoded) operand
- # x = indeX register of mib. 014..017 bytecodes are used.
- #
- # For an operand that should be filled into more than one field,
- # enter it as e.g. "r+v".
- #
- sub byte_code_compile($$) {
- my($str, $relax) = @_;
- my $opr;
- my $opc;
- my @codes = ();
- my $litix = undef;
- my %oppos = ();
- my $i;
- my $op, $oq;
- my $opex;
- my %imm_codes = (
- 'ib' => 020, # imm8
- 'ib,u' => 024, # Unsigned imm8
- 'iw' => 030, # imm16
- 'ib,s' => 0274, # imm8 sign-extended to opsize or bits
- 'iwd' => 034, # imm16 or imm32, depending on opsize
- 'id' => 040, # imm32
- 'id,s' => 0254, # imm32 sign-extended to 64 bits
- 'iwdq' => 044, # imm16/32/64, depending on addrsize
- 'rel8' => 050,
- 'iq' => 054,
- 'rel16' => 060,
- 'rel' => 064, # 16 or 32 bit relative operand
- 'rel32' => 070,
- 'seg' => 074,
- );
- my %plain_codes = (
- 'o16' => 0320, # 16-bit operand size
- 'o32' => 0321, # 32-bit operand size
- 'odf' => 0322, # Operand size is default
- 'o64' => 0324, # 64-bit operand size requiring REX.W
- 'o64nw' => 0323, # Implied 64-bit operand size (no REX.W)
- 'a16' => 0310,
- 'a32' => 0311,
- 'adf' => 0312, # Address size is default
- 'a64' => 0313,
- '!osp' => 0364,
- '!asp' => 0365,
- 'f2i' => 0332, # F2 prefix, but 66 for operand size is OK
- 'f3i' => 0333, # F3 prefix, but 66 for operand size is OK
- 'mustrep' => 0336,
- 'mustrepne' => 0337,
- 'rex.l' => 0334,
- 'norexb' => 0314,
- 'norexx' => 0315,
- 'norexr' => 0316,
- 'norexw' => 0317,
- 'repe' => 0335,
- 'nohi' => 0325, # Use spl/bpl/sil/dil even without REX
- 'nof3' => 0326, # No REP 0xF3 prefix permitted
- 'norep' => 0331, # No REP prefix permitted
- 'wait' => 0341, # Needs a wait prefix
- 'resb' => 0340,
- 'np' => 0360, # No prefix
- 'jcc8' => 0370, # Match only if Jcc possible with single byte
- 'jmp8' => 0371, # Match only if JMP possible with single byte
- 'jlen' => 0373, # Length of jump
- 'hlexr' => 0271,
- 'hlenl' => 0272,
- 'hle' => 0273,
- # This instruction takes XMM VSIB
- 'vsibx' => 0374,
- 'vm32x' => 0374,
- 'vm64x' => 0374,
- # This instruction takes YMM VSIB
- 'vsiby' => 0375,
- 'vm32y' => 0375,
- 'vm64y' => 0375,
- # This instruction takes ZMM VSIB
- 'vsibz' => 0376,
- 'vm32z' => 0376,
- 'vm64z' => 0376,
- );
- unless ($str =~ /^(([^\s:]*)\:*([^\s:]*)\:|)\s*(.*\S)\s*$/) {
- die "$fname: $line: cannot parse: [$str]\n";
- }
- $opr = "\L$2";
- $tuple = "\L$3"; # Tuple type for AVX512
- $opc = "\L$4";
- my $op = 0;
- for ($i = 0; $i < length($opr); $i++) {
- my $c = substr($opr,$i,1);
- if ($c eq '+') {
- $op--;
- } else {
- if ($relax & 1) {
- $op--;
- }
- $relax >>= 1;
- $oppos{$c} = $op++;
- }
- }
- $tup = tupletype($tuple);
- my $last_imm = 'h';
- my $prefix_ok = 1;
- foreach $op (split(/\s*(?:\s|(?=[\/\\]))/, $opc)) {
- my $pc = $plain_codes{$op};
- if (defined $pc) {
- # Plain code
- push(@codes, $pc);
- } elsif ($prefix_ok && $op =~ /^(66|f2|f3)$/) {
- # 66/F2/F3 prefix used as an opcode extension
- if ($op eq '66') {
- push(@codes, 0361);
- } elsif ($op eq 'f2') {
- push(@codes, 0332);
- } else {
- push(@codes, 0333);
- }
- } elsif ($op =~ /^[0-9a-f]{2}$/) {
- if (defined($litix) && $litix+$codes[$litix]+1 == scalar @codes &&
- $codes[$litix] < 4) {
- $codes[$litix]++;
- push(@codes, hex $op);
- } else {
- $litix = scalar(@codes);
- push(@codes, 01, hex $op);
- }
- $prefix_ok = 0;
- } elsif ($op eq '/r') {
- if (!defined($oppos{'r'}) || !defined($oppos{'m'})) {
- die "$fname: $line: $op requires r and m operands\n";
- }
- $opex = (($oppos{'m'} & 4) ? 06 : 0) |
- (($oppos{'r'} & 4) ? 05 : 0);
- push(@codes, $opex) if ($opex);
- # if mib is composed with two separate operands - ICC style
- push(@codes, 014 + ($oppos{'x'} & 3)) if (defined($oppos{'x'}));
- push(@codes, 0100 + (($oppos{'m'} & 3) << 3) + ($oppos{'r'} & 3));
- $prefix_ok = 0;
- } elsif ($op =~ m:^/([0-7])$:) {
- if (!defined($oppos{'m'})) {
- die "$fname: $line: $op requires m operand\n";
- }
- push(@codes, 06) if ($oppos{'m'} & 4);
- push(@codes, 0200 + (($oppos{'m'} & 3) << 3) + $1);
- $prefix_ok = 0;
- } elsif ($op =~ /^(vex|xop)(|\..*)$/) {
- my $vexname = $1;
- my $c = $vexmap{$vexname};
- my ($m,$w,$l,$p) = (undef,2,undef,0);
- my $has_nds = 0;
- my @subops = split(/\./, $op);
- shift @subops; # Drop prefix
- foreach $oq (@subops) {
- if ($oq eq '128' || $oq eq 'l0' || $oq eq 'lz') {
- $l = 0;
- } elsif ($oq eq '256' || $oq eq 'l1') {
- $l = 1;
- } elsif ($oq eq 'lig') {
- $l = 2;
- } elsif ($oq eq 'w0') {
- $w = 0;
- } elsif ($oq eq 'w1') {
- $w = 1;
- } elsif ($oq eq 'wig') {
- $w = 2;
- } elsif ($oq eq 'ww') {
- $w = 3;
- } elsif ($oq eq 'p0') {
- $p = 0;
- } elsif ($oq eq '66' || $oq eq 'p1') {
- $p = 1;
- } elsif ($oq eq 'f3' || $oq eq 'p2') {
- $p = 2;
- } elsif ($oq eq 'f2' || $oq eq 'p3') {
- $p = 3;
- } elsif ($oq eq '0f') {
- $m = 1;
- } elsif ($oq eq '0f38') {
- $m = 2;
- } elsif ($oq eq '0f3a') {
- $m = 3;
- } elsif ($oq =~ /^m([0-9]+)$/) {
- $m = $1+0;
- } elsif ($oq eq 'nds' || $oq eq 'ndd' || $oq eq 'dds') {
- if (!defined($oppos{'v'})) {
- die "$fname: $line: $vexname.$oq without 'v' operand\n";
- }
- $has_nds = 1;
- } else {
- die "$fname: $line: undefined \U$vexname\E subcode: $oq\n";
- }
- }
- if (!defined($m) || !defined($w) || !defined($l) || !defined($p)) {
- die "$fname: $line: missing fields in \U$vexname\E specification\n";
- }
- if (defined($oppos{'v'}) && !$has_nds) {
- die "$fname: $line: 'v' operand without ${vexname}.nds or ${vexname}.ndd\n";
- }
- my $minmap = ($c == 1) ? 8 : 0; # 0-31 for VEX, 8-31 for XOP
- if ($m < $minmap || $m > 31) {
- die "$fname: $line: Only maps ${minmap}-31 are valid for \U${vexname}\n";
- }
- push(@codes, defined($oppos{'v'}) ? 0260+($oppos{'v'} & 3) : 0270,
- ($c << 6)+$m, ($w << 4)+($l << 2)+$p);
- $prefix_ok = 0;
- } elsif ($op =~ /^(evex)(|\..*)$/) {
- my $c = $vexmap{$1};
- my ($m,$w,$l,$p) = (undef,2,undef,0);
- my $has_nds = 0;
- my @subops = split(/\./, $op);
- shift @subops; # Drop prefix
- foreach $oq (@subops) {
- if ($oq eq '128' || $oq eq 'l0' || $oq eq 'lz' || $oq eq 'lig') {
- $l = 0;
- } elsif ($oq eq '256' || $oq eq 'l1') {
- $l = 1;
- } elsif ($oq eq '512' || $oq eq 'l2') {
- $l = 2;
- } elsif ($oq eq 'w0') {
- $w = 0;
- } elsif ($oq eq 'w1') {
- $w = 1;
- } elsif ($oq eq 'wig') {
- $w = 2;
- } elsif ($oq eq 'ww') {
- $w = 3;
- } elsif ($oq eq 'p0') {
- $p = 0;
- } elsif ($oq eq '66' || $oq eq 'p1') {
- $p = 1;
- } elsif ($oq eq 'f3' || $oq eq 'p2') {
- $p = 2;
- } elsif ($oq eq 'f2' || $oq eq 'p3') {
- $p = 3;
- } elsif ($oq eq '0f') {
- $m = 1;
- } elsif ($oq eq '0f38') {
- $m = 2;
- } elsif ($oq eq '0f3a') {
- $m = 3;
- } elsif ($oq =~ /^m([0-9]+)$/) {
- $m = $1+0;
- } elsif ($oq eq 'nds' || $oq eq 'ndd' || $oq eq 'dds') {
- if (!defined($oppos{'v'})) {
- die "$fname: $line: evex.$oq without 'v' operand\n";
- }
- $has_nds = 1;
- } else {
- die "$fname: $line: undefined EVEX subcode: $oq\n";
- }
- }
- if (!defined($m) || !defined($w) || !defined($l) || !defined($p)) {
- die "$fname: $line: missing fields in EVEX specification\n";
- }
- if (defined($oppos{'v'}) && !$has_nds) {
- die "$fname: $line: 'v' operand without evex.nds or evex.ndd\n";
- }
- if ($m > 15) {
- die "$fname: $line: Only maps 0-15 are valid for EVEX\n";
- }
- push(@codes, defined($oppos{'v'}) ? 0240+($oppos{'v'} & 3) : 0250,
- ($c << 6)+$m, ($w << 4)+($l << 2)+$p, $tup);
- $prefix_ok = 0;
- } elsif (defined $imm_codes{$op}) {
- if ($op eq 'seg') {
- if ($last_imm lt 'i') {
- die "$fname: $line: seg without an immediate operand\n";
- }
- } else {
- $last_imm++;
- if ($last_imm gt 'j') {
- die "$fname: $line: too many immediate operands\n";
- }
- }
- if (!defined($oppos{$last_imm})) {
- die "$fname: $line: $op without '$last_imm' operand\n";
- }
- push(@codes, 05) if ($oppos{$last_imm} & 4);
- push(@codes, $imm_codes{$op} + ($oppos{$last_imm} & 3));
- $prefix_ok = 0;
- } elsif ($op eq '/is4') {
- if (!defined($oppos{'s'})) {
- die "$fname: $line: $op without 's' operand\n";
- }
- if (defined($oppos{'i'})) {
- push(@codes, 0172, ($oppos{'s'} << 3)+$oppos{'i'});
- } else {
- push(@codes, 05) if ($oppos{'s'} & 4);
- push(@codes, 0174+($oppos{'s'} & 3));
- }
- $prefix_ok = 0;
- } elsif ($op =~ /^\/is4\=([0-9]+)$/) {
- my $imm = $1;
- if (!defined($oppos{'s'})) {
- die "$fname: $line: $op without 's' operand\n";
- }
- if ($imm < 0 || $imm > 15) {
- die "$fname: $line: invalid imm4 value for $op: $imm\n";
- }
- push(@codes, 0173, ($oppos{'s'} << 4) + $imm);
- $prefix_ok = 0;
- } elsif ($op =~ /^([0-9a-f]{2})\+c$/) {
- push(@codes, 0330, hex $1);
- $prefix_ok = 0;
- } elsif ($op =~ /^([0-9a-f]{2})\+r$/) {
- if (!defined($oppos{'r'})) {
- die "$fname: $line: $op without 'r' operand\n";
- }
- push(@codes, 05) if ($oppos{'r'} & 4);
- push(@codes, 010 + ($oppos{'r'} & 3), hex $1);
- $prefix_ok = 0;
- } elsif ($op =~ /^\\([0-7]+|x[0-9a-f]{2})$/) {
- # Escape to enter literal bytecodes
- push(@codes, oct $1);
- } else {
- die "$fname: $line: unknown operation: $op\n";
- }
- }
- return @codes;
- }
|