3 # Ascetic x86_64 AT&T to MASM/NASM 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;
24 # Dual-ABI styling rules.
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.:
52 # lea .Label-.(%rax),%rax
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.
63 if ($flavour =~ /\./) { $output = $flavour; undef $flavour; }
65 { my ($stddev,$stdino,@junk)=stat(STDOUT);
66 my ($outdev,$outino,@junk)=stat($output);
68 open STDOUT,">$output" || die "can't open $output: $!"
69 if ($stddev!=$outdev || $stdino!=$outino);
72 my $gas=1; $gas=0 if ($output =~ /\.asm$/);
73 my $elf=1; $elf=0 if (!$gas);
78 my $masmref=8 + 50727*2**-32; # 8.00.50727 shipped with VS2005
85 if ($flavour eq "mingw64") { $gas=1; $elf=0; $win64=1;
86 $prefix=`echo __USER_LABEL_PREFIX__ | $ENV{CC} -E -P -`;
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=""; }
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));
104 my $current_function;
107 { package opcode; # pick up opcodes
109 my $self = shift; # single instance in enough...
113 if ($line =~ /^([a-z][a-z0-9]*)/i) {
116 $line = substr($line,@+[0]); $line =~ s/^\s+//;
119 if ($self->{op} =~ /^(movz)b.*/) { # movz is pain...
122 } elsif ($self->{op} =~ /call|jmp/) {
124 } elsif ($self->{op} =~ /^p/ && $' !~ /^(ush|op)/) { # SSEn
126 } elsif ($self->{op} =~ /([a-z]{3,})([qlwb])$/) {
136 $self->{sz} = $sz if (defined($sz) && !defined($self->{sz}));
142 if ($self->{op} eq "movz") { # movz is pain...
143 sprintf "%s%s%s",$self->{op},$self->{sz},shift;
144 } elsif ($self->{op} =~ /^set/) {
146 } elsif ($self->{op} eq "ret") {
148 if ($win64 && $current_function->{abi} eq "svr4") {
149 $epilogue = "movq 8(%rsp),%rdi\n\t" .
150 "movq 16(%rsp),%rsi\n\t";
152 $epilogue . ".byte 0xf3,0xc3";
153 } elsif ($self->{op} eq "call" && !$elf && $current_segment eq ".init") {
154 ".p2align\t3\n\t.quad";
156 "$self->{op}$self->{sz}";
159 $self->{op} =~ s/^movz/movzx/;
160 if ($self->{op} eq "ret") {
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";
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";
178 $self->{op}=$op if (defined($op));
182 { package const; # pick up constants, which start with $
184 my $self = shift; # single instance in enough...
188 if ($line =~ /^\$([^,]+)/) {
191 $line = substr($line,@+[0]); $line =~ s/^\s+//;
199 # Solaris /usr/ccs/bin/as can't handle multiplications
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};
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};
211 { package ea; # pick up effective addresses: expr(%reg,%reg,scale)
213 my $self = shift; # single instance in enough...
217 # optional * ---vvv--- appears in indirect jmp/call
218 if ($line =~ /^(\*?)([^\(,]*)\(([%\w,]+)\)/) {
219 $self->{asterisk} = $1;
221 ($self->{base},$self->{index},$self->{scale})=split(/,/,$3);
222 $self->{scale} = 1 if (!defined($self->{scale}));
224 $line = substr($line,@+[0]); $line =~ s/^\s+//;
226 if ($win64 && $self->{label} =~ s/\@GOTPCREL//) {
227 die if (opcode->mnemonic() ne "mov");
228 opcode->mnemonic("lea");
230 $self->{base} =~ s/^%//;
231 $self->{index} =~ s/^%// if (defined($self->{index}));
240 $self->{label} =~ s/([_a-z][_a-z0-9]*)/$globals{$1} or $1/gei;
241 $self->{label} =~ s/\.L/$decor/g;
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/;
250 # Solaris /usr/ccs/bin/as can't handle multiplications
251 # in $self->{label}, new gas requires sign extension...
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");
258 if (defined($self->{index})) {
259 sprintf "%s%s(%%%s,%%%s,%d)",$self->{asterisk},
260 $self->{label},$self->{base},
261 $self->{index},$self->{scale};
263 sprintf "%s%s(%%%s)", $self->{asterisk},$self->{label},$self->{base};
266 %szmap = ( b=>"BYTE$PTR", w=>"WORD$PTR", l=>"DWORD$PTR", q=>"QWORD$PTR" );
268 $self->{label} =~ s/\./\$/g;
269 $self->{label} =~ s/(?<![\w\$\.])0x([0-9a-f]+)/0$1h/ig;
270 $self->{label} = "($self->{label})" if ($self->{label} =~ /[\*\+\-\/]/);
271 $sz="q" if ($self->{asterisk});
273 if (defined($self->{index})) {
274 sprintf "%s[%s%s*%d+%s]",$szmap{$sz},
275 $self->{label}?"$self->{label}+":"",
276 $self->{index},$self->{scale},
278 } elsif ($self->{base} eq "rip") {
279 sprintf "%s[%s]",$szmap{$sz},$self->{label};
281 sprintf "%s[%s%s]",$szmap{$sz},
282 $self->{label}?"$self->{label}+":"",
288 { package register; # pick up registers, which start with %.
290 my $class = shift; # muliple instances...
295 # optional * ---vvv--- appears in indirect jmp/call
296 if ($line =~ /^(\*?)%(\w+)/) {
298 $self->{asterisk} = $1;
301 $line = substr($line,@+[0]); $line =~ s/^\s+//;
309 if ($self->{value} =~ /^r[\d]+b$/i) { $ret="b"; }
310 elsif ($self->{value} =~ /^r[\d]+w$/i) { $ret="w"; }
311 elsif ($self->{value} =~ /^r[\d]+d$/i) { $ret="l"; }
312 elsif ($self->{value} =~ /^r[\w]+$/i) { $ret="q"; }
313 elsif ($self->{value} =~ /^[a-d][hl]$/i){ $ret="b"; }
314 elsif ($self->{value} =~ /^[\w]{2}l$/i) { $ret="b"; }
315 elsif ($self->{value} =~ /^[\w]{2}$/i) { $ret="w"; }
316 elsif ($self->{value} =~ /^e[a-z]{2}$/i){ $ret="l"; }
322 if ($gas) { sprintf "%s%%%s",$self->{asterisk},$self->{value}; }
323 else { $self->{value}; }
326 { package label; # pick up labels, which end with :
328 my $self = shift; # single instance is enough...
332 if ($line =~ /(^[\.\w]+)\:/) {
335 $line = substr($line,@+[0]); $line =~ s/^\s+//;
337 $self->{value} =~ s/^\.L/$decor/;
345 my $func = ($globals{$self->{value}} or $self->{value}) . ":";
347 $current_function->{name} eq $self->{value} &&
348 $current_function->{abi} eq "svr4") {
350 $func .= " movq %rdi,8(%rsp)\n";
351 $func .= " movq %rsi,16(%rsp)\n";
352 $func .= " movq %rsp,%rax\n";
353 $func .= "${decor}SEH_begin_$current_function->{name}:\n";
354 my $narg = $current_function->{narg};
355 $narg=6 if (!defined($narg));
356 $func .= " movq %rcx,%rdi\n" if ($narg>0);
357 $func .= " movq %rdx,%rsi\n" if ($narg>1);
358 $func .= " movq %r8,%rdx\n" if ($narg>2);
359 $func .= " movq %r9,%rcx\n" if ($narg>3);
360 $func .= " movq 40(%rsp),%r8\n" if ($narg>4);
361 $func .= " movq 48(%rsp),%r9\n" if ($narg>5);
364 } elsif ($self->{value} ne "$current_function->{name}") {
365 $self->{value} .= ":" if ($masm && $ret!~m/^\$/);
366 $self->{value} . ":";
367 } elsif ($win64 && $current_function->{abi} eq "svr4") {
368 my $func = "$current_function->{name}" .
369 ($nasm ? ":" : "\tPROC $current_function->{scope}") .
371 $func .= " mov QWORD${PTR}[8+rsp],rdi\t;WIN64 prologue\n";
372 $func .= " mov QWORD${PTR}[16+rsp],rsi\n";
373 $func .= " mov rax,rsp\n";
374 $func .= "${decor}SEH_begin_$current_function->{name}:";
375 $func .= ":" if ($masm);
377 my $narg = $current_function->{narg};
378 $narg=6 if (!defined($narg));
379 $func .= " mov rdi,rcx\n" if ($narg>0);
380 $func .= " mov rsi,rdx\n" if ($narg>1);
381 $func .= " mov rdx,r8\n" if ($narg>2);
382 $func .= " mov rcx,r9\n" if ($narg>3);
383 $func .= " mov r8,QWORD${PTR}[40+rsp]\n" if ($narg>4);
384 $func .= " mov r9,QWORD${PTR}[48+rsp]\n" if ($narg>5);
387 "$current_function->{name}".
388 ($nasm ? ":" : "\tPROC $current_function->{scope}");
392 { package expr; # pick up expressioins
394 my $self = shift; # single instance is enough...
398 if ($line =~ /(^[^,]+)/) {
401 $line = substr($line,@+[0]); $line =~ s/^\s+//;
403 $self->{value} =~ s/\@PLT// if (!$elf);
404 $self->{value} =~ s/([_a-z][_a-z0-9]*)/$globals{$1} or $1/gei;
405 $self->{value} =~ s/\.L/$decor/g;
411 if ($nasm && opcode->mnemonic()=~m/^j/) {
412 "NEAR ".$self->{value};
418 { package directive; # pick up directives, which start with .
420 my $self = shift; # single instance is enough...
424 my %opcode = # lea 2f-1f(%rip),%dst; 1: nop; 2:
425 ( "%rax"=>0x01058d48, "%rcx"=>0x010d8d48,
426 "%rdx"=>0x01158d48, "%rbx"=>0x011d8d48,
427 "%rsp"=>0x01258d48, "%rbp"=>0x012d8d48,
428 "%rsi"=>0x01358d48, "%rdi"=>0x013d8d48,
429 "%r8" =>0x01058d4c, "%r9" =>0x010d8d4c,
430 "%r10"=>0x01158d4c, "%r11"=>0x011d8d4c,
431 "%r12"=>0x01258d4c, "%r13"=>0x012d8d4c,
432 "%r14"=>0x01358d4c, "%r15"=>0x013d8d4c );
434 if ($line =~ /^\s*(\.\w+)/) {
437 undef $self->{value};
438 $line = substr($line,@+[0]); $line =~ s/^\s+//;
441 /\.picmeup/ && do { if ($line =~ /(%r[\w]+)/i) {
443 $line=sprintf "0x%x,0x90000000",$opcode{$1};
447 /\.global|\.globl|\.extern/
448 && do { $globals{$line} = $prefix . $line;
449 $line = $globals{$line} if ($prefix);
452 /\.type/ && do { ($sym,$type,$narg) = split(',',$line);
453 if ($type eq "\@function") {
454 undef $current_function;
455 $current_function->{name} = $sym;
456 $current_function->{abi} = "svr4";
457 $current_function->{narg} = $narg;
458 $current_function->{scope} = defined($globals{$sym})?"PUBLIC":"PRIVATE";
459 } elsif ($type eq "\@abi-omnipotent") {
460 undef $current_function;
461 $current_function->{name} = $sym;
462 $current_function->{scope} = defined($globals{$sym})?"PUBLIC":"PRIVATE";
464 $line =~ s/\@abi\-omnipotent/\@function/;
465 $line =~ s/\@function.*/\@function/;
468 /\.asciz/ && do { if ($line =~ /^"(.*)"$/) {
470 $line = join(",",unpack("C*",$1),0);
474 /\.rva|\.long|\.quad/
475 && do { $line =~ s/([_a-z][_a-z0-9]*)/$globals{$1} or $1/gei;
476 $line =~ s/\.L/$decor/g;
482 $self->{value} = $dir . "\t" . $line;
484 if ($dir =~ /\.extern/) {
485 $self->{value} = ""; # swallow extern
486 } elsif (!$elf && $dir =~ /\.type/) {
488 $self->{value} = ".def\t" . ($globals{$1} or $1) . ";\t" .
489 (defined($globals{$1})?".scl 2;":".scl 3;") .
490 "\t.type 32;\t.endef"
491 if ($win64 && $line =~ /([^,]+),\@function/);
492 } elsif (!$elf && $dir =~ /\.size/) {
494 if (defined($current_function)) {
495 $self->{value} .= "${decor}SEH_end_$current_function->{name}:"
496 if ($win64 && $current_function->{abi} eq "svr4");
497 undef $current_function;
499 } elsif (!$elf && $dir =~ /\.align/) {
500 $self->{value} = ".p2align\t" . (log($line)/log(2));
501 } elsif ($dir eq ".section") {
502 $current_segment=$line;
503 if (!$elf && $current_segment eq ".init") {
504 if ($flavour eq "macosx") { $self->{value} = ".mod_init_func"; }
505 elsif ($flavour eq "mingw64") { $self->{value} = ".section\t.ctors"; }
507 } elsif ($dir =~ /\.(text|data)/) {
508 $current_segment=".$1";
514 # non-gas case or nasm/masm
516 /\.text/ && do { my $v=undef;
518 $v="section .text code align=64\n";
520 $v="$current_segment\tENDS\n" if ($current_segment);
521 $current_segment = ".text\$";
522 $v.="$current_segment\tSEGMENT ";
523 $v.=$masm>=$masmref ? "ALIGN(64)" : "PAGE";
529 /\.data/ && do { my $v=undef;
531 $v="section .data data align=8\n";
533 $v="$current_segment\tENDS\n" if ($current_segment);
534 $current_segment = "_DATA";
535 $v.="$current_segment\tSEGMENT";
540 /\.section/ && do { my $v=undef;
541 $line =~ s/([^,]*).*/$1/;
542 $line = ".CRT\$XCU" if ($line eq ".init");
545 if ($line=~/\.([px])data/) {
547 $v.=$1 eq "p"? 4 : 8;
548 } elsif ($line=~/\.CRT\$/i) {
549 $v.=" rdata align=8";
552 $v="$current_segment\tENDS\n" if ($current_segment);
553 $v.="$line\tSEGMENT";
554 if ($line=~/\.([px])data/) {
556 $v.=" ALIGN(".($1 eq "p" ? 4 : 8).")" if ($masm>=$masmref);
557 } elsif ($line=~/\.CRT\$/i) {
558 $v.=" READONLY DWORD";
561 $current_segment = $line;
565 /\.extern/ && do { $self->{value} = "EXTERN\t".$line;
566 $self->{value} .= ":NEAR" if ($masm);
570 && do { $self->{value} = $masm?"PUBLIC":"global";
571 $self->{value} .= "\t".$line;
574 /\.size/ && do { if (defined($current_function)) {
575 undef $self->{value};
576 if ($current_function->{abi} eq "svr4") {
577 $self->{value}="${decor}SEH_end_$current_function->{name}:";
578 $self->{value}.=":\n" if($masm);
580 $self->{value}.="$current_function->{name}\tENDP" if($masm);
581 undef $current_function;
585 /\.align/ && do { $self->{value} = "ALIGN\t".$line; last; };
586 /\.(value|long|rva|quad)/
587 && do { my $sz = substr($1,0,1);
588 my @arr = split(/,\s*/,$line);
589 my $last = pop(@arr);
590 my $conv = sub { my $var=shift;
591 $var=~s/^(0b[0-1]+)/oct($1)/eig;
592 $var=~s/^0x([0-9a-f]+)/0$1h/ig if ($masm);
593 if ($sz eq "D" && ($current_segment=~/.[px]data/ || $dir eq ".rva"))
594 { $var=~s/([_a-z\$\@][_a-z0-9\$\@]*)/$nasm?"$1 wrt ..imagebase":"imagerel $1"/egi; }
598 $sz =~ tr/bvlrq/BWDDQ/;
599 $self->{value} = "\tD$sz\t";
600 for (@arr) { $self->{value} .= &$conv($_).","; }
601 $self->{value} .= &$conv($last);
604 /\.byte/ && do { my @str=split(/,\s*/,$line);
605 map(s/(0b[0-1]+)/oct($1)/eig,@str);
606 map(s/0x([0-9a-f]+)/0$1h/ig,@str) if ($masm);
608 $self->{value}.="DB\t"
609 .join(",",@str[0..15])."\n";
610 foreach (0..15) { shift @str; }
612 $self->{value}.="DB\t"
613 .join(",",@str) if (@str);
641 $line =~ s|[#!].*$||; # get rid of asm-style comments...
642 $line =~ s|/\*.*\*/||; # ... and C-style comments...
643 $line =~ s|^\s+||; # ... and skip white spaces in beginning
650 if ($label=label->re(\$line)) { print $label->out(); }
652 if (directive->re(\$line)) {
653 printf "%s",directive->out();
654 } elsif ($opcode=opcode->re(\$line)) { ARGUMENT: while (1) {
657 if ($arg=register->re(\$line)) { opcode->size($arg->size()); }
658 elsif ($arg=const->re(\$line)) { }
659 elsif ($arg=ea->re(\$line)) { }
660 elsif ($arg=expr->re(\$line)) { }
661 else { last ARGUMENT; }
665 last ARGUMENT if ($line !~ /^,/);
675 $insn = $opcode->out($#args>=1?$args[$#args]->size():$sz);
677 $insn = $opcode->out();
678 $insn .= $sz if (map($_->out() =~ /x?mm/,@args));
679 @args = reverse(@args);
680 undef $sz if ($nasm && $opcode->mnemonic() eq "lea");
682 printf "\t%s\t%s",$insn,join(",",map($_->out($sz),@args));
684 printf "\t%s",$opcode->out();
691 print "\n$current_segment\tENDS\n" if ($current_segment && $masm);
692 print "END\n" if ($masm);
696 \f#################################################
697 # Cross-reference x86_64 ABI "card"
717 # (*) volatile register
718 # (-) preserved by callee
719 # (#) Nth argument, volatile
721 # In Unix terms top of stack is argument transfer area for arguments
722 # which could not be accomodated in registers. Or in other words 7th
723 # [integer] argument resides at 8(%rsp) upon function entry point.
724 # 128 bytes above %rsp constitute a "red zone" which is not touched
725 # by signal handlers and can be used as temporal storage without
726 # allocating a frame.
728 # In Win64 terms N*8 bytes on top of stack is argument transfer area,
729 # which belongs to/can be overwritten by callee. N is the number of
730 # arguments passed to callee, *but* not less than 4! This means that
731 # upon function entry point 5th argument resides at 40(%rsp), as well
732 # as that 32 bytes from 8(%rsp) can always be used as temporal
733 # storage [without allocating a frame]. One can actually argue that
734 # one can assume a "red zone" above stack pointer under Win64 as well.
735 # Point is that at apparently no occasion Windows kernel would alter
736 # the area above user stack pointer in true asynchronous manner...
738 # All the above means that if assembler programmer adheres to Unix
739 # register and stack layout, but disregards the "red zone" existense,
740 # it's possible to use following prologue and epilogue to "gear" from
741 # Unix to Win64 ABI in leaf functions with not more than 6 arguments.
743 # omnipotent_function:
747 # movq %rcx,%rdi ; if 1st argument is actually present
748 # movq %rdx,%rsi ; if 2nd argument is actually ...
749 # movq %r8,%rdx ; if 3rd argument is ...
750 # movq %r9,%rcx ; if 4th argument ...
751 # movq 40(%rsp),%r8 ; if 5th ...
752 # movq 48(%rsp),%r9 ; if 6th ...
761 \f#################################################
762 # Win64 SEH, Structured Exception Handling.
764 # Unlike on Unix systems(*) lack of Win64 stack unwinding information
765 # has undesired side-effect at run-time: if an exception is raised in
766 # assembler subroutine such as those in question (basically we're
767 # referring to segmentation violations caused by malformed input
768 # parameters), the application is briskly terminated without invoking
769 # any exception handlers, most notably without generating memory dump
770 # or any user notification whatsoever. This poses a problem. It's
771 # possible to address it by registering custom language-specific
772 # handler that would restore processor context to the state at
773 # subroutine entry point and return "exception is not handled, keep
774 # unwinding" code. Writing such handler can be a challenge... But it's
775 # doable, though requires certain coding convention. Consider following
778 # .type function,@function
780 # movq %rsp,%rax # copy rsp to volatile register
781 # pushq %r15 # save non-volatile registers
785 # subq %rdi,%r11 # prepare [variable] stack frame
787 # movq %rax,0(%r11) # check for exceptions
788 # movq %r11,%rsp # allocate [variable] stack frame
789 # movq %rax,0(%rsp) # save original rsp value
792 # movq 0(%rsp),%rcx # pull original rsp value
793 # movq -24(%rcx),%rbp # restore non-volatile registers
794 # movq -16(%rcx),%rbx
796 # movq %rcx,%rsp # restore original rsp
798 # .size function,.-function
800 # The key is that up to magic_point copy of original rsp value remains
801 # in chosen volatile register and no non-volatile register, except for
802 # rsp, is modified. While past magic_point rsp remains constant till
803 # the very end of the function. In this case custom language-specific
804 # exception handler would look like this:
806 # EXCEPTION_DISPOSITION handler (EXCEPTION_RECORD *rec,ULONG64 frame,
807 # CONTEXT *context,DISPATCHER_CONTEXT *disp)
808 # { ULONG64 *rsp = (ULONG64 *)context->Rax;
809 # if (context->Rip >= magic_point)
810 # { rsp = ((ULONG64 **)context->Rsp)[0];
811 # context->Rbp = rsp[-3];
812 # context->Rbx = rsp[-2];
813 # context->R15 = rsp[-1];
815 # context->Rsp = (ULONG64)rsp;
816 # context->Rdi = rsp[1];
817 # context->Rsi = rsp[2];
819 # memcpy (disp->ContextRecord,context,sizeof(CONTEXT));
820 # RtlVirtualUnwind(UNW_FLAG_NHANDLER,disp->ImageBase,
821 # dips->ControlPc,disp->FunctionEntry,disp->ContextRecord,
822 # &disp->HandlerData,&disp->EstablisherFrame,NULL);
823 # return ExceptionContinueSearch;
826 # It's appropriate to implement this handler in assembler, directly in
827 # function's module. In order to do that one has to know members'
828 # offsets in CONTEXT and DISPATCHER_CONTEXT structures and some constant
829 # values. Here they are:
849 # sizeof(CONTEXT) 1232
850 # DISPATCHER_CONTEXT.ControlPc 0
851 # DISPATCHER_CONTEXT.ImageBase 8
852 # DISPATCHER_CONTEXT.FunctionEntry 16
853 # DISPATCHER_CONTEXT.EstablisherFrame 24
854 # DISPATCHER_CONTEXT.TargetIp 32
855 # DISPATCHER_CONTEXT.ContextRecord 40
856 # DISPATCHER_CONTEXT.LanguageHandler 48
857 # DISPATCHER_CONTEXT.HandlerData 56
858 # UNW_FLAG_NHANDLER 0
859 # ExceptionContinueSearch 1
861 # In order to tie the handler to the function one has to compose
862 # couple of structures: one for .xdata segment and one for .pdata.
864 # UNWIND_INFO structure for .xdata segment would be
866 # function_unwind_info:
870 # This structure designates exception handler for a function with
871 # zero-length prologue, no stack frame or frame register.
873 # To facilitate composing of .pdata structures, auto-generated "gear"
874 # prologue copies rsp value to rax and denotes next instruction with
875 # .LSEH_begin_{function_name} label. This essentially defines the SEH
876 # styling rule mentioned in the beginning. Position of this label is
877 # chosen in such manner that possible exceptions raised in the "gear"
878 # prologue would be accounted to caller and unwound from latter's frame.
879 # End of function is marked with respective .LSEH_end_{function_name}
880 # label. To summarize, .pdata segment would contain
882 # .rva .LSEH_begin_function
883 # .rva .LSEH_end_function
884 # .rva function_unwind_info
886 # Reference to functon_unwind_info from .xdata segment is the anchor.
887 # In case you wonder why references are 32-bit .rvas and not 64-bit
888 # .quads. References put into these two segments are required to be
889 # *relative* to the base address of the current binary module, a.k.a.
890 # image base. No Win64 module, be it .exe or .dll, can be larger than
891 # 2GB and thus such relative references can be and are accommodated in
894 # Having reviewed the example function code, one can argue that "movq
895 # %rsp,%rax" above is redundant. It is not! Keep in mind that on Unix
896 # rax would contain an undefined value. If this "offends" you, use
897 # another register and refrain from modifying rax till magic_point is
898 # reached, i.e. as if it was a non-volatile register. If more registers
899 # are required prior [variable] frame setup is completed, note that
900 # nobody says that you can have only one "magic point." You can
901 # "liberate" non-volatile registers by denoting last stack off-load
902 # instruction and reflecting it in finer grade unwind logic in handler.
903 # After all, isn't it why it's called *language-specific* handler...
905 # Attentive reader can notice that exceptions would be mishandled in
906 # auto-generated "gear" epilogue. Well, exception effectively can't
907 # occur there, because if memory area used by it was subject to
908 # segmentation violation, then it would be raised upon call to the
909 # function (and as already mentioned be accounted to caller, which is
910 # not a problem). If you're still not comfortable, then define tail
911 # "magic point" just prior ret instruction and have handler treat it...
913 # (*) Note that we're talking about run-time, not debug-time. Lack of
914 # unwind information makes debugging hard on both Windows and
915 # Unix. "Unlike" referes to the fact that on Unix signal handler
916 # will always be invoked, core dumped and appropriate exit code
917 # returned to parent (for user notification).