x86_64-xlate.pl: proper solution for RT#2620.
[openssl.git] / crypto / perlasm / x86_64-xlate.pl
1 #!/usr/bin/env perl
2
3 # Ascetic x86_64 AT&T to MASM/NASM assembler translator by <appro>.
4 #
5 # Why AT&T to MASM and not vice versa? Several reasons. Because AT&T
6 # format is way easier to parse. Because it's simpler to "gear" from
7 # Unix ABI to Windows one [see cross-reference "card" at the end of
8 # file]. Because Linux targets were available first...
9 #
10 # In addition the script also "distills" code suitable for GNU
11 # assembler, so that it can be compiled with more rigid assemblers,
12 # such as Solaris /usr/ccs/bin/as.
13 #
14 # This translator is not designed to convert *arbitrary* assembler
15 # code from AT&T format to MASM one. It's designed to convert just
16 # enough to provide for dual-ABI OpenSSL modules development...
17 # There *are* limitations and you might have to modify your assembler
18 # code or this script to achieve the desired result...
19 #
20 # Currently recognized limitations:
21 #
22 # - can't use multiple ops per line;
23 #
24 # Dual-ABI styling rules.
25 #
26 # 1. Adhere to Unix register and stack layout [see cross-reference
27 #    ABI "card" at the end for explanation].
28 # 2. Forget about "red zone," stick to more traditional blended
29 #    stack frame allocation. If volatile storage is actually required
30 #    that is. If not, just leave the stack as is.
31 # 3. Functions tagged with ".type name,@function" get crafted with
32 #    unified Win64 prologue and epilogue automatically. If you want
33 #    to take care of ABI differences yourself, tag functions as
34 #    ".type name,@abi-omnipotent" instead.
35 # 4. To optimize the Win64 prologue you can specify number of input
36 #    arguments as ".type name,@function,N." Keep in mind that if N is
37 #    larger than 6, then you *have to* write "abi-omnipotent" code,
38 #    because >6 cases can't be addressed with unified prologue.
39 # 5. Name local labels as .L*, do *not* use dynamic labels such as 1:
40 #    (sorry about latter).
41 # 6. Don't use [or hand-code with .byte] "rep ret." "ret" mnemonic is
42 #    required to identify the spots, where to inject Win64 epilogue!
43 #    But on the pros, it's then prefixed with rep automatically:-)
44 # 7. Stick to explicit ip-relative addressing. If you have to use
45 #    GOTPCREL addressing, stick to mov symbol@GOTPCREL(%rip),%r??.
46 #    Both are recognized and translated to proper Win64 addressing
47 #    modes. To support legacy code a synthetic directive, .picmeup,
48 #    is implemented. It puts address of the *next* instruction into
49 #    target register, e.g.:
50 #
51 #               .picmeup        %rax
52 #               lea             .Label-.(%rax),%rax
53 #
54 # 8. In order to provide for structured exception handling unified
55 #    Win64 prologue copies %rsp value to %rax. For further details
56 #    see SEH paragraph at the end.
57 # 9. .init segment is allowed to contain calls to functions only.
58 # a. If function accepts more than 4 arguments *and* >4th argument
59 #    is declared as non 64-bit value, do clear its upper part.
60 \f
61 my $flavour = shift;
62 my $output  = shift;
63 if ($flavour =~ /\./) { $output = $flavour; undef $flavour; }
64
65 { my ($stddev,$stdino,@junk)=stat(STDOUT);
66   my ($outdev,$outino,@junk)=stat($output);
67
68     open STDOUT,">$output" || die "can't open $output: $!"
69         if ($stddev!=$outdev || $stdino!=$outino);
70 }
71
72 my $gas=1;      $gas=0 if ($output =~ /\.asm$/);
73 my $elf=1;      $elf=0 if (!$gas);
74 my $win64=0;
75 my $prefix="";
76 my $decor=".L";
77
78 my $masmref=8 + 50727*2**-32;   # 8.00.50727 shipped with VS2005
79 my $masm=0;
80 my $PTR=" PTR";
81
82 my $nasmref=2.03;
83 my $nasm=0;
84
85 if    ($flavour eq "mingw64")   { $gas=1; $elf=0; $win64=1;
86                                   $prefix=`echo __USER_LABEL_PREFIX__ | $ENV{CC} -E -P -`;
87                                   chomp($prefix);
88                                 }
89 elsif ($flavour eq "macosx")    { $gas=1; $elf=0; $prefix="_"; $decor="L\$"; }
90 elsif ($flavour eq "masm")      { $gas=0; $elf=0; $masm=$masmref; $win64=1; $decor="\$L\$"; }
91 elsif ($flavour eq "nasm")      { $gas=0; $elf=0; $nasm=$nasmref; $win64=1; $decor="\$L\$"; $PTR=""; }
92 elsif (!$gas)
93 {   if ($ENV{ASM} =~ m/nasm/ && `nasm -v` =~ m/version ([0-9]+)\.([0-9]+)/i)
94     {   $nasm = $1 + $2*0.01; $PTR="";  }
95     elsif (`ml64 2>&1` =~ m/Version ([0-9]+)\.([0-9]+)(\.([0-9]+))?/)
96     {   $masm = $1 + $2*2**-16 + $4*2**-32;   }
97     die "no assembler found on %PATH" if (!($nasm || $masm));
98     $win64=1;
99     $elf=0;
100     $decor="\$L\$";
101 }
102
103 my $current_segment;
104 my $current_function;
105 my %globals;
106
107 { package opcode;       # pick up opcodes
108     sub re {
109         my      $self = shift;  # single instance in enough...
110         local   *line = shift;
111         undef   $ret;
112
113         if ($line =~ /^([a-z][a-z0-9]*)/i) {
114             $self->{op} = $1;
115             $ret = $self;
116             $line = substr($line,@+[0]); $line =~ s/^\s+//;
117
118             undef $self->{sz};
119             if ($self->{op} =~ /^(movz)x?([bw]).*/) {   # movz is pain...
120                 $self->{op} = $1;
121                 $self->{sz} = $2;
122             } elsif ($self->{op} =~ /call|jmp/) {
123                 $self->{sz} = "";
124             } elsif ($self->{op} =~ /^p/ && $' !~ /^(ush|op|insrw)/) { # SSEn
125                 $self->{sz} = "";
126             } elsif ($self->{op} =~ /^v/) { # VEX
127                 $self->{sz} = "";
128             } elsif ($self->{op} =~ /movq/ && $line =~ /%xmm/) {
129                 $self->{sz} = "";
130             } elsif ($self->{op} =~ /([a-z]{3,})([qlwb])$/) {
131                 $self->{op} = $1;
132                 $self->{sz} = $2;
133             }
134         }
135         $ret;
136     }
137     sub size {
138         my $self = shift;
139         my $sz   = shift;
140         $self->{sz} = $sz if (defined($sz) && !defined($self->{sz}));
141         $self->{sz};
142     }
143     sub out {
144         my $self = shift;
145         if ($gas) {
146             if ($self->{op} eq "movz") {        # movz is pain...
147                 sprintf "%s%s%s",$self->{op},$self->{sz},shift;
148             } elsif ($self->{op} =~ /^set/) { 
149                 "$self->{op}";
150             } elsif ($self->{op} eq "ret") {
151                 my $epilogue = "";
152                 if ($win64 && $current_function->{abi} eq "svr4") {
153                     $epilogue = "movq   8(%rsp),%rdi\n\t" .
154                                 "movq   16(%rsp),%rsi\n\t";
155                 }
156                 $epilogue . ".byte      0xf3,0xc3";
157             } elsif ($self->{op} eq "call" && !$elf && $current_segment eq ".init") {
158                 ".p2align\t3\n\t.quad";
159             } else {
160                 "$self->{op}$self->{sz}";
161             }
162         } else {
163             $self->{op} =~ s/^movz/movzx/;
164             if ($self->{op} eq "ret") {
165                 $self->{op} = "";
166                 if ($win64 && $current_function->{abi} eq "svr4") {
167                     $self->{op} = "mov  rdi,QWORD${PTR}[8+rsp]\t;WIN64 epilogue\n\t".
168                                   "mov  rsi,QWORD${PTR}[16+rsp]\n\t";
169                 }
170                 $self->{op} .= "DB\t0F3h,0C3h\t\t;repret";
171             } elsif ($self->{op} =~ /^(pop|push)f/) {
172                 $self->{op} .= $self->{sz};
173             } elsif ($self->{op} eq "call" && $current_segment eq ".CRT\$XCU") {
174                 $self->{op} = "\tDQ";
175             } 
176             $self->{op};
177         }
178     }
179     sub mnemonic {
180         my $self=shift;
181         my $op=shift;
182         $self->{op}=$op if (defined($op));
183         $self->{op};
184     }
185 }
186 { package const;        # pick up constants, which start with $
187     sub re {
188         my      $self = shift;  # single instance in enough...
189         local   *line = shift;
190         undef   $ret;
191
192         if ($line =~ /^\$([^,]+)/) {
193             $self->{value} = $1;
194             $ret = $self;
195             $line = substr($line,@+[0]); $line =~ s/^\s+//;
196         }
197         $ret;
198     }
199     sub out {
200         my $self = shift;
201
202         if ($gas) {
203             # Solaris /usr/ccs/bin/as can't handle multiplications
204             # in $self->{value}
205             $self->{value} =~ s/(?<![\w\$\.])(0x?[0-9a-f]+)/oct($1)/egi;
206             $self->{value} =~ s/([0-9]+\s*[\*\/\%]\s*[0-9]+)/eval($1)/eg;
207             sprintf "\$%s",$self->{value};
208         } else {
209             $self->{value} =~ s/(0b[0-1]+)/oct($1)/eig;
210             $self->{value} =~ s/0x([0-9a-f]+)/0$1h/ig if ($masm);
211             sprintf "%s",$self->{value};
212         }
213     }
214 }
215 { package ea;           # pick up effective addresses: expr(%reg,%reg,scale)
216     sub re {
217         my      $self = shift;  # single instance in enough...
218         local   *line = shift;
219         undef   $ret;
220
221         # optional * ---vvv--- appears in indirect jmp/call
222         if ($line =~ /^(\*?)([^\(,]*)\(([%\w,]+)\)/) {
223             $self->{asterisk} = $1;
224             $self->{label} = $2;
225             ($self->{base},$self->{index},$self->{scale})=split(/,/,$3);
226             $self->{scale} = 1 if (!defined($self->{scale}));
227             $ret = $self;
228             $line = substr($line,@+[0]); $line =~ s/^\s+//;
229
230             if ($win64 && $self->{label} =~ s/\@GOTPCREL//) {
231                 die if (opcode->mnemonic() ne "mov");
232                 opcode->mnemonic("lea");
233             }
234             $self->{base}  =~ s/^%//;
235             $self->{index} =~ s/^%// if (defined($self->{index}));
236         }
237         $ret;
238     }
239     sub size {}
240     sub out {
241         my $self = shift;
242         my $sz = shift;
243
244         $self->{label} =~ s/([_a-z][_a-z0-9]*)/$globals{$1} or $1/gei;
245         $self->{label} =~ s/\.L/$decor/g;
246
247         # Silently convert all EAs to 64-bit. This is required for
248         # elder GNU assembler and results in more compact code,
249         # *but* most importantly AES module depends on this feature!
250         $self->{index} =~ s/^[er](.?[0-9xpi])[d]?$/r\1/;
251         $self->{base}  =~ s/^[er](.?[0-9xpi])[d]?$/r\1/;
252
253         # Solaris /usr/ccs/bin/as can't handle multiplications
254         # in $self->{label}, new gas requires sign extension...
255         use integer;
256         $self->{label} =~ s/(?<![\w\$\.])(0x?[0-9a-f]+)/oct($1)/egi;
257         $self->{label} =~ s/([0-9]+\s*[\*\/\%]\s*[0-9]+)/eval($1)/eg;
258         $self->{label} =~ s/([0-9]+)/$1<<32>>32/eg;
259
260         if ($gas) {
261             $self->{label} =~ s/^___imp_/__imp__/   if ($flavour eq "mingw64");
262
263             if (defined($self->{index})) {
264                 sprintf "%s%s(%s,%%%s,%d)",$self->{asterisk},
265                                         $self->{label},
266                                         $self->{base}?"%$self->{base}":"",
267                                         $self->{index},$self->{scale};
268             } else {
269                 sprintf "%s%s(%%%s)",   $self->{asterisk},$self->{label},$self->{base};
270             }
271         } else {
272             %szmap = (  b=>"BYTE$PTR", w=>"WORD$PTR", l=>"DWORD$PTR",
273                         q=>"QWORD$PTR",o=>"OWORD$PTR",x=>"XMMWORD$PTR" );
274
275             $self->{label} =~ s/\./\$/g;
276             $self->{label} =~ s/(?<![\w\$\.])0x([0-9a-f]+)/0$1h/ig;
277             $self->{label} = "($self->{label})" if ($self->{label} =~ /[\*\+\-\/]/);
278             $sz="q" if ($self->{asterisk} || opcode->mnemonic() eq "movq");
279             $sz="l" if (opcode->mnemonic() eq "movd");
280
281             if (defined($self->{index})) {
282                 sprintf "%s[%s%s*%d%s]",$szmap{$sz},
283                                         $self->{label}?"$self->{label}+":"",
284                                         $self->{index},$self->{scale},
285                                         $self->{base}?"+$self->{base}":"";
286             } elsif ($self->{base} eq "rip") {
287                 sprintf "%s[%s]",$szmap{$sz},$self->{label};
288             } else {
289                 sprintf "%s[%s%s]",$szmap{$sz},
290                                         $self->{label}?"$self->{label}+":"",
291                                         $self->{base};
292             }
293         }
294     }
295 }
296 { package register;     # pick up registers, which start with %.
297     sub re {
298         my      $class = shift; # muliple instances...
299         my      $self = {};
300         local   *line = shift;
301         undef   $ret;
302
303         # optional * ---vvv--- appears in indirect jmp/call
304         if ($line =~ /^(\*?)%(\w+)/) {
305             bless $self,$class;
306             $self->{asterisk} = $1;
307             $self->{value} = $2;
308             $ret = $self;
309             $line = substr($line,@+[0]); $line =~ s/^\s+//;
310         }
311         $ret;
312     }
313     sub size {
314         my      $self = shift;
315         undef   $ret;
316
317         if    ($self->{value} =~ /^r[\d]+b$/i)  { $ret="b"; }
318         elsif ($self->{value} =~ /^r[\d]+w$/i)  { $ret="w"; }
319         elsif ($self->{value} =~ /^r[\d]+d$/i)  { $ret="l"; }
320         elsif ($self->{value} =~ /^r[\w]+$/i)   { $ret="q"; }
321         elsif ($self->{value} =~ /^[a-d][hl]$/i){ $ret="b"; }
322         elsif ($self->{value} =~ /^[\w]{2}l$/i) { $ret="b"; }
323         elsif ($self->{value} =~ /^[\w]{2}$/i)  { $ret="w"; }
324         elsif ($self->{value} =~ /^e[a-z]{2}$/i){ $ret="l"; }
325
326         $ret;
327     }
328     sub out {
329         my $self = shift;
330         if ($gas)       { sprintf "%s%%%s",$self->{asterisk},$self->{value}; }
331         else            { $self->{value}; }
332     }
333 }
334 { package label;        # pick up labels, which end with :
335     sub re {
336         my      $self = shift;  # single instance is enough...
337         local   *line = shift;
338         undef   $ret;
339
340         if ($line =~ /(^[\.\w]+)\:/) {
341             $self->{value} = $1;
342             $ret = $self;
343             $line = substr($line,@+[0]); $line =~ s/^\s+//;
344
345             $self->{value} =~ s/^\.L/$decor/;
346         }
347         $ret;
348     }
349     sub out {
350         my $self = shift;
351
352         if ($gas) {
353             my $func = ($globals{$self->{value}} or $self->{value}) . ":";
354             if ($win64  &&
355                         $current_function->{name} eq $self->{value} &&
356                         $current_function->{abi} eq "svr4") {
357                 $func .= "\n";
358                 $func .= "      movq    %rdi,8(%rsp)\n";
359                 $func .= "      movq    %rsi,16(%rsp)\n";
360                 $func .= "      movq    %rsp,%rax\n";
361                 $func .= "${decor}SEH_begin_$current_function->{name}:\n";
362                 my $narg = $current_function->{narg};
363                 $narg=6 if (!defined($narg));
364                 $func .= "      movq    %rcx,%rdi\n" if ($narg>0);
365                 $func .= "      movq    %rdx,%rsi\n" if ($narg>1);
366                 $func .= "      movq    %r8,%rdx\n"  if ($narg>2);
367                 $func .= "      movq    %r9,%rcx\n"  if ($narg>3);
368                 $func .= "      movq    40(%rsp),%r8\n" if ($narg>4);
369                 $func .= "      movq    48(%rsp),%r9\n" if ($narg>5);
370             }
371             $func;
372         } elsif ($self->{value} ne "$current_function->{name}") {
373             $self->{value} .= ":" if ($masm && $ret!~m/^\$/);
374             $self->{value} . ":";
375         } elsif ($win64 && $current_function->{abi} eq "svr4") {
376             my $func =  "$current_function->{name}" .
377                         ($nasm ? ":" : "\tPROC $current_function->{scope}") .
378                         "\n";
379             $func .= "  mov     QWORD${PTR}[8+rsp],rdi\t;WIN64 prologue\n";
380             $func .= "  mov     QWORD${PTR}[16+rsp],rsi\n";
381             $func .= "  mov     rax,rsp\n";
382             $func .= "${decor}SEH_begin_$current_function->{name}:";
383             $func .= ":" if ($masm);
384             $func .= "\n";
385             my $narg = $current_function->{narg};
386             $narg=6 if (!defined($narg));
387             $func .= "  mov     rdi,rcx\n" if ($narg>0);
388             $func .= "  mov     rsi,rdx\n" if ($narg>1);
389             $func .= "  mov     rdx,r8\n"  if ($narg>2);
390             $func .= "  mov     rcx,r9\n"  if ($narg>3);
391             $func .= "  mov     r8,QWORD${PTR}[40+rsp]\n" if ($narg>4);
392             $func .= "  mov     r9,QWORD${PTR}[48+rsp]\n" if ($narg>5);
393             $func .= "\n";
394         } else {
395            "$current_function->{name}".
396                         ($nasm ? ":" : "\tPROC $current_function->{scope}");
397         }
398     }
399 }
400 { package expr;         # pick up expressioins
401     sub re {
402         my      $self = shift;  # single instance is enough...
403         local   *line = shift;
404         undef   $ret;
405
406         if ($line =~ /(^[^,]+)/) {
407             $self->{value} = $1;
408             $ret = $self;
409             $line = substr($line,@+[0]); $line =~ s/^\s+//;
410
411             $self->{value} =~ s/\@PLT// if (!$elf);
412             $self->{value} =~ s/([_a-z][_a-z0-9]*)/$globals{$1} or $1/gei;
413             $self->{value} =~ s/\.L/$decor/g;
414         }
415         $ret;
416     }
417     sub out {
418         my $self = shift;
419         if ($nasm && opcode->mnemonic()=~m/^j/) {
420             "NEAR ".$self->{value};
421         } else {
422             $self->{value};
423         }
424     }
425 }
426 { package directive;    # pick up directives, which start with .
427     sub re {
428         my      $self = shift;  # single instance is enough...
429         local   *line = shift;
430         undef   $ret;
431         my      $dir;
432         my      %opcode =       # lea 2f-1f(%rip),%dst; 1: nop; 2:
433                 (       "%rax"=>0x01058d48,     "%rcx"=>0x010d8d48,
434                         "%rdx"=>0x01158d48,     "%rbx"=>0x011d8d48,
435                         "%rsp"=>0x01258d48,     "%rbp"=>0x012d8d48,
436                         "%rsi"=>0x01358d48,     "%rdi"=>0x013d8d48,
437                         "%r8" =>0x01058d4c,     "%r9" =>0x010d8d4c,
438                         "%r10"=>0x01158d4c,     "%r11"=>0x011d8d4c,
439                         "%r12"=>0x01258d4c,     "%r13"=>0x012d8d4c,
440                         "%r14"=>0x01358d4c,     "%r15"=>0x013d8d4c      );
441
442         if ($line =~ /^\s*(\.\w+)/) {
443             $dir = $1;
444             $ret = $self;
445             undef $self->{value};
446             $line = substr($line,@+[0]); $line =~ s/^\s+//;
447
448             SWITCH: for ($dir) {
449                 /\.picmeup/ && do { if ($line =~ /(%r[\w]+)/i) {
450                                         $dir="\t.long";
451                                         $line=sprintf "0x%x,0x90000000",$opcode{$1};
452                                     }
453                                     last;
454                                   };
455                 /\.global|\.globl|\.extern/
456                             && do { $globals{$line} = $prefix . $line;
457                                     $line = $globals{$line} if ($prefix);
458                                     last;
459                                   };
460                 /\.type/    && do { ($sym,$type,$narg) = split(',',$line);
461                                     if ($type eq "\@function") {
462                                         undef $current_function;
463                                         $current_function->{name} = $sym;
464                                         $current_function->{abi}  = "svr4";
465                                         $current_function->{narg} = $narg;
466                                         $current_function->{scope} = defined($globals{$sym})?"PUBLIC":"PRIVATE";
467                                     } elsif ($type eq "\@abi-omnipotent") {
468                                         undef $current_function;
469                                         $current_function->{name} = $sym;
470                                         $current_function->{scope} = defined($globals{$sym})?"PUBLIC":"PRIVATE";
471                                     }
472                                     $line =~ s/\@abi\-omnipotent/\@function/;
473                                     $line =~ s/\@function.*/\@function/;
474                                     last;
475                                   };
476                 /\.asciz/   && do { if ($line =~ /^"(.*)"$/) {
477                                         $dir  = ".byte";
478                                         $line = join(",",unpack("C*",$1),0);
479                                     }
480                                     last;
481                                   };
482                 /\.rva|\.long|\.quad/
483                             && do { $line =~ s/([_a-z][_a-z0-9]*)/$globals{$1} or $1/gei;
484                                     $line =~ s/\.L/$decor/g;
485                                     last;
486                                   };
487             }
488
489             if ($gas) {
490                 $self->{value} = $dir . "\t" . $line;
491
492                 if ($dir =~ /\.extern/) {
493                     $self->{value} = ""; # swallow extern
494                 } elsif (!$elf && $dir =~ /\.type/) {
495                     $self->{value} = "";
496                     $self->{value} = ".def\t" . ($globals{$1} or $1) . ";\t" .
497                                 (defined($globals{$1})?".scl 2;":".scl 3;") .
498                                 "\t.type 32;\t.endef"
499                                 if ($win64 && $line =~ /([^,]+),\@function/);
500                 } elsif (!$elf && $dir =~ /\.size/) {
501                     $self->{value} = "";
502                     if (defined($current_function)) {
503                         $self->{value} .= "${decor}SEH_end_$current_function->{name}:"
504                                 if ($win64 && $current_function->{abi} eq "svr4");
505                         undef $current_function;
506                     }
507                 } elsif (!$elf && $dir =~ /\.align/) {
508                     $self->{value} = ".p2align\t" . (log($line)/log(2));
509                 } elsif ($dir eq ".section") {
510                     $current_segment=$line;
511                     if (!$elf && $current_segment eq ".init") {
512                         if      ($flavour eq "macosx")  { $self->{value} = ".mod_init_func"; }
513                         elsif   ($flavour eq "mingw64") { $self->{value} = ".section\t.ctors"; }
514                     }
515                 } elsif ($dir =~ /\.(text|data)/) {
516                     $current_segment=".$1";
517                 } elsif ($dir =~ /\.hidden/) {
518                     if    ($flavour eq "macosx")  { $self->{value} = ".private_extern\t$prefix$line"; }
519                     elsif ($flavour eq "mingw64") { $self->{value} = ""; }
520                 } elsif ($dir =~ /\.comm/) {
521                     $self->{value} = "$dir\t$prefix$line";
522                     $self->{value} =~ s|,([0-9]+),([0-9]+)$|",$1,".log($2)/log(2)|e if ($flavour eq "macosx");
523                 }
524                 $line = "";
525                 return $self;
526             }
527
528             # non-gas case or nasm/masm
529             SWITCH: for ($dir) {
530                 /\.text/    && do { my $v=undef;
531                                     if ($nasm) {
532                                         $v="section     .text code align=64\n";
533                                     } else {
534                                         $v="$current_segment\tENDS\n" if ($current_segment);
535                                         $current_segment = ".text\$";
536                                         $v.="$current_segment\tSEGMENT ";
537                                         $v.=$masm>=$masmref ? "ALIGN(64)" : "PAGE";
538                                         $v.=" 'CODE'";
539                                     }
540                                     $self->{value} = $v;
541                                     last;
542                                   };
543                 /\.data/    && do { my $v=undef;
544                                     if ($nasm) {
545                                         $v="section     .data data align=8\n";
546                                     } else {
547                                         $v="$current_segment\tENDS\n" if ($current_segment);
548                                         $current_segment = "_DATA";
549                                         $v.="$current_segment\tSEGMENT";
550                                     }
551                                     $self->{value} = $v;
552                                     last;
553                                   };
554                 /\.section/ && do { my $v=undef;
555                                     $line =~ s/([^,]*).*/$1/;
556                                     $line = ".CRT\$XCU" if ($line eq ".init");
557                                     if ($nasm) {
558                                         $v="section     $line";
559                                         if ($line=~/\.([px])data/) {
560                                             $v.=" rdata align=";
561                                             $v.=$1 eq "p"? 4 : 8;
562                                         } elsif ($line=~/\.CRT\$/i) {
563                                             $v.=" rdata align=8";
564                                         }
565                                     } else {
566                                         $v="$current_segment\tENDS\n" if ($current_segment);
567                                         $v.="$line\tSEGMENT";
568                                         if ($line=~/\.([px])data/) {
569                                             $v.=" READONLY";
570                                             $v.=" ALIGN(".($1 eq "p" ? 4 : 8).")" if ($masm>=$masmref);
571                                         } elsif ($line=~/\.CRT\$/i) {
572                                             $v.=" READONLY ";
573                                             $v.=$masm>=$masmref ? "ALIGN(8)" : "DWORD";
574                                         }
575                                     }
576                                     $current_segment = $line;
577                                     $self->{value} = $v;
578                                     last;
579                                   };
580                 /\.extern/  && do { $self->{value}  = "EXTERN\t".$line;
581                                     $self->{value} .= ":NEAR" if ($masm);
582                                     last;
583                                   };
584                 /\.globl|.global/
585                             && do { $self->{value}  = $masm?"PUBLIC":"global";
586                                     $self->{value} .= "\t".$line;
587                                     last;
588                                   };
589                 /\.size/    && do { if (defined($current_function)) {
590                                         undef $self->{value};
591                                         if ($current_function->{abi} eq "svr4") {
592                                             $self->{value}="${decor}SEH_end_$current_function->{name}:";
593                                             $self->{value}.=":\n" if($masm);
594                                         }
595                                         $self->{value}.="$current_function->{name}\tENDP" if($masm && $current_function->{name});
596                                         undef $current_function;
597                                     }
598                                     last;
599                                   };
600                 /\.align/   && do { $self->{value} = "ALIGN\t".$line; last; };
601                 /\.(value|long|rva|quad)/
602                             && do { my $sz  = substr($1,0,1);
603                                     my @arr = split(/,\s*/,$line);
604                                     my $last = pop(@arr);
605                                     my $conv = sub  {   my $var=shift;
606                                                         $var=~s/^(0b[0-1]+)/oct($1)/eig;
607                                                         $var=~s/^0x([0-9a-f]+)/0$1h/ig if ($masm);
608                                                         if ($sz eq "D" && ($current_segment=~/.[px]data/ || $dir eq ".rva"))
609                                                         { $var=~s/([_a-z\$\@][_a-z0-9\$\@]*)/$nasm?"$1 wrt ..imagebase":"imagerel $1"/egi; }
610                                                         $var;
611                                                     };  
612
613                                     $sz =~ tr/bvlrq/BWDDQ/;
614                                     $self->{value} = "\tD$sz\t";
615                                     for (@arr) { $self->{value} .= &$conv($_).","; }
616                                     $self->{value} .= &$conv($last);
617                                     last;
618                                   };
619                 /\.byte/    && do { my @str=split(/,\s*/,$line);
620                                     map(s/(0b[0-1]+)/oct($1)/eig,@str);
621                                     map(s/0x([0-9a-f]+)/0$1h/ig,@str) if ($masm);       
622                                     while ($#str>15) {
623                                         $self->{value}.="DB\t"
624                                                 .join(",",@str[0..15])."\n";
625                                         foreach (0..15) { shift @str; }
626                                     }
627                                     $self->{value}.="DB\t"
628                                                 .join(",",@str) if (@str);
629                                     last;
630                                   };
631                 /\.comm/    && do { my @str=split(/,\s*/,$line);
632                                     my $v=undef;
633                                     if ($nasm) {
634                                         $v.="common     $prefix@str[0] @str[1]";
635                                     } else {
636                                         $v="$current_segment\tENDS\n" if ($current_segment);
637                                         $current_segment = "_DATA";
638                                         $v.="$current_segment\tSEGMENT\n";
639                                         $v.="COMM       @str[0]:DWORD:".@str[1]/4;
640                                     }
641                                     $self->{value} = $v;
642                                     last;
643                                   };
644             }
645             $line = "";
646         }
647
648         $ret;
649     }
650     sub out {
651         my $self = shift;
652         $self->{value};
653     }
654 }
655
656 sub rex {
657  local *opcode=shift;
658  my ($dst,$src,$rex)=@_;
659
660    $rex|=0x04 if($dst>=8);
661    $rex|=0x01 if($src>=8);
662    push @opcode,($rex|0x40) if ($rex);
663 }
664
665 # older gas and ml64 don't handle SSE>2 instructions
666 my %regrm = (   "%eax"=>0, "%ecx"=>1, "%edx"=>2, "%ebx"=>3,
667                 "%esp"=>4, "%ebp"=>5, "%esi"=>6, "%edi"=>7      );
668
669 my $movq = sub {        # elderly gas can't handle inter-register movq
670   my $arg = shift;
671   my @opcode=(0x66);
672     if ($arg =~ /%xmm([0-9]+),\s*%r(\w+)/) {
673         my ($src,$dst)=($1,$2);
674         if ($dst !~ /[0-9]+/)   { $dst = $regrm{"%e$dst"}; }
675         rex(\@opcode,$src,$dst,0x8);
676         push @opcode,0x0f,0x7e;
677         push @opcode,0xc0|(($src&7)<<3)|($dst&7);       # ModR/M
678         @opcode;
679     } elsif ($arg =~ /%r(\w+),\s*%xmm([0-9]+)/) {
680         my ($src,$dst)=($2,$1);
681         if ($dst !~ /[0-9]+/)   { $dst = $regrm{"%e$dst"}; }
682         rex(\@opcode,$src,$dst,0x8);
683         push @opcode,0x0f,0x6e;
684         push @opcode,0xc0|(($src&7)<<3)|($dst&7);       # ModR/M
685         @opcode;
686     } else {
687         ();
688     }
689 };
690
691 my $pextrd = sub {
692     if (shift =~ /\$([0-9]+),\s*%xmm([0-9]+),\s*(%\w+)/) {
693       my @opcode=(0x66);
694         $imm=$1;
695         $src=$2;
696         $dst=$3;
697         if ($dst =~ /%r([0-9]+)d/)      { $dst = $1; }
698         elsif ($dst =~ /%e/)            { $dst = $regrm{$dst}; }
699         rex(\@opcode,$src,$dst);
700         push @opcode,0x0f,0x3a,0x16;
701         push @opcode,0xc0|(($src&7)<<3)|($dst&7);       # ModR/M
702         push @opcode,$imm;
703         @opcode;
704     } else {
705         ();
706     }
707 };
708
709 my $pinsrd = sub {
710     if (shift =~ /\$([0-9]+),\s*(%\w+),\s*%xmm([0-9]+)/) {
711       my @opcode=(0x66);
712         $imm=$1;
713         $src=$2;
714         $dst=$3;
715         if ($src =~ /%r([0-9]+)/)       { $src = $1; }
716         elsif ($src =~ /%e/)            { $src = $regrm{$src}; }
717         rex(\@opcode,$dst,$src);
718         push @opcode,0x0f,0x3a,0x22;
719         push @opcode,0xc0|(($dst&7)<<3)|($src&7);       # ModR/M
720         push @opcode,$imm;
721         @opcode;
722     } else {
723         ();
724     }
725 };
726
727 my $pshufb = sub {
728     if (shift =~ /%xmm([0-9]+),\s*%xmm([0-9]+)/) {
729       my @opcode=(0x66);
730         rex(\@opcode,$2,$1);
731         push @opcode,0x0f,0x38,0x00;
732         push @opcode,0xc0|($1&7)|(($2&7)<<3);           # ModR/M
733         @opcode;
734     } else {
735         ();
736     }
737 };
738
739 my $palignr = sub {
740     if (shift =~ /\$([0-9]+),\s*%xmm([0-9]+),\s*%xmm([0-9]+)/) {
741       my @opcode=(0x66);
742         rex(\@opcode,$3,$2);
743         push @opcode,0x0f,0x3a,0x0f;
744         push @opcode,0xc0|($2&7)|(($3&7)<<3);           # ModR/M
745         push @opcode,$1;
746         @opcode;
747     } else {
748         ();
749     }
750 };
751
752 my $pclmulqdq = sub {
753     if (shift =~ /\$([x0-9a-f]+),\s*%xmm([0-9]+),\s*%xmm([0-9]+)/) {
754       my @opcode=(0x66);
755         rex(\@opcode,$3,$2);
756         push @opcode,0x0f,0x3a,0x44;
757         push @opcode,0xc0|($2&7)|(($3&7)<<3);           # ModR/M
758         my $c=$1;
759         push @opcode,$c=~/^0/?oct($c):$c;
760         @opcode;
761     } else {
762         ();
763     }
764 };
765
766 my $rdrand = sub {
767     if (shift =~ /%[er](\w+)/) {
768       my @opcode=();
769       my $dst=$1;
770         if ($dst !~ /[0-9]+/) { $dst = $regrm{"%e$dst"}; }
771         rex(\@opcode,0,$1,8);
772         push @opcode,0x0f,0xc7,0xf0|($dst&7);
773         @opcode;
774     } else {
775         ();
776     }
777 };
778
779 if ($nasm) {
780     print <<___;
781 default rel
782 %define XMMWORD
783 ___
784 } elsif ($masm) {
785     print <<___;
786 OPTION  DOTNAME
787 ___
788 }
789 while($line=<>) {
790
791     chomp($line);
792
793     $line =~ s|[#!].*$||;       # get rid of asm-style comments...
794     $line =~ s|/\*.*\*/||;      # ... and C-style comments...
795     $line =~ s|^\s+||;          # ... and skip white spaces in beginning
796
797     undef $label;
798     undef $opcode;
799     undef @args;
800
801     if ($label=label->re(\$line))       { print $label->out(); }
802
803     if (directive->re(\$line)) {
804         printf "%s",directive->out();
805     } elsif ($opcode=opcode->re(\$line)) {
806         my $asm = eval("\$".$opcode->mnemonic());
807         undef @bytes;
808         
809         if ((ref($asm) eq 'CODE') && scalar(@bytes=&$asm($line))) {
810             print $gas?".byte\t":"DB\t",join(',',@bytes),"\n";
811             next;
812         }
813
814         ARGUMENT: while (1) {
815         my $arg;
816
817         if ($arg=register->re(\$line))  { opcode->size($arg->size()); }
818         elsif ($arg=const->re(\$line))  { }
819         elsif ($arg=ea->re(\$line))     { }
820         elsif ($arg=expr->re(\$line))   { }
821         else                            { last ARGUMENT; }
822
823         push @args,$arg;
824
825         last ARGUMENT if ($line !~ /^,/);
826
827         $line =~ s/^,\s*//;
828         } # ARGUMENT:
829
830         if ($#args>=0) {
831             my $insn;
832             my $sz=opcode->size();
833
834             if ($gas) {
835                 $insn = $opcode->out($#args>=1?$args[$#args]->size():$sz);
836                 @args = map($_->out($sz),@args);
837                 printf "\t%s\t%s",$insn,join(",",@args);
838             } else {
839                 $insn = $opcode->out();
840                 foreach (@args) {
841                     my $arg = $_->out();
842                     # $insn.=$sz compensates for movq, pinsrw, ...
843                     if ($arg =~ /^xmm[0-9]+$/) { $insn.=$sz; $sz="x" if(!$sz); last; }
844                     if ($arg =~ /^mm[0-9]+$/)  { $insn.=$sz; $sz="q" if(!$sz); last; }
845                 }
846                 @args = reverse(@args);
847                 undef $sz if ($nasm && $opcode->mnemonic() eq "lea");
848                 printf "\t%s\t%s",$insn,join(",",map($_->out($sz),@args));
849             }
850         } else {
851             printf "\t%s",$opcode->out();
852         }
853     }
854
855     print $line,"\n";
856 }
857
858 print "\n$current_segment\tENDS\n"      if ($current_segment && $masm);
859 print "END\n"                           if ($masm);
860
861 close STDOUT;
862
863 \f#################################################
864 # Cross-reference x86_64 ABI "card"
865 #
866 #               Unix            Win64
867 # %rax          *               *
868 # %rbx          -               -
869 # %rcx          #4              #1
870 # %rdx          #3              #2
871 # %rsi          #2              -
872 # %rdi          #1              -
873 # %rbp          -               -
874 # %rsp          -               -
875 # %r8           #5              #3
876 # %r9           #6              #4
877 # %r10          *               *
878 # %r11          *               *
879 # %r12          -               -
880 # %r13          -               -
881 # %r14          -               -
882 # %r15          -               -
883
884 # (*)   volatile register
885 # (-)   preserved by callee
886 # (#)   Nth argument, volatile
887 #
888 # In Unix terms top of stack is argument transfer area for arguments
889 # which could not be accomodated in registers. Or in other words 7th
890 # [integer] argument resides at 8(%rsp) upon function entry point.
891 # 128 bytes above %rsp constitute a "red zone" which is not touched
892 # by signal handlers and can be used as temporal storage without
893 # allocating a frame.
894 #
895 # In Win64 terms N*8 bytes on top of stack is argument transfer area,
896 # which belongs to/can be overwritten by callee. N is the number of
897 # arguments passed to callee, *but* not less than 4! This means that
898 # upon function entry point 5th argument resides at 40(%rsp), as well
899 # as that 32 bytes from 8(%rsp) can always be used as temporal
900 # storage [without allocating a frame]. One can actually argue that
901 # one can assume a "red zone" above stack pointer under Win64 as well.
902 # Point is that at apparently no occasion Windows kernel would alter
903 # the area above user stack pointer in true asynchronous manner...
904 #
905 # All the above means that if assembler programmer adheres to Unix
906 # register and stack layout, but disregards the "red zone" existense,
907 # it's possible to use following prologue and epilogue to "gear" from
908 # Unix to Win64 ABI in leaf functions with not more than 6 arguments.
909 #
910 # omnipotent_function:
911 # ifdef WIN64
912 #       movq    %rdi,8(%rsp)
913 #       movq    %rsi,16(%rsp)
914 #       movq    %rcx,%rdi       ; if 1st argument is actually present
915 #       movq    %rdx,%rsi       ; if 2nd argument is actually ...
916 #       movq    %r8,%rdx        ; if 3rd argument is ...
917 #       movq    %r9,%rcx        ; if 4th argument ...
918 #       movq    40(%rsp),%r8    ; if 5th ...
919 #       movq    48(%rsp),%r9    ; if 6th ...
920 # endif
921 #       ...
922 # ifdef WIN64
923 #       movq    8(%rsp),%rdi
924 #       movq    16(%rsp),%rsi
925 # endif
926 #       ret
927 #
928 \f#################################################
929 # Win64 SEH, Structured Exception Handling.
930 #
931 # Unlike on Unix systems(*) lack of Win64 stack unwinding information
932 # has undesired side-effect at run-time: if an exception is raised in
933 # assembler subroutine such as those in question (basically we're
934 # referring to segmentation violations caused by malformed input
935 # parameters), the application is briskly terminated without invoking
936 # any exception handlers, most notably without generating memory dump
937 # or any user notification whatsoever. This poses a problem. It's
938 # possible to address it by registering custom language-specific
939 # handler that would restore processor context to the state at
940 # subroutine entry point and return "exception is not handled, keep
941 # unwinding" code. Writing such handler can be a challenge... But it's
942 # doable, though requires certain coding convention. Consider following
943 # snippet:
944 #
945 # .type function,@function
946 # function:
947 #       movq    %rsp,%rax       # copy rsp to volatile register
948 #       pushq   %r15            # save non-volatile registers
949 #       pushq   %rbx
950 #       pushq   %rbp
951 #       movq    %rsp,%r11
952 #       subq    %rdi,%r11       # prepare [variable] stack frame
953 #       andq    $-64,%r11
954 #       movq    %rax,0(%r11)    # check for exceptions
955 #       movq    %r11,%rsp       # allocate [variable] stack frame
956 #       movq    %rax,0(%rsp)    # save original rsp value
957 # magic_point:
958 #       ...
959 #       movq    0(%rsp),%rcx    # pull original rsp value
960 #       movq    -24(%rcx),%rbp  # restore non-volatile registers
961 #       movq    -16(%rcx),%rbx
962 #       movq    -8(%rcx),%r15
963 #       movq    %rcx,%rsp       # restore original rsp
964 #       ret
965 # .size function,.-function
966 #
967 # The key is that up to magic_point copy of original rsp value remains
968 # in chosen volatile register and no non-volatile register, except for
969 # rsp, is modified. While past magic_point rsp remains constant till
970 # the very end of the function. In this case custom language-specific
971 # exception handler would look like this:
972 #
973 # EXCEPTION_DISPOSITION handler (EXCEPTION_RECORD *rec,ULONG64 frame,
974 #               CONTEXT *context,DISPATCHER_CONTEXT *disp)
975 # {     ULONG64 *rsp = (ULONG64 *)context->Rax;
976 #       if (context->Rip >= magic_point)
977 #       {   rsp = ((ULONG64 **)context->Rsp)[0];
978 #           context->Rbp = rsp[-3];
979 #           context->Rbx = rsp[-2];
980 #           context->R15 = rsp[-1];
981 #       }
982 #       context->Rsp = (ULONG64)rsp;
983 #       context->Rdi = rsp[1];
984 #       context->Rsi = rsp[2];
985 #
986 #       memcpy (disp->ContextRecord,context,sizeof(CONTEXT));
987 #       RtlVirtualUnwind(UNW_FLAG_NHANDLER,disp->ImageBase,
988 #               dips->ControlPc,disp->FunctionEntry,disp->ContextRecord,
989 #               &disp->HandlerData,&disp->EstablisherFrame,NULL);
990 #       return ExceptionContinueSearch;
991 # }
992 #
993 # It's appropriate to implement this handler in assembler, directly in
994 # function's module. In order to do that one has to know members'
995 # offsets in CONTEXT and DISPATCHER_CONTEXT structures and some constant
996 # values. Here they are:
997 #
998 #       CONTEXT.Rax                             120
999 #       CONTEXT.Rcx                             128
1000 #       CONTEXT.Rdx                             136
1001 #       CONTEXT.Rbx                             144
1002 #       CONTEXT.Rsp                             152
1003 #       CONTEXT.Rbp                             160
1004 #       CONTEXT.Rsi                             168
1005 #       CONTEXT.Rdi                             176
1006 #       CONTEXT.R8                              184
1007 #       CONTEXT.R9                              192
1008 #       CONTEXT.R10                             200
1009 #       CONTEXT.R11                             208
1010 #       CONTEXT.R12                             216
1011 #       CONTEXT.R13                             224
1012 #       CONTEXT.R14                             232
1013 #       CONTEXT.R15                             240
1014 #       CONTEXT.Rip                             248
1015 #       CONTEXT.Xmm6                            512
1016 #       sizeof(CONTEXT)                         1232
1017 #       DISPATCHER_CONTEXT.ControlPc            0
1018 #       DISPATCHER_CONTEXT.ImageBase            8
1019 #       DISPATCHER_CONTEXT.FunctionEntry        16
1020 #       DISPATCHER_CONTEXT.EstablisherFrame     24
1021 #       DISPATCHER_CONTEXT.TargetIp             32
1022 #       DISPATCHER_CONTEXT.ContextRecord        40
1023 #       DISPATCHER_CONTEXT.LanguageHandler      48
1024 #       DISPATCHER_CONTEXT.HandlerData          56
1025 #       UNW_FLAG_NHANDLER                       0
1026 #       ExceptionContinueSearch                 1
1027 #
1028 # In order to tie the handler to the function one has to compose
1029 # couple of structures: one for .xdata segment and one for .pdata.
1030 #
1031 # UNWIND_INFO structure for .xdata segment would be
1032 #
1033 # function_unwind_info:
1034 #       .byte   9,0,0,0
1035 #       .rva    handler
1036 #
1037 # This structure designates exception handler for a function with
1038 # zero-length prologue, no stack frame or frame register.
1039 #
1040 # To facilitate composing of .pdata structures, auto-generated "gear"
1041 # prologue copies rsp value to rax and denotes next instruction with
1042 # .LSEH_begin_{function_name} label. This essentially defines the SEH
1043 # styling rule mentioned in the beginning. Position of this label is
1044 # chosen in such manner that possible exceptions raised in the "gear"
1045 # prologue would be accounted to caller and unwound from latter's frame.
1046 # End of function is marked with respective .LSEH_end_{function_name}
1047 # label. To summarize, .pdata segment would contain
1048 #
1049 #       .rva    .LSEH_begin_function
1050 #       .rva    .LSEH_end_function
1051 #       .rva    function_unwind_info
1052 #
1053 # Reference to functon_unwind_info from .xdata segment is the anchor.
1054 # In case you wonder why references are 32-bit .rvas and not 64-bit
1055 # .quads. References put into these two segments are required to be
1056 # *relative* to the base address of the current binary module, a.k.a.
1057 # image base. No Win64 module, be it .exe or .dll, can be larger than
1058 # 2GB and thus such relative references can be and are accommodated in
1059 # 32 bits.
1060 #
1061 # Having reviewed the example function code, one can argue that "movq
1062 # %rsp,%rax" above is redundant. It is not! Keep in mind that on Unix
1063 # rax would contain an undefined value. If this "offends" you, use
1064 # another register and refrain from modifying rax till magic_point is
1065 # reached, i.e. as if it was a non-volatile register. If more registers
1066 # are required prior [variable] frame setup is completed, note that
1067 # nobody says that you can have only one "magic point." You can
1068 # "liberate" non-volatile registers by denoting last stack off-load
1069 # instruction and reflecting it in finer grade unwind logic in handler.
1070 # After all, isn't it why it's called *language-specific* handler...
1071 #
1072 # Attentive reader can notice that exceptions would be mishandled in
1073 # auto-generated "gear" epilogue. Well, exception effectively can't
1074 # occur there, because if memory area used by it was subject to
1075 # segmentation violation, then it would be raised upon call to the
1076 # function (and as already mentioned be accounted to caller, which is
1077 # not a problem). If you're still not comfortable, then define tail
1078 # "magic point" just prior ret instruction and have handler treat it...
1079 #
1080 # (*)   Note that we're talking about run-time, not debug-time. Lack of
1081 #       unwind information makes debugging hard on both Windows and
1082 #       Unix. "Unlike" referes to the fact that on Unix signal handler
1083 #       will always be invoked, core dumped and appropriate exit code
1084 #       returned to parent (for user notification).