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