3 # Ascetic x86_64 AT&T to MASM assembler translator by <appro>.
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...
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.
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...
20 # Currently recognized limitations:
22 # - can't use multiple ops per line;
23 # - indirect calls and jumps are not supported;
25 # Dual-ABI styling rules.
27 # 1. Adhere to Unix register and stack layout [see the end for
29 # 2. Forget about "red zone," stick to more traditional blended
30 # stack frame allocation. If volatile storage is actually required
31 # that is. If not, just leave the stack as is.
32 # 3. Functions tagged with ".type name,@function" get crafted with
33 # unified Win64 prologue and epilogue automatically. If you want
34 # to take care of ABI differences yourself, tag functions as
35 # ".type name,@abi-omnipotent" instead.
36 # 4. To optimize the Win64 prologue you can specify number of input
37 # arguments as ".type name,@function,N." Keep in mind that if N is
38 # larger than 6, then you *have to* write "abi-omnipotent" code,
39 # because >6 cases can't be addressed with unified prologue.
40 # 5. Name local labels as .L*, do *not* use dynamic labels such as 1:
41 # (sorry about latter).
42 # 6. Don't use [or hand-code with .byte] "rep ret." "ret" mnemonic is
43 # required to identify the spots, where to inject Win64 epilogue!
44 # But on the pros, it's then prefixed with rep automatically:-)
45 # 7. Due to MASM limitations [and certain general counter-intuitivity
46 # of ip-relative addressing] generation of position-independent
47 # code is assisted by synthetic directive, .picmeup, which puts
48 # address of the *next* instruction into target register.
52 # lea .Label-.(%rax),%rax
57 # lea .Label-.Lpic_point(%rcx),%rbp
61 { my ($stddev,$stdino,@junk)=stat(STDOUT);
62 my ($outdev,$outino,@junk)=stat($output);
64 open STDOUT,">$output" || die "can't open $output: $!"
65 if ($stddev!=$outdev || $stdino!=$outino);
68 my $masm=1 if ($output =~ /\.asm/);
73 { package opcode; # pick up opcodes
75 my $self = shift; # single instance in enough...
79 if ($line =~ /^([a-z][a-z0-9]*)/i) {
82 $line = substr($line,@+[0]); $line =~ s/^\s+//;
85 if ($self->{op} =~ /^(movz)b.*/) { # movz is pain...
88 } elsif ($self->{op} =~ /call/) {
90 } elsif ($self->{op} =~ /([a-z]{3,})([qlwb])$/) {
100 $self->{sz} = $sz if (defined($sz) && !defined($self->{sz}));
106 if ($self->{op} eq "movz") { # movz is pain...
107 sprintf "%s%s%s",$self->{op},$self->{sz},shift;
108 } elsif ($self->{op} =~ /^set/) {
110 } elsif ($self->{op} eq "ret") {
113 "$self->{op}$self->{sz}";
116 $self->{op} =~ s/^movz/movzx/;
117 if ($self->{op} eq "ret") {
119 if ($current_function->{abi} eq "svr4") {
120 $self->{op} = "mov rdi,QWORD PTR 8[rsp]\t;WIN64 epilogue\n\t".
121 "mov rsi,QWORD PTR 16[rsp]\n\t";
123 $self->{op} .= "DB\t0F3h,0C3h\t\t;repret";
129 { package const; # pick up constants, which start with $
131 my $self = shift; # single instance in enough...
135 if ($line =~ /^\$([^,]+)/) {
138 $line = substr($line,@+[0]); $line =~ s/^\s+//;
146 # Solaris /usr/ccs/bin/as can't handle multiplications
148 $self->{value} =~ s/(?<![0-9a-f])(0[x0-9a-f]+)/oct($1)/egi;
149 $self->{value} =~ s/([0-9]+\s*[\*\/\%]\s*[0-9]+)/eval($1)/eg;
150 sprintf "\$%s",$self->{value};
152 $self->{value} =~ s/0x([0-9a-f]+)/0$1h/ig;
153 sprintf "%s",$self->{value};
157 { package ea; # pick up effective addresses: expr(%reg,%reg,scale)
159 my $self = shift; # single instance in enough...
163 if ($line =~ /^([^\(,]*)\(([%\w,]+)\)/) {
165 ($self->{base},$self->{index},$self->{scale})=split(/,/,$2);
166 $self->{scale} = 1 if (!defined($self->{scale}));
168 $line = substr($line,@+[0]); $line =~ s/^\s+//;
170 $self->{base} =~ s/^%//;
171 $self->{index} =~ s/^%// if (defined($self->{index}));
180 # Silently convert all EAs to 64-bit. This is required for
181 # elder GNU assembler and results in more compact code,
182 # *but* most importantly AES module depends on this feature!
183 $self->{index} =~ s/^[er](.?[0-9xpi])[d]?$/r\1/;
184 $self->{base} =~ s/^[er](.?[0-9xpi])[d]?$/r\1/;
187 # Solaris /usr/ccs/bin/as can't handle multiplications
189 $self->{label} =~ s/(?<![0-9a-f])(0[x0-9a-f]+)/oct($1)/egi;
190 $self->{label} =~ s/([0-9]+\s*[\*\/\%]\s*[0-9]+)/eval($1)/eg;
192 if (defined($self->{index})) {
193 sprintf "%s(%%%s,%%%s,%d)",
194 $self->{label},$self->{base},
195 $self->{index},$self->{scale};
197 sprintf "%s(%%%s)", $self->{label},$self->{base};
200 %szmap = ( b=>"BYTE", w=>"WORD", l=>"DWORD", q=>"QWORD" );
202 $self->{label} =~ s/\./\$/g;
203 $self->{label} =~ s/0x([0-9a-f]+)/0$1h/ig;
204 $self->{label} = "($self->{label})" if ($self->{label} =~ /[\*\+\-\/]/);
206 if (defined($self->{index})) {
207 sprintf "%s PTR %s[%s*%d+%s]",$szmap{$sz},
209 $self->{index},$self->{scale},
211 } elsif ($self->{base} eq "rip") {
212 sprintf "%s PTR %s",$szmap{$sz},$self->{label};
214 sprintf "%s PTR %s[%s]",$szmap{$sz},
215 $self->{label},$self->{base};
220 { package register; # pick up registers, which start with %.
222 my $class = shift; # muliple instances...
227 if ($line =~ /^%(\w+)/) {
231 $line = substr($line,@+[0]); $line =~ s/^\s+//;
239 if ($self->{value} =~ /^r[\d]+b$/i) { $ret="b"; }
240 elsif ($self->{value} =~ /^r[\d]+w$/i) { $ret="w"; }
241 elsif ($self->{value} =~ /^r[\d]+d$/i) { $ret="l"; }
242 elsif ($self->{value} =~ /^r[\w]+$/i) { $ret="q"; }
243 elsif ($self->{value} =~ /^[a-d][hl]$/i){ $ret="b"; }
244 elsif ($self->{value} =~ /^[\w]{2}l$/i) { $ret="b"; }
245 elsif ($self->{value} =~ /^[\w]{2}$/i) { $ret="w"; }
246 elsif ($self->{value} =~ /^e[a-z]{2}$/i){ $ret="l"; }
252 sprintf $masm?"%s":"%%%s",$self->{value};
255 { package label; # pick up labels, which end with :
257 my $self = shift; # single instance is enough...
261 if ($line =~ /(^[\.\w]+\:)/) {
264 $line = substr($line,@+[0]); $line =~ s/^\s+//;
266 $self->{value} =~ s/\.L/\$L/ if ($masm);
275 } elsif ($self->{value} ne "$current_function->{name}:") {
277 } elsif ($current_function->{abi} eq "svr4") {
278 my $func = "$current_function->{name} PROC\n".
279 " mov QWORD PTR 8[rsp],rdi\t;WIN64 prologue\n".
280 " mov QWORD PTR 16[rsp],rsi\n";
281 my $narg = $current_function->{narg};
282 $narg=6 if (!defined($narg));
283 $func .= " mov rdi,rcx\n" if ($narg>0);
284 $func .= " mov rsi,rdx\n" if ($narg>1);
285 $func .= " mov rdx,r8\n" if ($narg>2);
286 $func .= " mov rcx,r9\n" if ($narg>3);
287 $func .= " mov r8,QWORD PTR 40[rsp]\n" if ($narg>4);
288 $func .= " mov r9,QWORD PTR 48[rsp]\n" if ($narg>5);
291 "$current_function->{name} PROC";
295 { package expr; # pick up expressioins
297 my $self = shift; # single instance is enough...
301 if ($line =~ /(^[^,]+)/) {
304 $line = substr($line,@+[0]); $line =~ s/^\s+//;
306 $self->{value} =~ s/\.L/\$L/g if ($masm);
315 { package directive; # pick up directives, which start with .
317 my $self = shift; # single instance is enough...
321 my %opcode = # lea 2f-1f(%rip),%dst; 1: nop; 2:
322 ( "%rax"=>0x01058d48, "%rcx"=>0x010d8d48,
323 "%rdx"=>0x01158d48, "%rbx"=>0x011d8d48,
324 "%rsp"=>0x01258d48, "%rbp"=>0x012d8d48,
325 "%rsi"=>0x01358d48, "%rdi"=>0x013d8d48,
326 "%r8" =>0x01058d4c, "%r9" =>0x010d8d4c,
327 "%r10"=>0x01158d4c, "%r11"=>0x011d8d4c,
328 "%r12"=>0x01258d4c, "%r13"=>0x012d8d4c,
329 "%r14"=>0x01358d4c, "%r15"=>0x013d8d4c );
331 if ($line =~ /^\s*(\.\w+)/) {
334 $line =~ s/\@abi\-omnipotent/\@function/;
335 $line =~ s/\@function.*/\@function/;
336 if ($line =~ /\.picmeup\s+(%r[\w]+)/i) {
337 $self->{value} = sprintf "\t.long\t0x%x,0x90000000",$opcode{$1};
338 } elsif ($line =~ /\.asciz\s+"(.*)"$/) {
339 $self->{value} = ".byte\t".join(",",unpack("C*",$1),0);
340 } elsif ($line =~ /\.extern/) {
341 $self->{value} = ""; # swallow extern
343 $self->{value} = $line;
351 undef $self->{value};
352 $line = substr($line,@+[0]); $line =~ s/^\s+//;
356 $v="$current_segment\tENDS\n" if ($current_segment);
357 $current_segment = "_$1\$";
358 $current_segment =~ tr/[a-z]/[A-Z]/;
359 $v.="$current_segment\tSEGMENT ALIGN(64) 'CODE'";
363 /\.extern/ && do { $self->{value} = "EXTRN\t".$line.":BYTE"; last; };
364 /\.globl/ && do { $self->{value} = "PUBLIC\t".$line; last; };
365 /\.type/ && do { ($sym,$type,$narg) = split(',',$line);
366 if ($type eq "\@function") {
367 undef $current_function;
368 $current_function->{name} = $sym;
369 $current_function->{abi} = "svr4";
370 $current_function->{narg} = $narg;
371 } elsif ($type eq "\@abi-omnipotent") {
372 undef $current_function;
373 $current_function->{name} = $sym;
377 /\.size/ && do { if (defined($current_function)) {
378 $self->{value}="$current_function->{name}\tENDP";
379 undef $current_function;
383 /\.align/ && do { $self->{value} = "ALIGN\t".$line; last; };
384 /\.(byte|value|long|quad)/
385 && do { my @arr = split(',',$line);
386 my $sz = substr($1,0,1);
387 my $last = pop(@arr);
389 $sz =~ tr/bvlq/BWDQ/;
390 $self->{value} = "\tD$sz\t";
391 for (@arr) { $self->{value} .= sprintf"0%Xh,",oct; }
392 $self->{value} .= sprintf"0%Xh",oct($last);
395 /\.picmeup/ && do { $self->{value} = sprintf"\tDD\t 0%Xh,090000000h",$opcode{$line};
398 /\.asciz/ && do { if ($line =~ /^"(.*)"$/) {
399 my @str=unpack("C*",$1);
402 $self->{value}.="DB\t"
403 .join(",",@str[0..15])."\n";
404 foreach (0..15) { shift @str; }
406 $self->{value}.="DB\t"
407 .join(",",@str) if (@str);
427 $line =~ s|[#!].*$||; # get rid of asm-style comments...
428 $line =~ s|/\*.*\*/||; # ... and C-style comments...
429 $line =~ s|^\s+||; # ... and skip white spaces in beginning
437 if ($label=label->re(\$line)) { print $label->out(); }
439 if (directive->re(\$line)) {
440 printf "%s",directive->out();
441 } elsif ($opcode=opcode->re(\$line)) { ARGUMENT: {
443 if ($src=register->re(\$line)) { opcode->size($src->size()); }
444 elsif ($src=const->re(\$line)) { }
445 elsif ($src=ea->re(\$line)) { }
446 elsif ($src=expr->re(\$line)) { }
448 last ARGUMENT if ($line !~ /^,/);
450 $line = substr($line,1); $line =~ s/^\s+//;
452 if ($dst=register->re(\$line)) { opcode->size($dst->size()); }
453 elsif ($dst=const->re(\$line)) { }
454 elsif ($dst=ea->re(\$line)) { }
462 printf "\t%s\t%s,%s", $opcode->out($dst->size()),
463 $src->out($sz),$dst->out($sz);
465 printf "\t%s\t%s,%s", $opcode->out(),
466 $dst->out($sz),$src->out($sz);
468 } elsif (defined($src)) {
469 printf "\t%s\t%s",$opcode->out(),$src->out($sz);
471 printf "\t%s",$opcode->out();
478 print "\n$current_segment\tENDS\nEND\n" if ($masm);
482 #################################################
483 # Cross-reference x86_64 ABI "card"
503 # (*) volatile register
504 # (-) preserved by callee
505 # (#) Nth argument, volatile
507 # In Unix terms top of stack is argument transfer area for arguments
508 # which could not be accomodated in registers. Or in other words 7th
509 # [integer] argument resides at 8(%rsp) upon function entry point.
510 # 128 bytes above %rsp constitute a "red zone" which is not touched
511 # by signal handlers and can be used as temporal storage without
512 # allocating a frame.
514 # In Win64 terms N*8 bytes on top of stack is argument transfer area,
515 # which belongs to/can be overwritten by callee. N is the number of
516 # arguments passed to callee, *but* not less than 4! This means that
517 # upon function entry point 5th argument resides at 40(%rsp), as well
518 # as that 32 bytes from 8(%rsp) can always be used as temporal
519 # storage [without allocating a frame]. One can actually argue that
520 # one can assume a "red zone" above stack pointer under Win64 as well.
521 # Point is that at apparently no occasion Windows kernel would alter
522 # the area above user stack pointer in true asynchronous manner...
524 # All the above means that if assembler programmer adheres to Unix
525 # register and stack layout, but disregards the "red zone" existense,
526 # it's possible to use following prologue and epilogue to "gear" from
527 # Unix to Win64 ABI in leaf functions with not more than 6 arguments.
529 # omnipotent_function:
533 # movq %rcx,%rdi ; if 1st argument is actually present
534 # movq %rdx,%rsi ; if 2nd argument is actually ...
535 # movq %r8,%rdx ; if 3rd argument is ...
536 # movq %r9,%rcx ; if 4th argument ...
537 # movq 40(%rsp),%r8 ; if 5th ...
538 # movq 48(%rsp),%r9 ; if 6th ...