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