2 # Copyright 2005-2016 The OpenSSL Project Authors. All Rights Reserved.
4 # Licensed under the Apache License 2.0 (the "License"). You may not use
5 # this file except in compliance with the License. You can obtain a copy
6 # in the file LICENSE in the source distribution or at
7 # https://www.openssl.org/source/license.html
10 # ====================================================================
11 # Written by Andy Polyakov <appro@openssl.org> for the OpenSSL
12 # project. The module is, however, dual licensed under OpenSSL and
13 # CRYPTOGAMS licenses depending on where you obtain it. For further
14 # details see http://www.openssl.org/~appro/cryptogams/.
15 # ====================================================================
19 # 2.22x RC4 tune-up:-) It should be noted though that my hand [as in
20 # "hand-coded assembler"] doesn't stand for the whole improvement
21 # coefficient. It turned out that eliminating RC4_CHAR from config
22 # line results in ~40% improvement (yes, even for C implementation).
23 # Presumably it has everything to do with AMD cache architecture and
24 # RAW or whatever penalties. Once again! The module *requires* config
25 # line *without* RC4_CHAR! As for coding "secret," I bet on partial
26 # register arithmetics. For example instead of 'inc %r8; and $255,%r8'
27 # I simply 'inc %r8b'. Even though optimization manual discourages
28 # to operate on partial registers, it turned out to be the best bet.
29 # At least for AMD... How IA32E would perform remains to be seen...
33 # As was shown by Marc Bevand reordering of couple of load operations
34 # results in even higher performance gain of 3.3x:-) At least on
35 # Opteron... For reference, 1x in this case is RC4_CHAR C-code
36 # compiled with gcc 3.3.2, which performs at ~54MBps per 1GHz clock.
37 # Latter means that if you want to *estimate* what to expect from
38 # *your* Opteron, then multiply 54 by 3.3 and clock frequency in GHz.
42 # Intel P4 EM64T core was found to run the AMD64 code really slow...
43 # The only way to achieve comparable performance on P4 was to keep
44 # RC4_CHAR. Kind of ironic, huh? As it's apparently impossible to
45 # compose blended code, which would perform even within 30% marginal
46 # on either AMD and Intel platforms, I implement both cases. See
47 # rc4_skey.c for further details...
51 # P4 EM64T core appears to be "allergic" to 64-bit inc/dec. Replacing
52 # those with add/sub results in 50% performance improvement of folded
57 # As was shown by Zou Nanhai loop unrolling can improve Intel EM64T
58 # performance by >30% [unlike P4 32-bit case that is]. But this is
59 # provided that loads are reordered even more aggressively! Both code
60 # paths, AMD64 and EM64T, reorder loads in essentially same manner
61 # as my IA-64 implementation. On Opteron this resulted in modest 5%
62 # improvement [I had to test it], while final Intel P4 performance
63 # achieves respectful 432MBps on 2.8GHz processor now. For reference.
64 # If executed on Xeon, current RC4_CHAR code-path is 2.7x faster than
65 # RC4_INT code-path. While if executed on Opteron, it's only 25%
66 # slower than the RC4_INT one [meaning that if CPU ยต-arch detection
67 # is not implemented, then this final RC4_CHAR code-path should be
68 # preferred, as it provides better *all-round* performance].
72 # Intel Core2 was observed to perform poorly on both code paths:-( It
73 # apparently suffers from some kind of partial register stall, which
74 # occurs in 64-bit mode only [as virtually identical 32-bit loop was
75 # observed to outperform 64-bit one by almost 50%]. Adding two movzb to
76 # cloop1 boosts its performance by 80%! This loop appears to be optimal
77 # fit for Core2 and therefore the code was modified to skip cloop8 on
82 # Intel Westmere was observed to perform suboptimally. Adding yet
83 # another movzb to cloop1 improved performance by almost 50%! Core2
84 # performance is improved too, but nominally...
88 # The only code path that was not modified is P4-specific one. Non-P4
89 # Intel code path optimization is heavily based on submission by Maxim
90 # Perminov, Maxim Locktyukhin and Jim Guilford of Intel. I've used
91 # some of the ideas even in attempt to optimize the original RC4_INT
92 # code path... Current performance in cycles per processed byte (less
93 # is better) and improvement coefficients relative to previous
94 # version of this module are:
100 # Sandy Bridge 4.2/+120%
103 # Ivy Bridge 4.1/+30%
104 # Bulldozer 4.5/+30%(*)
106 # (*) But corresponding loop has less instructions, which should have
107 # positive effect on upcoming Bulldozer, which has one less ALU.
108 # For reference, Intel code runs at 6.8 cpb rate on Opteron.
109 # (**) Note that Core2 result is ~15% lower than corresponding result
110 # for 32-bit code, meaning that it's possible to improve it,
111 # but more than likely at the cost of the others (see rc4-586.pl
112 # to get the idea)...
114 # $output is the last argument if it looks like a file (it has an extension)
115 # $flavour is the first argument if it doesn't look like a file
116 $output = $#ARGV >= 0 && $ARGV[$#ARGV] =~ m|\.\w+$| ? pop : undef;
117 $flavour = $#ARGV >= 0 && $ARGV[0] !~ m|\.| ? shift : undef;
119 $win64=0; $win64=1 if ($flavour =~ /[nm]asm|mingw64/ || $output =~ /\.asm$/);
121 $0 =~ m/(.*[\/\\])[^\/\\]+$/; $dir=$1;
122 ( $xlate="${dir}x86_64-xlate.pl" and -f $xlate ) or
123 ( $xlate="${dir}../../perlasm/x86_64-xlate.pl" and -f $xlate) or
124 die "can't locate x86_64-xlate.pl";
126 open OUT,"| \"$^X\" \"$xlate\" $flavour \"$output\""
127 or die "can't call $xlate: $!";
138 .extern OPENSSL_ia32cap_P
141 .type RC4,\@function,4
159 my $len="%r11"; # reassign input arguments
163 my @XX=("%r10","%rsi");
164 my @TX=("%rax","%rbx");
173 mov -8($dat),$XX[0]#b
177 mov OPENSSL_ia32cap_P(%rip),%r8d
182 movl ($dat,$XX[0],4),$TX[0]#d
185 bt \$30,%r8d # Intel CPU?
193 movl ($dat,$YY,4),$TY#d
194 movl $TX[0]#d,($dat,$YY,4)
195 movl $TY#d,($dat,$XX[0],4)
198 movl ($dat,$TX[0],4),$TY#d
199 movl ($dat,$XX[0],4),$TX[0]#d
201 movb $TY#b,($out,$inp)
211 for ($i=0;$i<8;$i++) {
212 $code.=<<___ if ($i==7);
217 movl ($dat,$YY,4),$TY#d
218 movl $TX[0]#d,($dat,$YY,4)
219 movl `4*($i==7?-1:$i)`($dat,$XX[1],4),$TX[1]#d
220 ror \$8,%r8 # ror is redundant when $i=0
221 movl $TY#d,4*$i($dat,$XX[0],4)
223 movb ($dat,$TY,4),%r8b
225 push(@TX,shift(@TX)); #push(@XX,shift(@XX)); # "rotate" registers
251 movl ($dat,$YY,4),$TY#d
252 movl $TX[0]#d,($dat,$YY,4)
253 movl $TY#d,($dat,$XX[0],4)
256 movl ($dat,$TX[0],4),$TY#d
257 movl ($dat,$XX[0],4),$TX[0]#d
259 movb $TY#b,($out,$inp)
269 lea ($dat,$XX[0],4),$XX[1]
274 my $xmm="%xmm".($j&1);
276 $code.=" add \$16,$XX[0]#b\n" if ($i==15);
277 $code.=" movdqu ($inp),%xmm2\n" if ($i==15);
278 $code.=" add $TX[0]#b,$YY#b\n" if ($i<=0);
279 $code.=" movl ($dat,$YY,4),$TY#d\n";
280 $code.=" pxor %xmm0,%xmm2\n" if ($i==0);
281 $code.=" psllq \$8,%xmm1\n" if ($i==0);
282 $code.=" pxor $xmm,$xmm\n" if ($i<=1);
283 $code.=" movl $TX[0]#d,($dat,$YY,4)\n";
284 $code.=" add $TY#b,$TX[0]#b\n";
285 $code.=" movl `4*($j+1)`($XX[1]),$TX[1]#d\n" if ($i<15);
286 $code.=" movz $TX[0]#b,$TX[0]#d\n";
287 $code.=" movl $TY#d,4*$j($XX[1])\n";
288 $code.=" pxor %xmm1,%xmm2\n" if ($i==0);
289 $code.=" lea ($dat,$XX[0],4),$XX[1]\n" if ($i==15);
290 $code.=" add $TX[1]#b,$YY#b\n" if ($i<15);
291 $code.=" pinsrw \$`($j>>1)&7`,($dat,$TX[0],4),$xmm\n";
292 $code.=" movdqu %xmm2,($out,$inp)\n" if ($i==0);
293 $code.=" lea 16($inp),$inp\n" if ($i==0);
294 $code.=" movl ($XX[1]),$TX[1]#d\n" if ($i==15);
303 for ($i=0;$i<16;$i++) {
304 $code.=".Loop16_enter:\n" if ($i==1);
306 push(@TX,shift(@TX)); # "rotate" registers
310 xor $YY,$YY # keyword to partial register
319 movdqu %xmm2,($out,$inp)
329 movl ($dat,$YY,4),$TY#d
330 movl $TX[0]#d,($dat,$YY,4)
331 movl $TY#d,($dat,$XX[0],4)
334 movl ($dat,$TX[0],4),$TY#d
335 movl ($dat,$XX[0],4),$TX[0]#d
337 movb $TY#b,($out,$inp)
346 movzb ($dat,$XX[0]),$TX[0]#d
355 # unroll 2x4-wise, because 64-bit rotates kill Intel P4...
356 for ($i=0;$i<4;$i++) {
360 movzb ($dat,$YY),$TY#d
361 movzb $XX[1]#b,$XX[1]#d
362 movzb ($dat,$XX[1]),$TX[1]#d
363 movb $TX[0]#b,($dat,$YY)
365 movb $TY#b,($dat,$XX[0])
366 jne .Lcmov$i # Intel cmov is sloooow...
373 push(@TX,shift(@TX)); push(@XX,shift(@XX)); # "rotate" registers
375 for ($i=4;$i<8;$i++) {
379 movzb ($dat,$YY),$TY#d
380 movzb $XX[1]#b,$XX[1]#d
381 movzb ($dat,$XX[1]),$TX[1]#d
382 movb $TX[0]#b,($dat,$YY)
384 movb $TY#b,($dat,$XX[0])
385 jne .Lcmov$i # Intel cmov is sloooow...
392 push(@TX,shift(@TX)); push(@XX,shift(@XX)); # "rotate" registers
412 movzb ($dat,$YY),$TY#d
413 movb $TX[0]#b,($dat,$YY)
414 movb $TY#b,($dat,$XX[0])
418 movzb $XX[0]#b,$XX[0]#d
419 movzb ($dat,$TY),$TY#d
420 movzb ($dat,$XX[0]),$TX[0]#d
432 movl $XX[0]#d,-8($dat)
442 .cfi_adjust_cfa_offset -24
455 .type RC4_set_key,\@function,3
467 mov OPENSSL_ia32cap_P(%rip),$idx#d
468 bt \$20,$idx#d # RC4_CHAR?
474 mov %eax,($dat,%rax,4)
482 mov ($dat,$ido,4),%r10d
483 add ($inp,$len,1),$idx#b
486 mov ($dat,$idx,4),%r11d
488 mov %r10d,($dat,$idx,4)
489 mov %r11d,($dat,$ido,4)
504 mov ($dat,$ido),%r10b
505 add ($inp,$len),$idx#b
508 mov ($dat,$idx),%r11b
512 mov %r10b,($dat,$idx)
513 mov %r11b,($dat,$ido)
524 .size RC4_set_key,.-RC4_set_key
527 .type RC4_options,\@abi-omnipotent
530 lea .Lopts(%rip),%rax
531 mov OPENSSL_ia32cap_P(%rip),%edx
545 .asciz "rc4(8x,char)"
546 .asciz "rc4(16x,int)"
547 .asciz "RC4 for x86_64, CRYPTOGAMS by <appro\@openssl.org>"
549 .size RC4_options,.-RC4_options
552 # EXCEPTION_DISPOSITION handler (EXCEPTION_RECORD *rec,ULONG64 frame,
553 # CONTEXT *context,DISPATCHER_CONTEXT *disp)
561 .extern __imp_RtlVirtualUnwind
562 .type stream_se_handler,\@abi-omnipotent
576 mov 120($context),%rax # pull context->Rax
577 mov 248($context),%rbx # pull context->Rip
579 lea .Lprologue(%rip),%r10
580 cmp %r10,%rbx # context->Rip<prologue label
583 mov 152($context),%rax # pull context->Rsp
585 lea .Lepilogue(%rip),%r10
586 cmp %r10,%rbx # context->Rip>=epilogue label
594 mov %rbx,144($context) # restore context->Rbx
595 mov %r12,216($context) # restore context->R12
596 mov %r13,224($context) # restore context->R13
601 mov %rax,152($context) # restore context->Rsp
602 mov %rsi,168($context) # restore context->Rsi
603 mov %rdi,176($context) # restore context->Rdi
605 jmp .Lcommon_seh_exit
606 .size stream_se_handler,.-stream_se_handler
608 .type key_se_handler,\@abi-omnipotent
622 mov 152($context),%rax # pull context->Rsp
625 mov %rsi,168($context) # restore context->Rsi
626 mov %rdi,176($context) # restore context->Rdi
630 mov 40($disp),%rdi # disp->ContextRecord
631 mov $context,%rsi # context
632 mov \$154,%ecx # sizeof(CONTEXT)
633 .long 0xa548f3fc # cld; rep movsq
636 xor %rcx,%rcx # arg1, UNW_FLAG_NHANDLER
637 mov 8(%rsi),%rdx # arg2, disp->ImageBase
638 mov 0(%rsi),%r8 # arg3, disp->ControlPc
639 mov 16(%rsi),%r9 # arg4, disp->FunctionEntry
640 mov 40(%rsi),%r10 # disp->ContextRecord
641 lea 56(%rsi),%r11 # &disp->HandlerData
642 lea 24(%rsi),%r12 # &disp->EstablisherFrame
643 mov %r10,32(%rsp) # arg5
644 mov %r11,40(%rsp) # arg6
645 mov %r12,48(%rsp) # arg7
646 mov %rcx,56(%rsp) # arg8, (NULL)
647 call *__imp_RtlVirtualUnwind(%rip)
649 mov \$1,%eax # ExceptionContinueSearch
661 .size key_se_handler,.-key_se_handler
669 .rva .LSEH_begin_RC4_set_key
670 .rva .LSEH_end_RC4_set_key
671 .rva .LSEH_info_RC4_set_key
677 .rva stream_se_handler
678 .LSEH_info_RC4_set_key:
686 if ($reg =~ /%r[0-9]+/) { $reg .= $conv; }
687 elsif ($conv eq "b") { $reg =~ s/%[er]([^x]+)x?/%$1l/; }
688 elsif ($conv eq "w") { $reg =~ s/%[er](.+)/%$1/; }
689 elsif ($conv eq "d") { $reg =~ s/%[er](.+)/%e$1/; }
693 $code =~ s/(%[a-z0-9]+)#([bwd])/reg_part($1,$2)/gem;
694 $code =~ s/\`([^\`]*)\`/eval $1/gem;